Clones an environment

POST /api/admin/environments/:name/clone

Given an existing environment name and a set of options, this will create a copy of that environment

Request

Path Parameters

• name string required

application/json

Body

required

cloneEnvironmentSchema

• name string required

  The name of the new cloned environment, this cannot be changed later

• type string required

  Updates the type of environment (i.e. development or production).

• projects string[]

  A list of projects that should be included in the cloned environment.

• clonePermissions boolean

  Copies the RBAC permissions from the source environment if true. Defaults to true

Responses

• 200
• 400
• 401

---

environmentSchema

application/json

Schema

Schema

• name string required

  The name of the environment

• type string required

  The type of environment.

• enabled boolean required

  true if the environment is enabled for the project, otherwise false.

• protected boolean required

  true if the environment is protected, otherwise false. A protected environment can not be deleted.

• sortOrder integer required

  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

• projectCount integer nullable

  The number of projects with this environment

• apiTokenCount integer nullable

  The number of API tokens for the project environment

• enabledToggleCount integer nullable

  The number of enabled toggles for the project environment

Example (from schema)

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

The request data does not match what we expect.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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 []."
}

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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...