Halt this key's environment

The kill switch. The agent stops acting and nothing leaves the environment: action invocations are blocked, deliveries defer, workflow steps park, and writes to memory, files, sessions, cache and Connect are refused. Publishes still queue and approvals can still be decided, so nothing in flight is lost. Applies to the environment this key is bound to – a staging key cannot halt production.

POST/api/v2/environment/halt

Authorization

AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Header parameters

X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128

Request body

application/json

reasonstring

Why the environment is being halted recorded for the audit trail.

max length 500

Responses

200

A single environment.

successbooleanrequired

Allowed:true

dataEnvironmentrequired

Show properties

idstring<uuid>required

kindstring

Allowed:developmentstagingproduction

namestringrequired

slugstringrequired

isDefaultbooleanrequired

The environment new keys and resources default to.

isProtectedbooleanrequired

Production protection for destructive and promotion actions.

haltedbooleanrequired

Kill switch: while true the agent cannot act and nothing leaves the environment -- action invocations are blocked, deliveries defer, workflow steps pause, and writes to memory, files, sessions, cache and Connect are refused. Publishes still queue, approvals can still be decided, and reads still answer.

haltedAtstring<date-time> | nullrequired

haltedReasonstring | nullrequired

createdAtstring<date-time>required

updatedAtstring<date-time>required

401

Unauthorized - Invalid or missing API key

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

409

The request conflicts with current resource state or a concurrent decision.

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (Anlyon API key)Remember on this deviceInclude my values in samples

Parameters

X-Request-IdheaderOptional caller correlation ID. Unsafe or oversized values are replaced.

Bodyapplication/json

reasonstringWhy the environment is being halted recorded for the audit trail.

Request

curl -X POST 'https://api.anlyon.com/api/v2/environment/halt' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "reason": "string"
}'

const response = await fetch("https://api.anlyon.com/api/v2/environment/halt", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"reason\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://api.anlyon.com/api/v2/environment/halt",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"reason\": \"string\"\n}",
)

Response

{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "kind": "development",
    "name": "string",
    "slug": "string",
    "isDefault": true,
    "isProtected": true,
    "halted": true,
    "haltedAt": "2019-08-24T14:15:22Z",
    "haltedReason": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "requestId": "req_0123456789abcdef0123456789abcdef",
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {}
  }
}

{
  "success": false,
  "requestId": "req_0123456789abcdef0123456789abcdef",
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {}
  }
}