Skip to main content
POST
workflow.environment-variable.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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
key
string
required

The name of a variable in the connected environment.

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

Request its value. Sources without private value delivery decline this option; default false.

Response

The result

key
string
required

The confirmed variable name.

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

The connected environment.

Available options:
production,
development,
staging,
preview
value
string

A non-secret value only when explicitly requested and supported; secret values stay private.

Maximum string length: 65536