Rename an application environment (browser session)

Renames one named environment of the application. Only the name changes: its identity, role, order and deployments stay as they are, and the change is audited. An environment still named after its cluster cannot be renamed yet (409 environment_named_after_cluster). Held to the applications.write permission.

PATCH /org/applications/{application_id}/environments/{environment_id}

Rename an application environment (browser session)

Python

import requests

url = "https://api.platform.ankra.app/org/applications/{application_id}/environments/{environment_id}"

payload = { "name": "<string>" }
headers = {
    "cookie": "ankra_session=",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>"
}

Authorizations

ankra_session · string · cookie · required

Browser session. Mutations also require X-Ankra-CSRF.

Path Parameters

application_id · string · required

environment_id · string · required

Body

application/json

name · string · required

The new name. Trimmed; 1 to 100 characters with no control characters; unique within the application ignoring case.

Required string length: 1 - 100

Response

200

application/json

The environment's new name.

id · string<uuid> · required

name · string · required