API Keys

Update Organization Api Key

Update an API key's title, description, and/or per-scope claims.

An empty body is rejected with 422.

patch/v1/api-keys/{api_key_id}/

Request

Base URL
https://logfire-api.pydantic.dev/api
Auth
OAuth 2
Authorization codeapi/oauth/authorize
Token URL/api/oauth/token
Scopesorganization:write_api_key
TypeScript
https://skmtc.dev/pydantic/apis/pydantic-logfire-api/docs/v1/api-keys/:api_key_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

api_key_idstring uuid required

namestring

descriptionstring nullable

Successful Response

idstring uuid required

organization_idstring uuid required

namestring required

descriptionstring nullable required

scopesOAuthScopeId[] required

project_idstring uuid nullable required

project_namestring nullable required

all_projectsboolean required

created_bystring uuid nullable required

created_by_namestring nullable required

created_atstring date-time required

last_used_atstring date-time nullable required

expires_atstring date-time nullable required

user_idstring uuid nullable required

activeboolean required

updated_atstring date-time nullable required

updated_bystring uuid nullable required

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