Catalog

update_environment

Write grantIdempotent

Change an environment's slug, name, description or emoji. Only the fields given change; the class cannot. An archived environment cannot change. Returns the environment. Needs write access.

Inputs

environmentstringRequired

The environment's slug, such as staging.

slugstring

A new slug for the environment, such as preview.

namestring

The environment's display name, up to 80 characters, such as Staging.

descriptionnullable string

What the environment is for, up to 200 characters. null clears it.

emojinullable string

An emoji shown with the name, up to 8 characters, such as 🧪. null clears it.

tools/callJSON-RPC

1{2  "jsonrpc": "2.0",3  "id": 1,4  "method": "tools/call",5  "params": {6    "name": "update_environment",7    "arguments": {8      "environment": "staging",9      "description": "Release candidates with test data."10    }11  }12}

POST/agent/v1/environments:update

1curl -X POST https://api.qa.clankership.net/agent/v1/environments:update \2  -H "Authorization: Bearer $CLANKER_AGENT_TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5    "environment": "staging",6    "description": "Release candidates with test data."7  }'

Nextarchive_environment