REST API - Secrets#

Encrypted project secrets. Values are masked in lists.

EndpointMethodDescription
/projects/{id}/secretsGETList secrets (masked)
/projects/{id}/secretsPOSTCreate a secret
/projects/{id}/secrets/{secretID}/valueGETReveal a value
/projects/{id}/secrets/{secretID}PATCHUpdate value/description
/projects/{id}/secrets/{secretID}DELETEDelete a secret

Create:

{
  "key": "API_SECRET",
  "value": "s3cr3t",
  "description": "shared with the billing service"
}
JSON

Reveal:

GET /projects/{id}/secrets/{secretID}/value
Text
{ "id": "uuid", "key": "API_SECRET", "value": "s3cr3t" }
JSON

Security#

  • Accepts the project API key (or a project-user session)
  • Scoped keys: secrets:read, secrets:write