Skip to main content
POST
env.delete

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

The project: its id or name, as returned by deploy.projects.list.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$
key
string
required

Name of the variable to delete.

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

Pick one environment when the name exists more than once. A variable shared by several environments is removed from all of them when omitted.

Available options:
production,
preview,
development

Response

The result

key
string
required

Variable name.

type
enum<string>
required

"secret": write-only. "config": readable in your dashboard. "system": set by the platform.

Available options:
secret,
config,
system
environments
enum<string>[]
required

Where the variable applies.

Available options:
production,
preview,
development
gitBranch
string

Git branch it is limited to, for preview variables.

updatedAt
string

When it last changed, ISO 8601.