Skip to content

StatusAPI.md

Latest commit

 

History

History
38 lines (25 loc) · 1.17 KB

StatusAPI.md

File metadata and controls

38 lines (25 loc) · 1.17 KB
Raw

StatusAPI

All URIs are relative to https://app.corellium.com/api

Method HTTP request Description
StatusAPI_v3Ready GET /v3/ready Check that the API is ready

StatusAPI_v3Ready

// Check that the API is ready
//
// Health check. Returns 204 (no body) when the API is up and accepting requests, and 503 while it is shutting down. Needs no sign-in, so monitoring tools and scripts can call it before doing real work, for example to wait for a deployment to come back after an upgrade.
//
void StatusAPI_v3Ready(apiClient_t *apiClient);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration

Return type

void

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]