Environments-2 API Reference

Environments-2

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

Endpoints

`GET`
`PATCH`
`GET`
`PATCH`
`PATCH`
`GET`

← Previous page

Retrieve environments logs config

Manage logs product configuration for this environment.

Path parameters

id
integer

Example request

GET /api/projects/:project_id/environments/:id/logs_config
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/environments/:id/logs_config/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/environments/{environments-2_id}/logs_config/".format(
        project_id=project_id,
		environments-2_id="<the environments-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Update environments logs config

Manage logs product configuration for this environment.

Path parameters

id
integer

Request parameters

name
string
access_control
boolean
app_urls
array
anonymize_ips
boolean
completed_snippet_onboarding
boolean
test_account_filters
test_account_filters_default_checked
booleannull
path_cleaning_filters
is_demo
boolean
timezone
data_attributes
person_display_name_properties
arraynull
correlation_config
autocapture_opt_out
booleannull
autocapture_exceptions_opt_in
booleannull
autocapture_web_vitals_opt_in
booleannull
autocapture_web_vitals_allowed_metrics
autocapture_exceptions_errors_to_ignore
capture_console_log_opt_in
booleannull
logs_settings
capture_performance_opt_in
booleannull
session_recording_opt_in
boolean
session_recording_sample_rate
stringnull
session_recording_minimum_duration_milliseconds
integernull
session_recording_linked_flag
session_recording_network_payload_capture_config
session_recording_masking_config
session_recording_url_trigger_config
arraynull
session_recording_url_blocklist_config
arraynull
session_recording_event_trigger_config
arraynull
session_recording_trigger_match_type_config
stringnull
session_recording_trigger_groups
session_recording_retention_period
session_replay_config
survey_config
week_start_day
primary_dashboard
integernull
live_events_columns
arraynull
recording_domains
arraynull
cookieless_server_hash_mode
human_friendly_comparison_periods
booleannull
inject_web_apps
booleannull
extra_settings
modifiers
has_completed_onboarding_for
surveys_opt_in
booleannull
heatmaps_opt_in
booleannull
flags_persistence_default
booleannull
feature_flag_confirmation_enabled
booleannull
feature_flag_confirmation_message
stringnull
default_evaluation_contexts_enabled
booleannull
require_evaluation_contexts
booleannull
capture_dead_clicks
booleannull
default_data_theme
integernull
revenue_analytics_config
marketing_analytics_config
customer_analytics_config
onboarding_tasks
base_currency
Default: USD
web_analytics_pre_aggregated_tables_enabled
booleannull
receive_org_level_activity_logs
booleannull
business_model
conversations_enabled
booleannull
conversations_settings
proactive_tasks_enabled
booleannull

Example request

PATCH /api/projects/:project_id/environments/:id/logs_config
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/environments/:id/logs_config/\
	-d uuid="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/environments/{environments-2_id}/logs_config/".format(
        project_id=project_id,
		environments-2_id="<the environments-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"uuid": "string"
	}
).json()

Example response

Status 200 No response body

Retrieve environments promoted product intent

Return the product key (e.g. session_replay, web_analytics) this team selected as their primary product during onboarding. Resolved from the team's most recent primary-onboarding ProductIntent record (the one carrying the onboarding product selected - primary context) — not from the user showed product intent event, which also fires for non-onboarding contexts. Returns null when no primary onboarding product intent has been captured (e.g. teams created before this signal existed, or where onboarding was skipped).

Required API key scopes

project:read

Path parameters

id
integer

Response

Example request

GET /api/projects/:project_id/environments/:id/promoted_product_intent
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/environments/:id/promoted_product_intent/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/environments/{environments-2_id}/promoted_product_intent/".format(
        project_id=project_id,
		environments-2_id="<the environments-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "product_key": "string"
}

Update environments reset token

Deprecated: use /api/environments/{id}/ instead.

Path parameters

id
integer

Request parameters

