EDistribution API

Verify your API key#

GET/v1/ping

Returns the agent group and key prefix the request authenticated as. Use this as a smoke test before wiring real calls.

Request

cURL
curl -X GET 'https://partner-api.elivaas.com/v1/ping' \
  -u "$ELIVAAS_API_KEY:" \
  -H 'Content-Type: application/json'
Response 200
{}

Responses#

StatusMeaning
200OK
401Missing, malformed, revoked or unknown API key, or an agent group whose distribution access is disabled. Pass the key as the HTTP Basic username with an empty password.
429Rate limit exhausted for this credential. Wait Retry-After seconds before retrying; the budget is per credential, not per IP.

See Errors for the error body shape and which statuses are worth retrying.