latestOpenAPI 3.1.02026-08-223391355.6 KB

aa8d44585147

projects

Get project cloud telemetry (Preview)

Plan: All plans

Returns cloud telemetry for a project's database, matching the editor's Cloud settings panel: disk-space usage, compute instance tier, lifecycle status and pause state, region, Postgres version, and resource-pressure alerts. Values are platform measurements cached for up to a few minutes; disk.timestamp reports when the platform measured it. Individual fields are omitted while their lookup is temporarily unavailable.

This operation is in public preview (beta) and served under /v1beta. Request and response shapes may change before it graduates to the stable /v1 surface.

get/v1beta/projects/{project_id}/cloud

Path parameters

project_idstring required

Project ID

Query parameters

environment'production' | 'development'

Cloud environment to read. Defaults to production.

Response

environmentstring required

Cloud environment these values describe.

instance_tier'xs' | 's' | 'm' | 'ml' | 'l' | 'xl' | 'xxl' required

Current compute instance tier code.

instance_tier_labelstring required

Human-readable tier name as shown in the editor (Tiny, Mini, Small, Medium, Large, X-Large, 2X-Large).

pause_reasonstring

Why the instance was paused (e.g. credit_limit), when recorded.

postgres_versionstring

Postgres major/minor version. Omitted while the lookup is temporarily unavailable.

regionstring

Region the database runs in. Omitted while the lookup is temporarily unavailable.

Database instance lifecycle status. INACTIVE means paused. Cached for up to a minute; omitted while the lookup is temporarily unavailable.

user_pausedboolean required

True when a user (or the platform) explicitly paused this cloud instance.