AthausDocs

Revoke an API key

Request, parameters, response and errors of DELETE /v1/apiKeys/{id}.

Last updated:

Revokes the key: its next call answers 401 and nothing brings it back. The key may be the calling key. The office history shows it like a revocation in the app, with the calling key (name and id) as the actor. Revoking a key that is already revoked changes nothing and answers the same. Limited to 5 in a burst and then one every 20 seconds per key, like the app. Needs write access to apiKeys; only a key that the management of the office created can have it.

Requires the scope propose.

Request

DELETE https://api.athaus.ai/v1/apiKeys/{id}

Parameters

Path

NameTypeRequiredDescription
idstring (uuid)yesUUID of the key.

Header

NameTypeRequiredDescription
Athaus-VersionstringnoOptional and carries nothing a client needs: the version is the path. Accepted when it says v1 or 1. Any other value is a 400 api_version_unsupported.
If-MatchstringnoOnly if the current ETag of the resource is listed (or *: only if the resource exists). Otherwise 412 and nothing is written.

Example

curl -X DELETE "https://api.athaus.ai/v1/apiKeys/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17" \
  -H "Authorization: Bearer ath_live_..."

Response

On success the status is 200 with ApiKey.

ApiKey

FieldTypeDescription
objectstringAlways api_key.
idstring (uuid)
namestring | null
prefixstringThe first characters of the key, enough to recognise it. Never the key.
modestringOne of live, test.
scopesstring[]What the key may do: read, propose, approve, and decide where the key may say yes or no to a proposal. One of read, propose, approve, decide.
permissionsobjectWhat the key may do per resource: none, read, write.
permissions.listingsstringOne of none, read, write.
permissions.contactsstringOne of none, read, write.
permissions.inquiriesstringOne of none, read, write.
permissions.viewingsstringOne of none, read, write.
permissions.filesstringOne of none, read, write.
permissions.webhookEndpointsstringOne of none, read, write.
permissions.apiKeysstringOne of none, read, write.
permissions.projectsstringOne of none, read, write.
currentbooleantrue for the key that made this request.
createdAtstring (date-time)
lastUsedAtstring (date-time) | nullAt most hourly exact. Null if it was never used.
revokedAtstring (date-time) | nullWhen the key was revoked. A revoked key answers 401 and stays listed for a year. Null while it works.

Response headers

HeaderDescription
Request-IdIdentifies this request. Quote it in a support request.
Athaus-VersionThe API version of this response: v1.
Athaus-ReleaseThe release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Errors

Every error arrives as problem details. Branch on code, not on title or detail.

StatusCodesMeaning
400invalid_id, api_version_unsupported, invalid_inputInvalid request.
401unauthorizedMissing or invalid API key.
403insufficient_permissions, plan_requiredThe key lacks a right, or the plan does not include API access.
404not_foundNothing under this ID.
409The request conflicts with the state of the resource (for example a duplicate), or with an idempotency key.
412precondition_failedThe condition of If-Match (or If-None-Match) does not hold for the current state of the resource. Nothing was written.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Keep reading

On this page