Instance endpoint

Activate Archive Instance

POST/instance-activations/{instanceId}/

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}/instance-activations/{instanceId}/"

Replace the path identifiers with IDs from your instance.

202 Acceptedapplication/json

Handler-checked response shape; values and optional fields vary.

{
  "instance": {
    "id": "default",
    "name": "Default instance",
    "source": "local",
    "status": "active",
    "readOnly": false,
    "credentialsSet": true
  },
  "restarting": false
}

Handler-checked behavior

Use default to return to the writable instance or an ID returned by POST /instances/import/ to open a read-only snapshot. See instance management for the switching procedure.

Response shape

instance.status is active after selection. restarting reports whether this server can trigger its own restart; when it is false, restart the daemon manually. An imported snapshot has readOnly: true instead of the default instance's false.

Related guide

See the Instance guide for related tasks and context.