External Data API Reference

External Data

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

`POST`
`POST`

← Previous page

Create external data schemas reload

Required API key scopes

external_data_source:write

Path parameters

id
string

Request parameters

should_sync
boolean
sync_type
incremental_field
stringnull
incremental_field_type
sync_frequency
sync_time_of_day
stringnull
primary_key_columns
arraynull
cdc_table_mode
enabled_columns
arraynull

Example request

POST /api/projects/:project_id/external_data_schemas/:id/reload
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/external_data_schemas/:id/reload/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/external_data_schemas/{external_data_schemas-2_id}/reload/".format(
        project_id=project_id,
		external_data_schemas-2_id="<the external data schemas-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200 No response body

Create external data schemas resync

Required API key scopes

external_data_source:write

Path parameters

id
string

Request parameters

should_sync
boolean
sync_type
incremental_field
stringnull
incremental_field_type
sync_frequency
sync_time_of_day
stringnull
primary_key_columns
arraynull
cdc_table_mode
enabled_columns
arraynull

Example request

POST /api/projects/:project_id/external_data_schemas/:id/resync
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/external_data_schemas/:id/resync/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/external_data_schemas/{external_data_schemas-2_id}/resync/".format(
        project_id=project_id,
		external_data_schemas-2_id="<the external data schemas-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200 No response body

← Previous page

External Data

Endpoints

Create external data schemas reload

Required API key scopes

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Create external data schemas resync

Required API key scopes

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Community questions