Utilities (1.0)

Download OpenAPI specification:Download

Utility and miscellaneous APIs.

Authentication

XCompleatApiKey

Security Scheme Type API Key
Header parameter name: x-api-compleat-key

Utility

Heartbeat

Returns an HTTP 200 with a structured response if the system is running. Any other response shows that the environment in question is not available. Note that no authentication or authorization is required for this call.

Authorizations:
header Parameters
x-api-version
required
integer
Value: 1
Example: 1

Indicates the version of this API to be used.

x-api-compleat-key
required
string <guid>
Example: d025eedc-5ea0-4de8-be9f-f8873545add9

The header containing compleat api key.

Responses

200

Successful response.

500

An internal error has occurred.

get/api/utility/heartbeat
/api/utility/heartbeat

Response samples

Content type
application/json
Copy
Expand all Collapse all
{}