Update Api Key

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "workspace_id": "7b9e1f2a-4d3c-4f8a-9a2e-1c2d3e4f5a6b",
    "created_by": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "name": "Production API Key",
    "key_type": "secret",
    "key_prefix": "pk_live_",
    "key_suffix": "9f8e7d6c",
    "scopes": [
      "workflows:read",
      "workflows:run",
      "voices:read"
    ],
    "active": true,
    "last_used_at": "2024-04-20T14:22:00Z",
    "rate_limit_per_min": 120,
    "revoked_at": "2024-05-01T00:00:00Z",
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-04-20T14:22:00Z",
    "preview": "pk_live_9f8e7d6c"
  },
  "meta": {
    "request_id": "req_1234567890abcdef",
    "timestamp": "2024-04-20T14:22:00Z"
  }
}

Update API-key metadata, scopes, rate limit, or active state.

Authentication

AuthorizationBearer

Clerk JWT token

Path parameters

key_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

namestring or nullOptional1-120 characters

scopeslist of enums or nullOptional

rate_limit_per_mininteger or nullOptional

activeboolean or nullOptional

Response

Successful Response

dataobject

metaobject

Errors

422

Unprocessable Entity Error

$	curl -X PATCH https://api.onepin.ai/api/v1/api-keys/key_id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

Authentication

Path parameters

Headers

Request

Response

Errors