Chelabase
ManagementBranches

Reveal a branch's connection details

GET
/v1/databases/{id}/branches/{branch_id}/connection

The connection details of the branch's owner, or of the role named by role, for its main database or the one named by database. password is null, with the reason in password_state, when it can't be shown: a role whose password was set in SQL (only its hash is stored) or has an MD5 hash the proxy can't use; the uri then has no password. Never cached (Cache-Control: no-store) and never logged.

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Database id

Formatuuid
branch_id*string

Branch id

Formatuuid

Query Parameters

role?string

The role to connect as: any role of the branch. Absent, or the owner's name, gives the owner

database?string

The Postgres database to connect to, one of the branch's databases (the system postgres one included). Absent gives the main database

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/databases/497f6eca-6276-4993-bfeb-53cbbbba6f08/branches/497f6eca-6276-4993-bfeb-53cbbbba6f08/connection"
{  "ca_file": "string",  "database": "string",  "host": "string",  "http_url": "string",  "password": "string",  "password_state": "generated",  "port": 0,  "uri": "string",  "user": "string"}

Delete a branch DELETE

Previous Page

List a branch's Postgres databases GET

The databases of the branch's Postgres cluster: the main one first, then by name. The cluster's own `postgres` database is listed with origin `system`. Pass a name as `database` to the connection details. Each carries its data API state and default schema.