Athena
ProvisionInstances

List or spin up managed Postgres instances

Returns Docker-managed Athena Postgres instances. When Docker is unavailable, the response still includes dependency/runtime status so operators can install or repair the local provisioning runtime.

GET
/admin/provision/instances

Header Parameters

apikey*string

The static admin key configured as ATHENA_KEY_12. Authorization headers (Bearer <key>), X-API-Key, X-Athena-Key, or ?api_key= are also accepted.

Response Body

application/json

curl -X GET "https://athena-cluster.com/admin/provision/instances" \  -H "apikey: string"
{
  "instances": [
    {
      "container_name": "string",
      "running": true,
      "status": "string",
      "image": "string",
      "host_port": 0,
      "labels": {
        "property1": "string",
        "property2": "string"
      },
      "linked_client": {
        "client_name": "string",
        "runtime_registered": true,
        "runtime_known": true,
        "catalog_registered": true
      },
      "runtime_client": {},
      "catalog_client": {}
    }
  ],
  "count": 0,
  "dependencies": {
    "os_family": "string",
    "package_manager": "string",
    "running_as_root": true,
    "sudo_available": true,
    "sudo_non_interactive_available": true,
    "systemctl_available": true,
    "can_attempt_install": true,
    "docker_binary_available": true,
    "docker_service_active": true,
    "postgres_binary_available": true,
    "postgres_service_active": true,
    "missing": [
      "string"
    ],
    "notes": [
      "string"
    ]
  },
  "instance_runtime_available": true,
  "instance_runtime_error": "string"
}
Empty

Attempt to install Docker and Postgres dependencies for local provisioning POST

Best-effort Linux-only installer that detects the host package manager, attempts to install Docker and PostgreSQL packages, and optionally starts the related services. Requires root or passwordless sudo for package installation.

List or spin up managed Postgres instances POST

Creates (or reuses) a managed local Postgres container, optionally provisions Athena schema, and can register the resulting connection in runtime and/or catalog client registries.