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.
Aufruf
GET https://api.athaus.ai/v1/apiKeys/{id}Parameter
Pfad
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string (uuid) | ja | UUID of the key. |
Kopf
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
Athaus-Version | string | nein | Optional 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-Match | string | nein | An 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
| Feld | Typ | Beschreibung |
|---|---|---|
object | string | Immer api_key. |
id | string (uuid) | |
name | string | null | |
prefix | string | The first characters of the key, enough to recognise it. Never the key. |
mode | string | Eines von live, test. |
scopes | string[] | 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. |
permissions | object | What the key may do per resource: none, read, write. |
permissions.listings | string | Eines von none, read, write. |
permissions.contacts | string | Eines von none, read, write. |
permissions.inquiries | string | Eines von none, read, write. |
permissions.viewings | string | Eines von none, read, write. |
permissions.files | string | Eines von none, read, write. |
permissions.webhookEndpoints | string | Eines von none, read, write. |
permissions.apiKeys | string | Eines von none, read, write. |
permissions.projects | string | Eines von none, read, write. |
current | boolean | true for the key that made this request. |
createdAt | string (date-time) | |
lastUsedAt | string (date-time) | null | At most hourly exact. Null if it was never used. |
revokedAt | string (date-time) | null | When the key was revoked. A revoked key answers 401 and stays listed for a year. Null while it works. |
Köpfe der Antwort
| Kopf | Beschreibung |
|---|---|
Request-Id | Identifies this request. Quote it in a support request. |
Athaus-Version | The API version of this response: v1. |
Athaus-Release | The release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it. |
ETag | A 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-Policy | The quota policy of the bucket that applies. |
RateLimit | Remaining 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.
| Status | Codes | Bedeutung |
|---|---|---|
400 | invalid_id, api_version_unsupported, invalid_input | Invalid request. |
401 | unauthorized | Missing or invalid API key. |
403 | insufficient_permissions, plan_required | The key lacks a right, or the plan does not include API access. |
404 | not_found | Nothing under this ID. |
429 | rate_limited | Rate limit exceeded. |
500 | internal_error | Server error. |
Weiter lesen
REST-API: Anmeldung mit einem API-Key
Jeder Aufruf von /v1 trägt einen API-Key als Bearer-Token. Wo du ihn bekommst, welche Scopes er trägt und was nicht geht.
REST-API: Fehler als Problem Details
Jeder Fehler von /v1 ist ein Problem nach RFC 9457 mit echtem HTTP-Status, einem Code zum Verzweigen und einer Request-Id für den Support.