Secrets
View as MarkdownManage environment secrets per variant. Values are never returned.
Authorization
bearerAuth AuthorizationBearer <token>
Personal Access Token (PAT). Generate one at the developer portal. Pass as: Authorization: Bearer . Each operation requires a specific scope — select the scopes your integration needs when creating the token.
In: header
Path Parameters
appId*string
Query Parameters
variant?string
Value in
- "preview"
- "publish"
Response Body
application/json
application/json
curl -X GET "https://example.com/apps/string/secrets"{ "shared": { "secrets": [ { "name": "string", "systemManaged": true, "createdAt": "string", "updatedAt": "string" } ] }, "variants": { "preview": { "secrets": [ { "name": "string", "systemManaged": true, "createdAt": "string", "updatedAt": "string" } ] }, "publish": { "secrets": [ { "name": "string", "systemManaged": true, "createdAt": "string", "updatedAt": "string" } ] } }}Authorization
bearerAuth AuthorizationBearer <token>
Personal Access Token (PAT). Generate one at the developer portal. Pass as: Authorization: Bearer . Each operation requires a specific scope — select the scopes your integration needs when creating the token.
In: header
Path Parameters
appId*string
Request Body
application/json
Response Body
application/json
application/json
curl -X POST "https://example.com/apps/string/secrets" \ -H "Content-Type: application/json" \ -d '{ "variant": "preview", "operations": { "additions": [], "updates": [], "deletions": [] } }'{ "shared": { "secrets": [ { "name": "string", "systemManaged": true, "createdAt": "string", "updatedAt": "string" } ] }, "variants": { "preview": { "secrets": [ { "name": "string", "systemManaged": true, "createdAt": "string", "updatedAt": "string" } ] }, "publish": { "secrets": [ { "name": "string", "systemManaged": true, "createdAt": "string", "updatedAt": "string" } ] } }}Agent & Automation Notes
Scopes
hosting.paas.apps:read, hosting.paas.apps:create, hosting.paas.apps:update, hosting.paas.apps:delete, hosting.paas.code:write, hosting.paas.deploy:execute, hosting.paas.secrets:write, hosting.paas.logs:readRate limit10–120 req/min per client IP depending on operation
On failureCreate app returns 202 with a job. Poll GET /apps/jobs/{jobId} until active or failed. Upload and publish return 200 with a job or deployment record. Poll the matching status endpoint until complete. GET operations are safe to retry. Do not resubmit writes without checking current state.
Related
Last updated on
How is this guide?