v1

latestOpenAPI 3.0.02026-07-14169146300.3 KB
Secrets

Creates a new API key for the project

post/v1/projects/{ref}/api-keys

Path parameters

refstring required
Example:abcdefghijklmnopqrst

Project ref

Query parameters

revealboolean
Example:true

Boolean string, true or false

Request body

type'publishable' | 'secret' required
namestring required
descriptionstring nullable
secret_jwt_templateobject nullable

Example request

{
  "type": "secret",
  "name": "ci_secret_key",
  "description": "CI deploy key"
}

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