name
string
access_control
boolean
app_urls
array
anonymize_ips
boolean
completed_snippet_onboarding
boolean
test_account_filters
test_account_filters_default_checked
booleannull
path_cleaning_filters
is_demo
boolean
timezone
data_attributes
person_display_name_properties
arraynull
correlation_config
autocapture_opt_out
booleannull
autocapture_exceptions_opt_in
booleannull
autocapture_web_vitals_opt_in
booleannull
autocapture_web_vitals_allowed_metrics
autocapture_exceptions_errors_to_ignore
capture_console_log_opt_in
booleannull
logs_settings
capture_performance_opt_in
booleannull
session_recording_opt_in
boolean
session_recording_sample_rate
stringnull
session_recording_minimum_duration_milliseconds
integernull
session_recording_linked_flag
session_recording_network_payload_capture_config
session_recording_masking_config
session_recording_url_trigger_config
arraynull
session_recording_url_blocklist_config
arraynull
session_recording_event_trigger_config
arraynull
session_recording_trigger_match_type_config
stringnull
session_recording_trigger_groups
session_recording_retention_period
session_replay_config
survey_config
week_start_day
primary_dashboard
integernull
live_events_columns
arraynull
recording_domains
arraynull
cookieless_server_hash_mode
human_friendly_comparison_periods
booleannull
inject_web_apps
booleannull
extra_settings
modifiers
has_completed_onboarding_for
surveys_opt_in
booleannull
heatmaps_opt_in
booleannull
flags_persistence_default
booleannull
feature_flag_confirmation_enabled
booleannull
feature_flag_confirmation_message
stringnull
default_evaluation_contexts_enabled
booleannull
require_evaluation_contexts
booleannull
capture_dead_clicks
booleannull
default_data_theme
integernull
revenue_analytics_config
marketing_analytics_config
customer_analytics_config
onboarding_tasks
base_currency
Default: USD
web_analytics_pre_aggregated_tables_enabled
booleannull
receive_org_level_activity_logs
booleannull
business_model
conversations_enabled
booleannull
conversations_settings
proactive_tasks_enabled
booleannull

Example request

PATCH /api/projects/:project_id/environments/:id/reset_token
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/environments/:id/reset_token/\
	-d uuid="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/environments/{environments-2_id}/reset_token/".format(
        project_id=project_id,
		environments-2_id="<the environments-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"uuid": "string"
	}
).json()

Example response

Status 200 No response body

Update environments rotate secret token

Deprecated: use /api/environments/{id}/ instead.

Path parameters

id
integer

Request parameters

name
string
access_control
boolean
app_urls
array
anonymize_ips
boolean
completed_snippet_onboarding
boolean
test_account_filters
test_account_filters_default_checked
booleannull
path_cleaning_filters
is_demo
boolean
timezone
data_attributes
person_display_name_properties
arraynull
correlation_config
autocapture_opt_out
booleannull
autocapture_exceptions_opt_in
booleannull
autocapture_web_vitals_opt_in
booleannull
autocapture_web_vitals_allowed_metrics
autocapture_exceptions_errors_to_ignore
capture_console_log_opt_in
booleannull
logs_settings
capture_performance_opt_in
booleannull
session_recording_opt_in
boolean
session_recording_sample_rate
stringnull
session_recording_minimum_duration_milliseconds
integernull
session_recording_linked_flag
session_recording_network_payload_capture_config
session_recording_masking_config
session_recording_url_trigger_config
arraynull
session_recording_url_blocklist_config
arraynull
session_recording_event_trigger_config
arraynull
session_recording_trigger_match_type_config
stringnull
session_recording_trigger_groups
session_recording_retention_period
session_replay_config
survey_config
week_start_day
primary_dashboard
integernull
live_events_columns
arraynull
recording_domains
arraynull
cookieless_server_hash_mode
human_friendly_comparison_periods
booleannull
inject_web_apps
booleannull
extra_settings
modifiers
has_completed_onboarding_for
surveys_opt_in
booleannull
heatmaps_opt_in
booleannull
flags_persistence_default
booleannull
feature_flag_confirmation_enabled
booleannull
feature_flag_confirmation_message
stringnull
default_evaluation_contexts_enabled
booleannull
require_evaluation_contexts
booleannull
capture_dead_clicks
booleannull
default_data_theme
integernull
revenue_analytics_config
marketing_analytics_config
customer_analytics_config
onboarding_tasks
base_currency
Default: USD
web_analytics_pre_aggregated_tables_enabled
booleannull
receive_org_level_activity_logs
booleannull
business_model
conversations_enabled
booleannull
conversations_settings
proactive_tasks_enabled
booleannull

Example request

PATCH /api/projects/:project_id/environments/:id/rotate_secret_token
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/environments/:id/rotate_secret_token/\
	-d uuid="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/environments/{environments-2_id}/rotate_secret_token/".format(
        project_id=project_id,
		environments-2_id="<the environments-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"uuid": "string"
	}
).json()

Example response

Status 200 No response body

Retrieve environments settings as of

Return the team settings as of the provided timestamp. Query params:

at: ISO8601 datetime (required)
scope: optional, one or multiple keys to filter the returned settings

Path parameters

id
integer

Example request

GET /api/projects/:project_id/environments/:id/settings_as_of
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/environments/:id/settings_as_of/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/environments/{environments-2_id}/settings_as_of/".format(
        project_id=project_id,
		environments-2_id="<the environments-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

← Previous page

Environments-2

Endpoints

Retrieve environments logs config

Path parameters

Example request

Example response

Status 200 No response body

Update environments logs config

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Retrieve environments promoted product intent

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update environments reset token

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Update environments rotate secret token

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Retrieve environments settings as of

Path parameters

Example request

Example response

Status 200 No response body

Community questions