API Keys

Revoke an API key

Immediately and permanently revokes the key. Any request using it will start failing at once. This cannot be undone.

delete/v1/api-keys/{id}

Request

  • Base URL: https://api.signvoy.com
  • URL: https://api.signvoy.com/v1/api-keys/{id}
  • Auth: one of:
    • API key in header X-Workspace-Id
    • HTTP bearer

Path parameters

idstring uuid required

API key ID

Response

The revoked key

idstring uuid required

Unique API key identifier

namestring required

Human-readable label

prefixstring required

Non-secret leading segment of the key

last4string required

Last 4 characters of the key

lastUsedAtstring date-time nullable

When the key was last used to authenticate a request

expiresAtstring date-time nullable

When the key expires (null = never)

revokedboolean required

Whether the key has been revoked

createdAtstring date-time required

Creation timestamp

Example response

{
  "prefix": "sk_live_x7Kf9aB2",
  "last4": "a1b2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.