Revoke an API key

DELETE

/v1/iam/identities/{id}/api-keys/{kid}

const url = 'http://localhost:8080/v1/iam/identities/example/api-keys/example';
const options = {method: 'DELETE'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url http://localhost:8080/v1/iam/identities/example/api-keys/example

Idempotent — revoking an already-revoked key is a no-op (still 200).

Parameters

Path Parameters

required

string

kid

required

string

Responses

200

ApiKey revoked (idempotent).

application/json

object

status

required

string

Allowed value: success

code

required

string

data

required

object

revoked

required

boolean

revokedAt

required

string format: date-time

apiKeyId

required

string

cache

object

hit

required

boolean

key

string

ageSeconds

integer

expiresAt

string format: date-time

timing

object

totalMs

required

integer

dbMs

integer

externalMs

integer

deprecation

object

sunset

required

string format: date-time

successor

string

note

string

Example

{
  "status": "success",
  "data": {
    "revoked": true
  }
}

401

Authentification manquante ou invalide.

application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

403

Scope insuffisant (forbidden, no_active_plan, service_disabled_on_plan).

application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}

404

Ressource introuvable (ou hors-tenant).

application/json

object

status

required

string

Allowed value: error

code

required

string

error

required

object

message

string

requestId

required

string

details

Array<object>

object

path

string

code

string

message

string

key

additional properties

Example

{
  "status": "error"
}