Chelabase
ManagementData api

Stop serving a Postgres database

DELETE
/v1/databases/{id}/branches/{branch_id}/pg-databases/{name}/data-api

Stops serving the database at once. The chelabase schema and the grants stay, so enabling again is instant; remove=true also drops the chelabase schema and its event trigger (grants to anon and authenticated stay). Answers 204 after the worker has done it. The branch's main database can't be disabled.

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Database id

Formatuuid
branch_id*string

Branch id

Formatuuid
name*string

The Postgres database's name

Query Parameters

remove?boolean

Also drop the chelabase machinery in the database

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/databases/497f6eca-6276-4993-bfeb-53cbbbba6f08/branches/497f6eca-6276-4993-bfeb-53cbbbba6f08/pg-databases/string/data-api"
Empty

Serve a Postgres database through the data API POST

Marks the database `enabling` and asks the worker to bootstrap it; the answer is 202 at once. Poll the branch's databases for `data_api`: `on`, or `error` with the reason. Pressing it again retries a failed or stuck enable. A database already `on` answers 200 and nothing runs. The branch serves at most `CHELABASE_BRANCH_DATA_API_DATABASE_CAP` databases (default 10, main included).

List a branch's data API keys GET

Next Page