Skip to main content
GET
Ping

Authorizations

Authorization
string
header
required

Your Jenzy API key: Authorization: Bearer jz_live_…

Headers

HERMES-ORG
string<uuid>

The id of one of your Child orgs. The call then acts on that Child org, not on your organization. If you do not send it, the call acts on your organization. An id that is not one of your Child orgs gives 404.

Example:

"3f1c2a9e-8b7d-4e21-9a6f-0c5d4b3e2a10"

Response

Your org, key prefix, and whether the rest of /v2 is serving.

org
string
required
Example:

"Acme Remittances Ltd"

key_prefix
string
required
Example:

"jz_live_AbC123Xy"

status
enum<string>
required

Whether the rest of /v2 is serving. live — open. maintenance / outage — the /v2 shutter is closed and every other /v2 route returns 503 (service_maintenance / service_incident). /v1 has its own shutter and its own GET /v1/ping. The environment is the base URL, not this field.

Available options:
live,
maintenance,
outage
Example:

"live"