Sign in
API Key

Revoke API key

Revokes the specified API key. An API key that is no longer needed can be revoked. This action cannot be reversed. API keys can also be managed in the Neon Console. See Manage API keys.

delete/api_keys/{key_id}

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/api_keys/{key_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Path parameters

key_idinteger required

The API key ID

Response

Revoked the specified API key

idinteger required

The API key's unique numeric ID. Distinct from the API key token (key).

namestring required

The user-specified API key name

created_atstring date-time required

A timestamp indicating when the API key was created

created_bystring uuid required

ID of the user who created this API key

last_used_atstring date-time nullable

A timestamp indicating when the API was last used

last_used_from_addrstring required

The IP address from which the API key was last used

revokedboolean required

A true or false value indicating whether the API key is revoked

Changes

No recorded changes to this operation across all 15 revisions of this API.