Skip to main content

Health check

Health check for the API.

Responses
200

Default Response

400

Bad request response.

Schema OPTIONAL
statusCode int32

The status code of the request.

error string

The error string for the status code.

message string

Description of the error encounted.

401

Unauthorized response.

Schema OPTIONAL
statusCode int32

The status code of the request.

error string

The error string for the status code.

message string
403

Forbidden response.

Schema OPTIONAL
statusCode int32

The status code of the request.

error string
message string
404

Not found response.

Schema OPTIONAL
statusCode int32
error string
message string
422

Unprocessable Entity response.

Schema OPTIONAL
statusCode int32
error string
message string

Description of the error encounted.

500

Internal server error response.

Schema OPTIONAL
statusCode int32
error string
message string

Will always be "Internal Server Error"