Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Accesskey

Update an accesskey

put/accesskeys/{id}

Path parameters

idstring required

ID of the accesskey

Request body

namestring
detailstring

Response

Accesskey updated successfully

idstring uuid

The unique identifier of the access key.

customer_idstring uuid

The unique identifier of the customer. Returned from the GET /customers response.

namestring

Name of the access key.

detailstring

Additional details about the access key.

tokenstring

The access key token. Only returned once at creation time via POST /accesskeys. Subsequent GET requests will not include this field. Store it securely immediately after creation.

token_prefixstring

A short prefix of the access key token for identification purposes. Always returned in GET responses.

tm_expirestring date-time

Timestamp when the access key expires.

tm_createstring date-time

Timestamp when the access key was created.

tm_updatestring date-time

Timestamp when the access key was last updated.

tm_deletestring date-time

Timestamp when the access key was deleted.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "name": "Production API Key",
  "detail": "API key for production environment",
  "token": "vb_a3Bf9xKmPq2nR7sT4wYzLp8mN5qR1xWe",
  "token_prefix": "vb_a3Bf9xKm",
  "tm_expire": "2027-01-15T09:30:00.000000Z",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}