1. API Reference
  2. API Keys
  3. Delete an API key
Website
  • API overview
  • API quickstart
  • Authentication
  • Project scoping
  • Requests and responses
  • Pagination and filtering
  • Errors
  • GETList supported database engines
  • POSTList projects
  • POSTCreate a project
  • GETGet a project
  • DELETEDelete a project
  • PATCHUpdate a project
  • POSTCreate a source
  • POSTList sources
  • GETGet source details
  • DELETEDelete a source
  • PATCHUpdate a source
  • POSTCreate secret metadata
  • POSTList secret metadata
  • GETGet secret metadata
  • DELETEDelete secret metadata
  • PATCHUpdate secret metadata
  • POSTCreate a schedule
  • POSTList schedules
  • POSTSummarize schedule statuses
  • GETGet a schedule
  • DELETEDelete a schedule
  • PATCHUpdate a schedule
  • DELETERemove a schedule gate
  • POSTActivate or pause a schedule
  • POSTQueue a manual check
  • POSTCreate an immutable report
  • POSTList reports
  • GETGet report details
  • DELETEDelete a report
  • POSTDownload a report
  • POSTGet the API-key scope catalog
  • POSTCreate an API key
  • POSTList API-key metadata
  • GETGet API-key metadata
  • DELETEDelete an API key
  • PATCHUpdate API-key metadata
  • POSTCreate a notification channel
  • POSTList notification channels
  • POSTResolve notification channels by ID
  • GETGet notification channel details
  • DELETEDelete a notification channel
  • PATCHUpdate a notification channel
  • POSTSend a test notification
  • POSTCreate a project worker
  • POSTList project workers
  • GETGet worker details
  • DELETEDelete a worker
  • PATCHUpdate a worker
  • POSTRead live worker agent logs
  • POSTList checks
  • POSTSummarize check statuses
  • GETGet check details
  • POSTGet check log sections
  • POSTDownload a check log
  • POSTDownload check audit evidence
  • POSTList notification messages
  • GETGet notification message details
DELETE/api-keys/{id}

Delete an API key

Permanently invalidates and removes an API key from its project.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Parameters

Values are applied to the request and the example on the right.

idpath · stringrequired

Resource ID.

Responses

200application/json

API key deleted.

{
  "status": "success",
  "data": {
    "deleted": true,
    "id": "65f0c7a9a7d6b4e2c1234567"
  }
}
400application/json

The request body, parameter, filter, cursor, or project-scoping pattern is invalid.

{
  "status": "error",
  "message": "string",
  "code": "string",
  "detail": {},
  "quota": {
    "key": "string",
    "limit": 1,
    "used": 1
  },
  "feature": "string",
  "dependency": "string"
}
statusstringrequired
messagestringrequired
codestringoptional

Stable machine-readable code when the error defines one.

detailobjectoptional
quotaoptional
featurestringoptional
dependencystringoptional
401application/json

Authentication is missing or the credential is invalid, inactive, expired, or lacks the required scope.

{
  "status": "error",
  "message": "string",
  "code": "string",
  "detail": {},
  "quota": {
    "key": "string",
    "limit": 1,
    "used": 1
  },
  "feature": "string",
  "dependency": "string"
}
statusstringrequired
messagestringrequired
codestringoptional

Stable machine-readable code when the error defines one.

detailobjectoptional
quotaoptional
featurestringoptional
dependencystringoptional
404application/json

The resource was not found or is outside the caller's project.

{
  "status": "error",
  "message": "string",
  "code": "string",
  "detail": {},
  "quota": {
    "key": "string",
    "limit": 1,
    "used": 1
  },
  "feature": "string",
  "dependency": "string"
}
statusstringrequired
messagestringrequired
codestringoptional

Stable machine-readable code when the error defines one.

detailobjectoptional
quotaoptional
featurestringoptional
dependencystringoptional
Get API-key metadata< PreviousUpdate API-key metadataNext >

Powered by heyo

curl --request DELETE \  '/v1/api-keys/65f0c7a9a7d6b4e2c1234567'
{  "status": "success",  "data": {    "deleted": true,    "id": "65f0c7a9a7d6b4e2c1234567"  }}