Current SMASH health

GET /smash/health

Get health status of the currently active SMASH server.

Query parameters

  • url string

    check this url for health instead of the currently configured one

    Format should match the following pattern: ^https?:\/\/[a-zA-Z0-9-_~.]+(:[0-9]+)?/?$.

Responses

  • 406 application/json

    Not Acceptable

    Hide response attributes Show response attributes object
    • message string Required

      May occur when providing an invalid 'Accept' header.

    • code string Required

      Value is not_acceptable.
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • message string Required

      May occur when a request is not well-formed; that is, it fails to parse successfully. This could be the case when some required parameters are missing or, when malformed values are provided.

    • code string Required

      Value is bad_request.
  • 200 application/json

    Ok

    Hide response attribute Show response attribute object
    • health string Required

      Values are available, unavailable, unreachable, or no_smash_configured.
GET /smash/health 
curl \
 --request GET https://localhost:8090/v2/smash/health
Response examples (406) 
{
  "message": "string",
  "code": "not_acceptable"
}
Response examples (400) 
{
  "message": "string",
  "code": "bad_request"
}
Response examples (200) 
{
  "health": "available"
}