Revoke an API key

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

Revokes an API key. This action cannot be undone. The key will immediately stop working.

Request

Path Parameters

orgId stringrequired
Organization ID
Example: 507f1f77bcf86cd799439011
keyId stringrequired
API Key ID (not the full key, but the keyId)
Example: key_Abc123XyZ789

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...