Create environment

Creates a new environment for the workspace associated with the Management API key. Maximum number of environments in defined by your plan limits. If you need additional environments, contact our support team.

POST /environments

Create an environment

cURL

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

201

{
  "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_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.

Body

application/json

name · string · required

Name for the new environment

Required string length: 3 - 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 "none")

Required range: x >= 1

Response

201

application/json

Created environment object.

data · object · required

Show child attributes