Creates a new environment

POST 
/api/admin/environments

Uses the details provided in the payload to create a new environment

Request

application/json

Body

required

createEnvironmentSchema

name stringrequired

The name of the environment. Must be a URL-friendly string according to RFC 3968, section 2.3

Possible values: Value must match regular expression ^[a-zA-Z0-9~_.-]+$

type stringrequired

The type of environment you would like to create. Unleash officially recognizes the following values:

• development
• test
• preproduction
• production

If you pass a string that is not one of the recognized values, Unleash will accept it, but it will carry no special semantics.

Possible values: non-empty

enabled boolean

Newly created environments are enabled by default. Set this property to false to create the environment in a disabled state.

sortOrder integer

Defines where in the list of environments to place this environment. The list uses an ascending sort, so lower numbers are shown first. You can change this value later.

Responses

201

The resource was successfully created.

Response Headers

• location

  string

  The location of the newly created resource.

application/json

Schema

Schema

name stringrequired
The name of the environment
Example: my-dev-env
type stringrequired
The type of environment.
Example: development
enabled booleanrequired
true if the environment is enabled for the project, otherwise false.
Example: true
protected booleanrequired
true if the environment is protected, otherwise false. A protected environment can not be deleted.
Example: true
sortOrder integerrequired
Priority of the environment in a list of environments, the lower the value, the higher up in the list the environment will appear. Needs to be an integer
Example: 3
projectCount integernullable
The number of projects with this environment
Example: 10
apiTokenCount integernullable
The number of API tokens for the project environment
Example: 6
enabledToggleCount integernullable
The number of enabled toggles for the project environment
Example: 10

Example (from schema)

{
  "name": "my-dev-env",
  "type": "development",
  "enabled": true,
  "protected": true,
  "sortOrder": 3,
  "projectCount": 10,
  "apiTokenCount": 6,
  "enabledToggleCount": 10
}

400

The request data does not match what we expect.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: ValidationError
message string
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

Loading...