Health

Interface Description

Check whether the Developer OpenAPI is available. The response only returns the health state.

Endpoint

Field	Value
Method	GET
Path	/openapi/v2/health
Operation ID	getDeveloperOpenApiHealth
Authentication	Bearer OpenAPI key

Parameters

This operation has no path or query parameters.

Request Body

This operation has no request body.

Request Example

curl -X GET "https://openapi.example.com/openapi/v2/health" \
  -H "Authorization: Bearer <openapi-key>"

Successful Responses

200

Current Developer OpenAPI health state.

Field	Required	Type	Description
status	Yes	"ok"	Current Developer OpenAPI health state.

Success Response Example

{
  "status": "ok"
}

Error Codes

The table below lists every error response documented for this operation.

HTTP Status	Error Code	Explanation
401	UNAUTHORIZED	The Bearer API key is missing, malformed, unknown, revoked, or deleted.
429	RATE_LIMITED	The request exceeded the configured rate limits.
500	INTERNAL_ERROR	The API encountered an internal error.
503	DATABASE_REPOSITORY_UNAVAILABLE	The data required by this operation is temporarily unavailable.

Next Steps

• Version