Cloud endpoint

Stop Cloud Instance

POST/cloud-instances/{instanceId}/stop/

Path parameters

instanceId

Identifier used by the registered route.

Request body

none

This endpoint does not accept a request body.

cURL template

curl --fail-with-body \
  -H "Authorization: Bearer ${AKOFLOW_API_TOKEN}" \
  -X POST \
  "${AKOFLOW_API_URL}/cloud-instances/{instanceId}/stop/"

Replace the path identifiers with IDs from your instance.

202 Acceptedapplication/json

Field shape inferred from Go types; inspect the returned JSON for actual values and optional fields.

{
  "id": "string",
  "kind": "string",
  "status": "string",
  "environmentId": "string",
  "capacityTargetId": "string",
  "instanceId": "string",
  "executionRunId": "string",
  "activityId": "string",
  "phase": "string",
  "request": {
    "capacityTargetId": "string",
    "name": "string",
    "sshUsername": "string",
    "instanceId": "string"
  },
  "failureReason": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "startedAt": "2026-01-01T00:00:00Z",
  "finishedAt": "2026-01-01T00:00:00Z"
}

Handler-checked behavior

No JSON body is required. The instance ID must exist (404 otherwise). 202 Accepted queues a stop operation; the worker accepts a ready instance and treats an already-stopped instance as a no-op. Other states or lifecycle safety checks can fail after acceptance. A repeated active stop returns the existing operation; a different active action returns 409.

Related guide

See the Cloud guide for related tasks and context.