API Keys

1 API call in this section.

API Key Health Check

External & Carrier Integrations / API Keys

GET/external/api-key/{{api_key_plain}}/health

Validates an API key and returns its metadata and enabled modules.

Responses

200 valid; 400 api_key_required; 401 invalid/revoked/expired; 404 not found; 500 internal_server_error.

Path parameters

Parameter	Type	Description
api_key_plainRequired	string	The raw API key. If it starts with 'od_', the prefix is ignored during hashing. The raw API key. If it starts with 'od_', the prefix is ignored during hashing.

Headers

Parameter	Type	Description
X-API-Key	string	Example: {{api_key}}

Staging

Request

curl

1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/external/api-key/${API_KEY_PLAIN}/health" \2  --header "X-API-Key: ${ONDI_TENANT_API_KEY}"

Response examples

200 · Success - Valid400 · Error - API Key Required404 · Error - Not Found401 · Error - Invalid/Revoked/Expired500 · Error - Server Error

200OK

Response body

json

1{2  "success": true,3  "error": null,4  "message": "API key is valid",5  "id": "key-uuid",6  "name": "Integration Key",7  "created_at": "2024-01-01T00:00:00Z",8  "created_by": "user-uuid",9  "expires_at": null,10  "is_active": true,11  "revoked_at": null,12  "modules": [13    "deliveries",14    "zones",15    "pricing"16  ]17}