delete/v2/keys/{prefix}

Revoke an API key

Operation: revokeKey
Authentication: API key

Revocation is durable and the record is kept, so a partner debugging a broken integration is told the key was revoked rather than that it never existed.

Request

Parameters

prefixpathrequiredstring

Responses

204Revoked.

400The request body or query failed validation.

errorobjectrequired

401No key, an unknown key, a revoked key, or a key whose tenant is not active. All four return an identical body on purpose: distinguishing them would let a caller discover which partners we have.

errorobjectrequired

403The key is valid but lacks the scope, or it asked for a scope it does not itself hold.

errorobjectrequired

404Not found, or not yours. A resource belonging to another tenant answers 404 rather than 403, because 403 would confirm the record exists.

errorobjectrequired

409That key is already revoked.

errorobjectrequired

Example

curl

curl -X DELETE https://api.haavisa.com/v2/keys/<prefix> \
  -H "Authorization: Bearer $HAAVISA_API_KEY"

More in Partner

Something unclear? The eligibility guide explains the model behind the answers; the errors guide covers the envelope.