Create an environment

Create a new environment.

Token Permissions: [ environments:edit ]

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The environment object.

string
required
length ≥ 1
string
boolean
Defaults to false

Indicates whether this is the organization’s default environment. The default value is false. The valid values are:

  • true: The environment is the default.
  • false: The environment is not default.
boolean
Defaults to false

Indicates whether this is an organization’s production environment. The default value is true. The valid values are:

  • true: The environment is a production environment.
  • false: The environment is not a production environment.

This is an immutable field. If an environment needs to be migrated, architecture can be migrated to a new environment with the desired environment type instead.

string
enum

Specify the name of the icon to use for the environment.

string
^#[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$

Specify the RGB hexadecimal color code for the environment's foreground.
You can use 6-digit (opaque) or 8-digit (alpha) hex color codes.

string
^#[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$

Specify the RGB hexadecimal color code for the environment's background.
You can use 6-digit (opaque) or 8-digit (alpha) hex color codes.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json