Revoke API key

DELETE 
/v2/organizations/:orgId/api-keys/:keyId

Revoke an API key for an organization. The key stops working as soon as the call returns, and the action can't be undone.

Request

Path Parameters

orgId stringrequired

Organization ID

keyId stringrequired

API Key ID (not the full key, but the keyId)

Responses

200

API key revoked successfully

application/json

Schema

Schema

success booleanrequired

Whether the deletion was successful

message stringrequired

Status message

Example (from schema)

{
  "success": true,
  "message": "string"
}

401

Unauthorized

application/json

Schema

Schema

message stringrequired
statusCode numberrequired
error string

Available only when the message includes additional error details.

Example (from schema)

{
  "message": "string",
  "statusCode": 0,
  "error": "string"
}

403

Forbidden

application/json

Schema

Schema

message stringrequired
statusCode numberrequired
error string

Available only when the message includes additional error details.

Example (from schema)

{
  "message": "string",
  "statusCode": 0,
  "error": "string"
}

404

Organization or API key not found

application/json

Schema

Schema

message stringrequired
statusCode numberrequired
error string

Available only when the message includes additional error details.

Example (from schema)

{
  "message": "string",
  "statusCode": 0,
  "error": "string"
}

429

Too Many Requests

application/json

Schema

Schema

message stringrequired
statusCode numberrequired
error string

Available only when the message includes additional error details.

Example (from schema)

{
  "message": "string",
  "statusCode": 0,
  "error": "string"
}

500

Internal Server Error

application/json

Schema

Schema

message stringrequired
statusCode numberrequired
error string

Available only when the message includes additional error details.

Example (from schema)

{
  "message": "string",
  "statusCode": 0,
  "error": "string"
}

Loading...