Update an environment

Updates an environment with the given environment ID. You can update the name, description, and limit settings.

POST /environments/{id}

Update an environment

cURL

curl --request POST \
  --url https://management-api.fpjs.io/environments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <x-api-version>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "limit_mode": "none",
  "limit_value": 123
}
'

200

{
  "data": {
    "id": "ae_rrETjdWcfqI6AFsk",
    "name": "Default environment",
    "is_restricted": false,
    "created_at": "2024-05-31T01:24:39.506Z",
    "updated_at": "2024-05-31T01:24:39.506Z",
    "description": "Production environment",
    "limit_mode": "none",
    "limit_value": 100000,
    "restricted_at": "2024-05-31T01:24:39.506Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version · string · required

Management API version.

Path Parameters

id · string · required

Body

application/json

name · string

Name for the environment

Maximum string length: 255

description · string

Description for the environment

Maximum string length: 256

limit_mode · enum<string>

Limit mode for the environment

Available options: none, restrict, notify

limit_value · number

Limit value for the environment (required when limitMode is not set to "none")

Response

200

application/json

Updated environment object.

data · object · required

Show child attributes