Health check

Static service health check

Responses

• 200
• 429
• 5XX

---

Health Check is OK

application/json

Schema

Example (from schema)

Example

---

Schema

code integer

HTTP response code

message string

Human readable error message

{
  "code": 0,
  "message": "string"
}

{
  "code": 200,
  "message": "OK"
}

The rate limit has been exceeded

Response Headers

• Retry-After integer

  Number of seconds until the client should retry the request

application/json

Schema

Example (from schema)

Example

---

Schema

code integer

HTTP response code

message string

Human readable error message

{
  "code": 0,
  "message": "string"
}

{
  "code": 429,
  "message": "Too many requests"
}

An unexpected server error

application/json

Schema

Example (from schema)

Example

---

Schema

code integer

HTTP response code

message string

Human readable error message

{
  "code": 0,
  "message": "string"
}

{
  "code": 500,
  "message": "Unexpected error"
}

Loading...