Environments endpoint

Check Environment Connection

POST/environment-connections/{connectionId}/health/

Path parameters

connectionId

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}/environment-connections/{connectionId}/health/"

Replace the path identifiers with IDs from your instance.

200 OKapplication/json

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

{
  "id": "string",
  "connectionId": "string",
  "status": "string",
  "message": "string",
  "latencyMs": 0,
  "checkedAt": "2026-01-01T00:00:00Z",
  "metadata": {}
}

Handler-checked behavior

Checks a saved connection and records a health result. Inspect the returned status and message: an unreachable target returns 200 OK with status: offline when the probe itself completed. The environment status is updated to connected or unreachable.

Related guide

See the Environments guide for related tasks and context.