api-keys

DELETE /v1/api-keys/{apiKeyId}

Revoke an API key.

Alle api-keys-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie apikeys.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X DELETE https://api.zinndigital.com/v1/api-keys/{apiKeyId} \
  -H "Authorization: Bearer zdk_live_…"

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

Revokes the key — it stops authenticating immediately and drops out of the list. The revocation is recorded in the audit log. Requires `apikeys.manage`.

Parameters

NaamTypeVerplichtWat dit is
apiKeyId (path)UuidJaThe API key's id.

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 409