Updates an environment by name

PUT <your-unleash-url>/api/admin/environments/update/:name

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Given an environment by name updates the environment with the given payload. Note that name, enabled and protected cannot be changed by this API

Request

Path Parameters

• name string required

application/json

Body

required

updateEnvironmentSchema

• type string

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

• sortOrder integer

  Changes the sort order of this environment.

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

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

name — path required

Body required

{
  "type": "string",
  "sortOrder": 0
}

curl / cURL

curl -L -X PUT '<your-unleash-url>/api/admin/environments/update/:name' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "string",
  "sortOrder": 0
}'

python / requests

curl -L -X PUT '<your-unleash-url>/api/admin/environments/update/:name' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "string",
  "sortOrder": 0
}'

go / native

curl -L -X PUT '<your-unleash-url>/api/admin/environments/update/:name' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "string",
  "sortOrder": 0
}'

nodejs / axios

curl -L -X PUT '<your-unleash-url>/api/admin/environments/update/:name' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "string",
  "sortOrder": 0
}'

ruby / Net::HTTP

curl -L -X PUT '<your-unleash-url>/api/admin/environments/update/:name' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "string",
  "sortOrder": 0
}'

csharp / RestSharp

curl -L -X PUT '<your-unleash-url>/api/admin/environments/update/:name' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "string",
  "sortOrder": 0
}'

php / cURL

curl -L -X PUT '<your-unleash-url>/api/admin/environments/update/:name' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "string",
  "sortOrder": 0
}'

java / OkHttp

curl -L -X PUT '<your-unleash-url>/api/admin/environments/update/:name' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "string",
  "sortOrder": 0
}'

powershell / RestMethod

curl -L -X PUT '<your-unleash-url>/api/admin/environments/update/:name' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "type": "string",
  "sortOrder": 0
}'