Sign in
API Keys

put/api-keys/{id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/api-keys/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

API key ID

Request body

expires_atstring date-time nullable
is_activeboolean nullable
namestring nullable
permissionsstring[] nullable

Example request

{
  "expires_at": "2024-12-31T23:59:59Z",
  "permissions": [
    "projects:read",
    "deployments:read"
  ]
}

Response

API key updated successfully

created_atstring date-time required
expires_atstring date-time nullable
idinteger required
is_activeboolean required
key_prefixstring required
last_used_atstring date-time nullable
namestring required
permissionsstring[] nullable
role_typestring required

Example response

{
  "created_at": "2024-01-01T00:00:00Z",
  "expires_at": "2024-12-31T23:59:59Z",
  "last_used_at": "2024-01-01T00:00:00Z"
}

Changes

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