Athena
Provision

Provision a Postgres database with the Athena schema

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.

POST
/admin/provision

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

uri?string

Direct Postgres URI to provision (mutually exclusive with client_name).

Formaturi
client_name?string

Registered client whose URI will be used (mutually exclusive with uri).

register?boolean

When true and uri is provided, register the client in the runtime catalog.

Defaultfalse
register_name?|

Optional client name when registering (defaults to "provisioned").

Response Body

application/json

curl -X POST "https://athena-cluster.com/admin/provision" \  -H "apikey: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "statements_executed": 0,
  "client": "string",
  "registered": "string",
  "tables": [
    "string"
  ]
}
Empty
Empty
Empty

Upsert a global IP whitelist rule POST

Previous Page

Spin up a local Docker-backed Postgres instance 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.