Get Channel Postgres

Report the Postgres state of one channel the caller can reach.

The route only reads, so it runs on run_read_in_thread. An owner costs four round trips to the control DB: the access check, the channel_schemas row with the profile of the instance that holds it, which sets the displayed limit, and the two reads of the channel's restore (postgres/api.py::channel_restore), a third when the channel has one, and three more for its queue state while the restore is received (:func:_restore_response). A member reads the owner name too, for the external database name. The connection count and the size come from the tenant Postgres, not from the control DB.

get/apps/{app_id}/channels/{channel_id}/postgres

Request

  • Base URL: https://api.xhostd.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.xhostd.com/apps/{app_id}/channels/{channel_id}/postgres
  • Auth: none declared

Path parameters

app_idstring uuid required
channel_idstring uuid required

Headers

authorizationstring nullable

Response

Successful Response

db_namestring required
role_namestring required
status'provisioning' | 'ready' | 'failed' required
last_errorstring nullable required
connection_countinteger required
connection_limitinteger required
password_setboolean required
storage_bytesinteger required
external_enabledboolean required
external_hoststring required
external_databasestring required

Changes

No recorded changes to this operation across all 1 revision of this API.