Instance endpoint

Save Instance

PUT/instance/

Request body

application/json

See the request guidance below for a valid body.

cURL template

curl --fail-with-body \
  -H "Authorization: Bearer ${AKOFLOW_API_TOKEN}" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  -X PUT \
  "${AKOFLOW_API_URL}/instance/"

Supply a valid request.json before running this command.

200 OKapplication/json

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

{
  "id": "string",
  "name": "string",
  "description": "string",
  "organization": "string",
  "location": "string",
  "transferBufferBytes": 0,
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

Handler-checked behavior

Send the complete current instance object with non-empty id and name; this route saves the supplied object, so preserve existing identity and metadata when changing one field. transferBufferBytes accepts 5–64 MiB; 0 selects the 8 MiB default. The instance guide reads the current object before updating it.

Related guide

See the Instance guide for related tasks and context.