Athena
ProvisionInstances

Spin up a local Docker-backed Postgres instance

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.

POST
/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.

Request Body

application/json

client_name*string
container_name?|
image?|
host?|
host_port?|
Formatint32
db_name?|
username?|
password?|
startup_timeout_secs?|
Formatint64
reuse_existing?boolean
Defaultfalse
provision_schema?boolean
Defaulttrue
register_runtime?boolean
Defaulttrue
register_catalog?boolean
Defaulttrue

Response Body

curl -X POST "https://athena-cluster.com/admin/provision/instances" \  -H "apikey: string" \  -H "Content-Type: application/json" \  -d '{    "client_name": "string"  }'
Empty
Empty
Empty
Empty
Empty

Provision a Postgres database with the Athena schema POST

Runs the bundled provisioning SQL against either a direct `uri` or a registered `client_name`. When `register` is true and `uri` is provided, the client is added to the runtime catalog after provisioning.

Delete a local managed Postgres instance DELETE

Next Page