Sign in
Secrets

Updates an API key for the project

patch/v1/projects/{ref}/api-keys/{id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • fga_permissions (a scheme the document does not define)

Path parameters

refstring required

Project ref

idstring uuid required

Query parameters

revealboolean

Boolean string, true or false

Request body

namestring
descriptionstring nullable
secret_jwt_templateobject nullable

Response

api_keystring nullable
idstring nullable
type'legacy' | 'publishable' | 'secret' nullable
prefixstring nullable
namestring required
descriptionstring nullable
hashstring nullable
secret_jwt_templateobject nullable
inserted_atstring date-time nullable
updated_atstring date-time nullable

Changes

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