AthausDoku

Retrieve an API key

Aufruf, Parameter, Antwort und Fehler von GET /v1/apiKeys/{id}.

Zuletzt aktualisiert:

Returns one key of the office, never its secret. A key of another office, and a key of the other mode, is a 404. Needs read access to apiKeys.

Braucht den Scope read.

In der Konsole ausprobieren

Aufruf

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

Parameter

Pfad

NameTypPflichtBeschreibung
idstring (uuid)jaUUID of the key.

Kopf

NameTypPflichtBeschreibung
Athaus-VersionstringneinOptional 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-None-MatchstringneinAn ETag you hold. If it is still current, the answer is 304 without a body.

Beispiel

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

Antwort

Bei Erfolg kommt 200 mit ApiKey.

ApiKey

FeldTypBeschreibung
objectstringImmer api_key.
idstring (uuid)
namestring | null
prefixstringThe first characters of the key, enough to recognise it. Never the key.
modestringEines von live, test.
scopesstring[]What the key may do: read, propose, approve, and decide where the key may say yes or no to a proposal. Eines von read, propose, approve, decide.
permissionsobjectWhat the key may do per resource: none, read, write.
permissions.listingsstringEines von none, read, write.
permissions.contactsstringEines von none, read, write.
permissions.inquiriesstringEines von none, read, write.
permissions.viewingsstringEines von none, read, write.
permissions.filesstringEines von none, read, write.
permissions.webhookEndpointsstringEines von none, read, write.
permissions.apiKeysstringEines von none, read, write.
permissions.projectsstringEines von 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.

Köpfe der Antwort

KopfBeschreibung
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.
ETagA strong entity tag of this state of the resource. Send it as If-Match to change or delete the resource only if it is unchanged, or as If-None-Match to read it only if it changed.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Mit If-None-Match auf den aktuellen ETag antwortet die Operation 304 ohne Rumpf.

Fehler

Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.

StatusCodesBedeutung
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.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Weiter lesen

Auf dieser Seite