data_warehouse

Get the current provisioning status of the managed warehouse, with this project's onboarding state.

get/api/projects/{project_id}/data_warehouse/warehouse_status/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/data_warehouse/warehouse_status/
  • Auth: none declared

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

org_idstring required

duckgres org identifier (the PostHog organization id)

state'pending' | 'provisioning' | 'ready' | 'failed' | 'deleting' | 'deleted' required
  • pending - pending
  • provisioning - provisioning
  • ready - ready
  • failed - failed
  • deleting - deleting
  • deleted - deleted
status_messagestring required

Human-readable detail for the current state

s3_statestring required

Object-store sub-resource provisioning state

metadata_store_statestring required

Metadata-store sub-resource provisioning state

identity_statestring required

Worker identity sub-resource provisioning state

secrets_statestring required

Credentials sub-resource provisioning state

ready_atstring date-time nullable required

When the warehouse became ready

failed_atstring date-time nullable required

When provisioning failed

has_backfillboolean required

Whether this project already has a warehouse backfill configured. When true, its table name is fixed and the enable form should not be shown.

table_suffixstring nullable required

This project's per-environment table suffix (events_<suffix>). Null when the project still writes to the shared tables.

team_onboardedboolean required

Whether this project is onboarded onto the managed warehouse. False when the warehouse exists but this project has not picked a schema yet — show the onboarding screen in that case.

schema_namestring nullable required

Schema this project's data lands in. Null when the project is not onboarded.

Changes

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