Skip to main content
POST
env.variables.replace

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
kind
enum<string>
required

Resource whose entire variable set is replaced.

Available options:
service,
build-source
id
string
required

Identifier in your connected hosting account.

Pattern: ^[A-Za-z0-9_-]{1,100}$
variables
object[]
required

One to 100 unique values or generation requests; maximum 1 MiB.

Required array length: 1 - 100 elements
confirm
boolean
required

Explicitly approve this change, including removal or replacement of existing configuration.

Response

The result

keysSet
string[]
required

Keys included in the replacement.

Variable name.

Pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$
keysRemoved
string[]
required

Previously stored keys omitted by this replacement.

Variable name.

Pattern: ^[A-Za-z_][A-Za-z0-9_]{0,255}$