Environments endpoint

Test Environment Connection

POST/connection-tests/

Example request

application/json

{
  "type": "local"
}

cURL template

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

Supply a valid request.json before running this command.

200 OKapplication/json

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

{
  "healthy": true,
  "message": "string"
}

Handler-checked behavior

The example tests the local server. For SSH, agent, or Kubernetes, send the connection fields and credentials required by that type instead. This route tests the supplied connection without saving it. It returns 200 OK with healthy and message; healthy: false means the probe failed even though the HTTP request succeeded. Cloud connections are not handled here.

Response shape

The route can return 200 OK with healthy: false. Read healthy and message before saving or using the connection.

Related guide

See the Environments guide for related tasks and context.