v1

latestOpenAPI 3.0.02026-07-14169146300.3 KB
Secrets

Updates an API key for the project

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

Path parameters

refstring required
Example:abcdefghijklmnopqrst

Project ref

idstring uuid required
Example:22222222-2222-4222-8222-222222222222

Query parameters

revealboolean
Example:true

Boolean string, true or false

Request body

namestring
descriptionstring nullable
secret_jwt_templateobject nullable

Example request

{
  "name": "ci_secret_key_rotated",
  "description": "Rotated after March release"
}

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