environments.archive
POST
/environments/{environmentId}/archive
const url = 'https://example.com/api/environments/example/archive';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"reason":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/environments/example/archive \ --header 'Content-Type: application/json' \ --data '{ "reason": "example" }'Archives one environment while keeping deployment history readable. Public docs: /docs/environments/model/#environment-lifecycle
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” environmentId
required
string
Request Body
Section titled “Request Body ” Media type application/json
object
reason
string
Example generated
{ "reason": "example"}Responses
Section titled “ Responses ”OK
Media type application/json
object
id
required
string
Example generated
{ "id": "example"}