external_data_destinations

Manage where warehouse sources write their synced rows.

A destination can be attached to several sources, or to a single table on a source. Credentials come from an integration, so one connection can be reused across syncs.

put/api/projects/{project_id}/external_data_destinations/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/external_data_destinations/{id}/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this external data destination.

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/.

Request body

idstring uuid required
type'PostHogWarehouse' | 'Redshift' | 'Snowflake' | 'BigQuery' | 'Postgres' | 'Databricks' | 'AzureBlob' | 'S3' required
  • PostHogWarehouse - PostHog warehouse
  • Redshift - Redshift
  • Snowflake - Snowflake
  • BigQuery - BigQuery
  • Postgres - Postgres
  • Databricks - Databricks
  • AzureBlob - Azure Blob
  • S3 - S3
namestring required

Human-readable name shown when picking destinations for a source or table.

configunknown
integrationinteger nullable

Integration holding this destination's credentials. Required for every type except the PostHog warehouse.

is_posthog_warehouseboolean required

Whether this is the managed PostHog warehouse destination.

created_atstring date-time required
created_byinteger nullable required
updated_atstring date-time nullable required
status'healthy' | 'failing' | 'paused' required
  • healthy - Healthy
  • failing - Failing
  • paused - Paused
latest_errorstring nullable required

The last delivery error, safe to show to the user. Null if no delivery has failed.

latest_error_atstring date-time nullable required

When the last delivery error occurred.

Response

idstring uuid required
type'PostHogWarehouse' | 'Redshift' | 'Snowflake' | 'BigQuery' | 'Postgres' | 'Databricks' | 'AzureBlob' | 'S3' required
  • PostHogWarehouse - PostHog warehouse
  • Redshift - Redshift
  • Snowflake - Snowflake
  • BigQuery - BigQuery
  • Postgres - Postgres
  • Databricks - Databricks
  • AzureBlob - Azure Blob
  • S3 - S3
namestring required

Human-readable name shown when picking destinations for a source or table.

configunknown
integrationinteger nullable

Integration holding this destination's credentials. Required for every type except the PostHog warehouse.

is_posthog_warehouseboolean required

Whether this is the managed PostHog warehouse destination.

created_atstring date-time required
created_byinteger nullable required
updated_atstring date-time nullable required
status'healthy' | 'failing' | 'paused' required
  • healthy - Healthy
  • failing - Failing
  • paused - Paused
latest_errorstring nullable required

The last delivery error, safe to show to the user. Null if no delivery has failed.

latest_error_atstring date-time nullable required

When the last delivery error occurred.

Changes

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