property_access_controls
Create or update a property access control rule.
post/api/projects/{project_id}/property_access_controls/
Request
- Base URL: https://us.posthog.com
- URL: https://us.posthog.com/api/projects/{project_id}/property_access_controls/
- Auth: HTTP bearer
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/.
Request body
property_definition_idstring
The existing property definition ID. Provide this or ai_property.
ai_property'$ai_trace_id' | '$ai_session_id' | '$ai_parent_id' | '$ai_span_id' | '$ai_span_type' | '$ai_generation_id' | '$ai_experiment_id' | '$ai_span_name' | '$ai_trace_name' | '$ai_prompt_name' | '$ai_model' | '$ai_provider' | '$ai_framework' | '$ai_total_tokens' | '$ai_input_tokens' | '$ai_output_tokens' | '$ai_text_input_tokens' | '$ai_text_output_tokens' | '$ai_image_input_tokens' | '$ai_image_output_tokens' | '$ai_audio_input_tokens' | '$ai_audio_output_tokens' | '$ai_video_input_tokens' | '$ai_video_output_tokens' | '$ai_reasoning_tokens' | '$ai_cache_read_input_tokens' | '$ai_cache_creation_input_tokens' | '$ai_web_search_count' | '$ai_input_cost_usd' | '$ai_output_cost_usd' | '$ai_total_cost_usd' | '$ai_request_cost_usd' | '$ai_web_search_cost_usd' | '$ai_audio_cost_usd' | '$ai_image_cost_usd' | '$ai_video_cost_usd' | '$ai_latency' | '$ai_time_to_first_token' | '$ai_is_error' | '$ai_error' | '$ai_error_type' | '$ai_error_normalized' | '$ai_input' | '$ai_output' | '$ai_output_choices' | '$ai_input_state' | '$ai_output_state' | '$ai_tools'
- $ai_trace_id - $ai_trace_id
- $ai_session_id - $ai_session_id
- $ai_parent_id - $ai_parent_id
- $ai_span_id - $ai_span_id
- $ai_span_type - $ai_span_type
- $ai_generation_id - $ai_generation_id
- $ai_experiment_id - $ai_experiment_id
- $ai_span_name - $ai_span_name
- $ai_trace_name - $ai_trace_name
- $ai_prompt_name - $ai_prompt_name
- $ai_model - $ai_model
- $ai_provider - $ai_provider
- $ai_framework - $ai_framework
- $ai_total_tokens - $ai_total_tokens
- $ai_input_tokens - $ai_input_tokens
- $ai_output_tokens - $ai_output_tokens
- $ai_text_input_tokens - $ai_text_input_tokens
- $ai_text_output_tokens - $ai_text_output_tokens
- $ai_image_input_tokens - $ai_image_input_tokens
- $ai_image_output_tokens - $ai_image_output_tokens
- $ai_audio_input_tokens - $ai_audio_input_tokens
- $ai_audio_output_tokens - $ai_audio_output_tokens
- $ai_video_input_tokens - $ai_video_input_tokens
- $ai_video_output_tokens - $ai_video_output_tokens
- $ai_reasoning_tokens - $ai_reasoning_tokens
- $ai_cache_read_input_tokens - $ai_cache_read_input_tokens
- $ai_cache_creation_input_tokens - $ai_cache_creation_input_tokens
- $ai_web_search_count - $ai_web_search_count
- $ai_input_cost_usd - $ai_input_cost_usd
- $ai_output_cost_usd - $ai_output_cost_usd
- $ai_total_cost_usd - $ai_total_cost_usd
- $ai_request_cost_usd - $ai_request_cost_usd
- $ai_web_search_cost_usd - $ai_web_search_cost_usd
- $ai_audio_cost_usd - $ai_audio_cost_usd
- $ai_image_cost_usd - $ai_image_cost_usd
- $ai_video_cost_usd - $ai_video_cost_usd
- $ai_latency - $ai_latency
- $ai_time_to_first_token - $ai_time_to_first_token
- $ai_is_error - $ai_is_error
- $ai_error - $ai_error
- $ai_error_type - $ai_error_type
- $ai_error_normalized - $ai_error_normalized
- $ai_input - $ai_input
- $ai_output - $ai_output
- $ai_output_choices - $ai_output_choices
- $ai_input_state - $ai_input_state
- $ai_output_state - $ai_output_state
- $ai_tools - $ai_tools
access_level'read_write' | 'read' | 'none' required
- read_write - read_write
- read - read
- none - none
organization_memberstring uuid nullable
The organization member UUID to set an override for.
rolestring uuid nullable
The role UUID to set an override for.
Response
idstring uuid required
access_level'read_write' | 'read' | 'none' required
- read_write - read_write
- read - read
- none - none
organization_memberstring uuid nullable required
The organization member UUID this rule applies to, if any.
rolestring uuid nullable required
The role UUID this rule applies to, if any.
created_byinteger nullable required
created_atstring date-time required
updated_atstring date-time required
Changes
No recorded changes to this operation across all 1 revision of this API.