Toggle the environment with `name` off

POST <your-unleash-url>/api/admin/environments/:name/off

Authorization

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

Removes this environment from the list of available environments for projects to use

Request

Path Parameters

• name string required

Responses

• 204
• 401
• 403
• 404

---

This response has no body.

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

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

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": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

The requested resource was not found.

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": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

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

curl / cURL

curl -L -X POST '<your-unleash-url>/api/admin/environments/:name/off' \
-H 'Authorization: <API_KEY_VALUE>'

python / requests

curl -L -X POST '<your-unleash-url>/api/admin/environments/:name/off' \
-H 'Authorization: <API_KEY_VALUE>'

go / native

curl -L -X POST '<your-unleash-url>/api/admin/environments/:name/off' \
-H 'Authorization: <API_KEY_VALUE>'

nodejs / axios

curl -L -X POST '<your-unleash-url>/api/admin/environments/:name/off' \
-H 'Authorization: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X POST '<your-unleash-url>/api/admin/environments/:name/off' \
-H 'Authorization: <API_KEY_VALUE>'

csharp / RestSharp

curl -L -X POST '<your-unleash-url>/api/admin/environments/:name/off' \
-H 'Authorization: <API_KEY_VALUE>'

php / cURL

curl -L -X POST '<your-unleash-url>/api/admin/environments/:name/off' \
-H 'Authorization: <API_KEY_VALUE>'

java / OkHttp

curl -L -X POST '<your-unleash-url>/api/admin/environments/:name/off' \
-H 'Authorization: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X POST '<your-unleash-url>/api/admin/environments/:name/off' \
-H 'Authorization: <API_KEY_VALUE>'