Skip to main content
POST
devices.environment.update

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

The ref returned by devices.environment.create or a row of devices.environments.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
label
string

Environment name, 3 to 255 characters.

Required string length: 3 - 255
description
string

Environment description.

Maximum string length: 256
limitMode
enum<string>

No limit, block over limit, or notify over limit.

Available options:
none,
restrict,
notify
limitValue
number

Identification limit; required for restrict or notify.

Required range: x >= 1

Response

The result

environment
object
required

Updated environment.