API Keys

Create an API key

Creates a new secret API key scoped to this workspace. The plaintext key is returned once in this response and cannot be retrieved again — store it securely.

post/v1/api-keys

Request

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

Request body

namestring required

Human-readable label to identify this key in the dashboard

expiresInDaysnumber

Optional expiry, in days from now. Omit for a key that never expires.

Example request

{
  "name": "Production server",
  "expiresInDays": 90
}

Response

Key created (includes the plaintext secret, shown once)

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

keystring required

The full secret key. Shown only once, at creation — store it securely. Use it as a Bearer token: Authorization: Bearer sk_live_...

Example response

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

Changes

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