Instance endpoint

Save Instance

Send this request to the AkôFlow daemon. Authentication is required when an API token is configured.

PUT/instance/

Body

application/json

id string

Field defined by domaininstance.Instance.

name string

Field defined by domaininstance.Instance.

description string

Field defined by domaininstance.Instance.

organization string

Field defined by domaininstance.Instance.

location string

Field defined by domaininstance.Instance.

transferBufferBytes number

Field defined by domaininstance.Instance.

createdAt string

Field defined by domaininstance.Instance.

updatedAt string

Field defined by domaininstance.Instance.

cURL

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/"

200 OKapplication/json

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

*instance.Instance

Related guide

See the Instance guide for the corresponding Desktop workflow, concepts, and authored request examples.

Generated from the daemon router

This page is generated from internal/api/httpserver/httpserver.go, the registered handler, and JSON-tagged Go structs. Method, path, request fields, response kind, query parameters, media type, and successful status codes stay synchronized with the implementation.