openapi.yaml
Rama main · réplica de lectura del repositorio original.
openapi: 3.1.0
info:
title: Flagsmith API
version: v1
description: 'Flagsmith''s Core and SDK APIs. Check out <a href=''https://docs.flagsmith.com''>Flagsmith documentation</a>.'
contact:
email: support@flagsmith.com
license:
name: BSD License
identifier: BSD-3-Clause
servers:
- url: 'https://api.flagsmith.com'
description: Flagsmith API
paths:
'/api/__future__/environments/{environment_key}/features/{feature_id}/':
get:
operationId: api___future___environments_features_retrieve
description: Read what the flag serves in the environment.
parameters:
- name: environment_key
in: path
required: true
schema:
type: string
- name: feature_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFlagResponse'
security:
- tokenAuth: []
- Master API Key: []
tags:
- experimental
put:
operationId: api___future___environments_features_update
description: 'Replace the properties given, resetting what they omit.'
parameters:
- name: environment_key
in: path
required: true
schema:
type: string
- name: feature_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFlagRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateFlagRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/UpdateFlagRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFlagResponse'
security:
- tokenAuth: []
- Master API Key: []
tags:
- experimental
patch:
operationId: api___future___environments_features_partial_update
description: 'Update the properties given, leaving the rest as they are.'
parameters:
- name: environment_key
in: path
required: true
schema:
type: string
- name: feature_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedUpdateFlagRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedUpdateFlagRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedUpdateFlagRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFlagResponse'
security:
- tokenAuth: []
- Master API Key: []
tags:
- experimental
'/api/__future__/environments/{environment_key}/features/{feature_id}/segment-overrides/{segment_id}/':
delete:
operationId: api___future___environments_features_segment_overrides_destroy
description: 'Remove the flag''s override for the segment, leaving the rest of the flag as it is.'
parameters:
- name: environment_key
in: path
required: true
schema:
type: string
- name: feature_id
in: path
required: true
schema:
type: integer
- name: segment_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFlagResponse'
security:
- tokenAuth: []
- Master API Key: []
tags:
- experimental
/api/v1/admin/dashboard/integrations/:
get:
operationId: api_v1_admin_dashboard_integrations_retrieve
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
/api/v1/admin/dashboard/organisations/:
get:
operationId: api_v1_admin_dashboard_organisations_retrieve
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Admin dashboard
/api/v1/admin/dashboard/release-pipelines/:
get:
operationId: api_v1_admin_dashboard_release_pipelines_retrieve
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Admin dashboard
/api/v1/admin/dashboard/stale-flags/:
get:
operationId: api_v1_admin_dashboard_stale_flags_retrieve
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Admin dashboard
/api/v1/admin/dashboard/summary/:
get:
operationId: api_v1_admin_dashboard_summary_retrieve
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Admin dashboard
/api/v1/admin/dashboard/usage-trends/:
get:
operationId: api_v1_admin_dashboard_usage_trends_retrieve
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Admin dashboard
/api/v1/analytics/flags/:
post:
operationId: api_v1_analytics_flags_create
description: Class to handle flag analytics events
responses:
'201':
description: No response body
security:
- Environment API Key: []
tags:
- Analytics
/api/v1/analytics/telemetry/:
post:
operationId: api_v1_analytics_telemetry_create
description: |-
Class to handle telemetry events from self hosted APIs so we can aggregate and track
self hosted installation data
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Telemetry'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Telemetry'
multipart/form-data:
schema:
$ref: '#/components/schemas/Telemetry'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Telemetry'
tags:
- Analytics
/api/v1/audit/:
get:
operationId: api_v1_audit_list
parameters:
- name: environments
in: query
schema:
type: array
items:
type: integer
minimum: 0
- name: is_system_event
in: query
schema:
type:
- boolean
- 'null'
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
schema:
type: integer
- name: project
in: query
schema:
type: integer
- name: search
in: query
schema:
type: string
maxLength: 256
minLength: 3
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAuditLogListList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Audit
'/api/v1/audit/{id}/':
get:
operationId: api_v1_audit_retrieve
parameters:
- name: id
in: path
description: A unique integer value identifying this audit log.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AuditLogRetrieve'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Audit
'/api/v1/auth/{method}/activate/':
post:
operationId: api_v1_auth_activate_create
parameters:
- name: method
in: path
required: true
schema:
type: string
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
'/api/v1/auth/{method}/activate/confirm/':
post:
operationId: api_v1_auth_activate_confirm_create
parameters:
- name: method
in: path
required: true
schema:
type: string
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
'/api/v1/auth/{method}/deactivate/':
post:
operationId: api_v1_auth_deactivate_create
parameters:
- name: method
in: path
required: true
schema:
type: string
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
/api/v1/auth/login/:
post:
operationId: api_v1_auth_login_create
description: Class to handle throttling for login requests
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomTokenCreate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CustomTokenCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/CustomTokenCreate'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomTokenCreate'
tags:
- Authentication
/api/v1/auth/login/code/:
post:
operationId: api_v1_auth_login_code_create
description: Override class to add throttling
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomTokenCreate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CustomTokenCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/CustomTokenCreate'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomTokenCreate'
tags:
- Authentication
/api/v1/auth/logout/:
post:
operationId: api_v1_auth_logout_create
description: Use this endpoint to logout user (remove user authentication token).
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
/api/v1/auth/mfa/user-active-methods/:
get:
operationId: api_v1_auth_mfa_user_active_methods_retrieve
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
/api/v1/auth/oauth/github/:
post:
operationId: api_v1_auth_oauth_github_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GithubLogin'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/GithubLogin'
multipart/form-data:
schema:
$ref: '#/components/schemas/GithubLogin'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthToken'
'502':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- tokenAuth: []
- Master API Key: []
- {}
tags:
- Authentication
/api/v1/auth/oauth/google/:
post:
operationId: api_v1_auth_oauth_google_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleLogin'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/GoogleLogin'
multipart/form-data:
schema:
$ref: '#/components/schemas/GoogleLogin'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthToken'
'502':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- tokenAuth: []
- Master API Key: []
- {}
tags:
- Authentication
/api/v1/auth/oidc/token/:
post:
operationId: oidc_token_exchange
description: Exchange an OIDC token issued by a trusted identity provider for a short-lived Flagsmith access token.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TokenExchangeRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TokenExchangeRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/TokenExchangeRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/TokenExchangeResponse'
'400':
description: Request body is invalid.
'401':
description: 'Token validation failed, or no trust relationship matches the token.'
security:
- {}
tags:
- Authentication
'/api/v1/auth/saml/{name}/metadata/':
get:
operationId: api_v1_auth_saml_metadata_retrieve
parameters:
- name: format
in: query
schema:
type: string
enum:
- json
- xml
- name: name
in: path
required: true
schema:
type: string
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
- {}
tags:
- Metadata
'/api/v1/auth/saml/{name}/request/':
post:
operationId: api_v1_auth_saml_request_create
parameters:
- name: format
in: query
schema:
type: string
enum:
- html
- json
- name: name
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SamlRequest'
text/html:
schema:
$ref: '#/components/schemas/SamlRequest'
security:
- tokenAuth: []
- Master API Key: []
- {}
tags:
- Authentication
'/api/v1/auth/saml/{name}/response/':
post:
operationId: api_v1_auth_saml_response_create
parameters:
- name: format
in: query
schema:
type: string
enum:
- html
- json
- name: name
in: path
required: true
schema:
type: string
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
- {}
tags:
- Authentication
/api/v1/auth/saml/attribute-mapping/:
get:
operationId: api_v1_auth_saml_attribute_mapping_list
parameters:
- name: organisation
in: query
schema:
type: integer
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
- name: saml_configuration
in: query
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedSamlAttributeMappingList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
post:
operationId: api_v1_auth_saml_attribute_mapping_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SamlAttributeMapping'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SamlAttributeMapping'
multipart/form-data:
schema:
$ref: '#/components/schemas/SamlAttributeMapping'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SamlAttributeMapping'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
'/api/v1/auth/saml/attribute-mapping/{id}/':
get:
operationId: api_v1_auth_saml_attribute_mapping_retrieve
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SamlAttributeMapping'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
put:
operationId: api_v1_auth_saml_attribute_mapping_update
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SamlAttributeMapping'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SamlAttributeMapping'
multipart/form-data:
schema:
$ref: '#/components/schemas/SamlAttributeMapping'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SamlAttributeMapping'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
patch:
operationId: api_v1_auth_saml_attribute_mapping_partial_update
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedSamlAttributeMapping'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedSamlAttributeMapping'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedSamlAttributeMapping'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SamlAttributeMapping'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
delete:
operationId: api_v1_auth_saml_attribute_mapping_destroy
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
/api/v1/auth/saml/configuration/:
get:
operationId: api_v1_auth_saml_configuration_list
parameters:
- name: organisation
in: query
required: true
schema:
type: integer
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedSamlConfigurationList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
x-flagsmith-minimum-plan: SCALE_UP
post:
operationId: api_v1_auth_saml_configuration_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SamlConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SamlConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/SamlConfiguration'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SamlConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
x-flagsmith-minimum-plan: SCALE_UP
'/api/v1/auth/saml/configuration/{name}/':
get:
operationId: api_v1_auth_saml_configuration_retrieve
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SamlConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
x-flagsmith-minimum-plan: SCALE_UP
put:
operationId: api_v1_auth_saml_configuration_update
parameters:
- name: name
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SamlConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SamlConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/SamlConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SamlConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
x-flagsmith-minimum-plan: SCALE_UP
patch:
operationId: api_v1_auth_saml_configuration_partial_update
parameters:
- name: name
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedSamlConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedSamlConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedSamlConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SamlConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
x-flagsmith-minimum-plan: SCALE_UP
delete:
operationId: api_v1_auth_saml_configuration_destroy
parameters:
- name: name
in: path
required: true
schema:
type: string
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
x-flagsmith-minimum-plan: SCALE_UP
/api/v1/auth/saml/login/:
post:
operationId: api_v1_auth_saml_login_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SamlLogin'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SamlLogin'
multipart/form-data:
schema:
$ref: '#/components/schemas/SamlLogin'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SamlUserToken'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- {}
tags:
- Authentication
/api/v1/auth/token/:
delete:
operationId: api_v1_auth_token_destroy
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
/api/v1/auth/users/:
get:
operationId: api_v1_auth_users_list
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedUserList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
post:
operationId: api_v1_auth_users_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomUserCreate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CustomUserCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/CustomUserCreate'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomUserCreate'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
'/api/v1/auth/users/{id}/':
get:
operationId: api_v1_auth_users_retrieve
parameters:
- name: id
in: path
description: A unique integer value identifying this Feature flag admin user.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/User'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
put:
operationId: api_v1_auth_users_update
parameters:
- name: id
in: path
description: A unique integer value identifying this Feature flag admin user.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/User'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/User'
multipart/form-data:
schema:
$ref: '#/components/schemas/User'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/User'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
patch:
operationId: api_v1_auth_users_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this Feature flag admin user.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedUser'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedUser'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedUser'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/User'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
delete:
operationId: api_v1_auth_users_destroy
parameters:
- name: current_password
in: query
schema:
type:
- string
- 'null'
- name: delete_orphan_organisations
in: query
schema:
type: boolean
default: false
- name: id
in: path
description: A unique integer value identifying this Feature flag admin user.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
/api/v1/auth/users/activation/:
post:
operationId: api_v1_auth_users_activation_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Activation'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Activation'
multipart/form-data:
schema:
$ref: '#/components/schemas/Activation'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Activation'
security:
- tokenAuth: []
- Master API Key: []
- {}
tags:
- Authentication
/api/v1/auth/users/me/:
get:
operationId: api_v1_auth_users_me_retrieve
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SamlCurrentUser'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
put:
operationId: api_v1_auth_users_me_update
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SamlCurrentUser'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SamlCurrentUser'
multipart/form-data:
schema:
$ref: '#/components/schemas/SamlCurrentUser'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SamlCurrentUser'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
patch:
operationId: api_v1_auth_users_me_partial_update
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedSamlCurrentUser'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedSamlCurrentUser'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedSamlCurrentUser'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SamlCurrentUser'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
delete:
operationId: api_v1_auth_users_me_destroy
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
/api/v1/auth/users/me/hubspot-chat-token/:
get:
operationId: api_v1_auth_users_me_hubspot_chat_token_retrieve
description: Return a token that identifies the user to the HubSpot chat widget.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/HubspotChatTokenResponse'
'404':
description: No response body
'502':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
/api/v1/auth/users/me/onboarding/:
patch:
operationId: api_v1_auth_users_me_onboarding_partial_update
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedUser'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedUser'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedUser'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/User'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
/api/v1/auth/users/resend_activation/:
post:
operationId: api_v1_auth_users_resend_activation_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SendEmailReset'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SendEmailReset'
multipart/form-data:
schema:
$ref: '#/components/schemas/SendEmailReset'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SendEmailReset'
security:
- tokenAuth: []
- Master API Key: []
- {}
tags:
- Authentication
/api/v1/auth/users/reset_email/:
post:
operationId: api_v1_auth_users_reset_email_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SendEmailReset'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SendEmailReset'
multipart/form-data:
schema:
$ref: '#/components/schemas/SendEmailReset'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SendEmailReset'
security:
- tokenAuth: []
- Master API Key: []
- {}
tags:
- Authentication
/api/v1/auth/users/reset_email_confirm/:
post:
operationId: api_v1_auth_users_reset_email_confirm_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UsernameResetConfirm'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UsernameResetConfirm'
multipart/form-data:
schema:
$ref: '#/components/schemas/UsernameResetConfirm'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UsernameResetConfirm'
security:
- tokenAuth: []
- Master API Key: []
- {}
tags:
- Authentication
/api/v1/auth/users/reset_password/:
post:
operationId: api_v1_auth_users_reset_password_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SendEmailReset'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SendEmailReset'
multipart/form-data:
schema:
$ref: '#/components/schemas/SendEmailReset'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SendEmailReset'
security:
- tokenAuth: []
- Master API Key: []
- {}
tags:
- Authentication
/api/v1/auth/users/reset_password_confirm/:
post:
operationId: api_v1_auth_users_reset_password_confirm_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordResetConfirmRetype'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PasswordResetConfirmRetype'
multipart/form-data:
schema:
$ref: '#/components/schemas/PasswordResetConfirmRetype'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordResetConfirmRetype'
security:
- tokenAuth: []
- Master API Key: []
- {}
tags:
- Authentication
/api/v1/auth/users/set_email/:
post:
operationId: api_v1_auth_users_set_email_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SetUsername'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SetUsername'
multipart/form-data:
schema:
$ref: '#/components/schemas/SetUsername'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SetUsername'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
/api/v1/auth/users/set_password/:
post:
operationId: api_v1_auth_users_set_password_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SetPasswordRetype'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SetPasswordRetype'
multipart/form-data:
schema:
$ref: '#/components/schemas/SetPasswordRetype'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SetPasswordRetype'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Authentication
/api/v1/cb-webhook/:
post:
operationId: api_v1_cb_webhook_create
description: |-
Endpoint to handle webhooks from chargebee.
Payment failure and payment succeeded webhooks are filtered out and processed
to determine which of our subscriptions are in a dunning state.
The remaining webhooks are processed if they have subscription data:
- If subscription is active, check to see if plan has changed and update if so. Always update cancellation date to
None to ensure that if a subscription is reactivated, it is updated on our end.
- If subscription is cancelled or not renewing, update subscription on our end to include cancellation date and
send alert to admin users.
responses:
'200':
description: No response body
security:
- basicAuth: []
tags:
- Webhooks
/api/v1/cohort-sync/amplitude/lists/:
post:
operationId: api_v1_cohort_sync_amplitude_lists_create
description: Called by Amplitude once per cohort sync setup; creates the backing cohort and returns its identifier as the list ID.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AmplitudeList'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AmplitudeList'
multipart/form-data:
schema:
$ref: '#/components/schemas/AmplitudeList'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AmplitudeListResponse'
security:
- Cohort Sync Key: []
- Cohort Sync Key (Basic): []
tags:
- Other
x-flagsmith-minimum-plan: START_UP
'/api/v1/cohort-sync/amplitude/lists/{id}/add/':
post:
operationId: api_v1_cohort_sync_amplitude_lists_add_create
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CohortSyncMembers'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CohortSyncMembers'
multipart/form-data:
schema:
$ref: '#/components/schemas/CohortSyncMembers'
responses:
'200':
description: No response body
security:
- Cohort Sync Key: []
- Cohort Sync Key (Basic): []
tags:
- Other
x-flagsmith-minimum-plan: START_UP
'/api/v1/cohort-sync/amplitude/lists/{id}/remove/':
post:
operationId: api_v1_cohort_sync_amplitude_lists_remove_create
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CohortSyncMembers'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CohortSyncMembers'
multipart/form-data:
schema:
$ref: '#/components/schemas/CohortSyncMembers'
responses:
'200':
description: No response body
security:
- Cohort Sync Key: []
- Cohort Sync Key (Basic): []
tags:
- Other
x-flagsmith-minimum-plan: START_UP
/api/v1/cohort-sync/mixpanel/webhook/:
post:
operationId: api_v1_cohort_sync_mixpanel_webhook_create
description: Called by Mixpanel every sync cycle with the cohort's full membership (`members`) or the changes since the last sync (`add_members`/`remove_members`).
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MixpanelWebhook'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/MixpanelWebhook'
multipart/form-data:
schema:
$ref: '#/components/schemas/MixpanelWebhook'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MixpanelWebhookResponse'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MixpanelWebhookFailureResponse'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MixpanelWebhookFailureResponse'
security:
- Cohort Sync Key: []
- Cohort Sync Key (Basic): []
tags:
- Webhooks
x-flagsmith-minimum-plan: START_UP
'/api/v1/cohort-sync/webhook/cohorts/{id}/members/add/':
post:
operationId: api_v1_cohort_sync_webhook_cohorts_members_add_create
description: 'Add members to a CSV cohort. Accepted deltas are applied to identity data asynchronously. Re-adding a member is a no-op, so retries are safe.'
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookSyncMembers'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WebhookSyncMembers'
multipart/form-data:
schema:
$ref: '#/components/schemas/WebhookSyncMembers'
responses:
'200':
description: No response body
security:
- Cohort Sync Key: []
- Cohort Sync Key (Basic): []
tags:
- Webhooks
x-flagsmith-minimum-plan: START_UP
'/api/v1/cohort-sync/webhook/cohorts/{id}/members/remove/':
post:
operationId: api_v1_cohort_sync_webhook_cohorts_members_remove_create
description: 'Remove members from a CSV cohort. Accepted deltas are applied to identity data asynchronously. Removing a non-member is a no-op, so retries are safe.'
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookSyncMembers'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WebhookSyncMembers'
multipart/form-data:
schema:
$ref: '#/components/schemas/WebhookSyncMembers'
responses:
'200':
description: No response body
security:
- Cohort Sync Key: []
- Cohort Sync Key (Basic): []
tags:
- Webhooks
x-flagsmith-minimum-plan: START_UP
/api/v1/environment-document/:
get:
operationId: sdk_v1_environment_document
description: |-
Retrieve the environment document.
Used by SDKs in local evaluation mode, and Edge Proxy.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V1EnvironmentDocumentResponse'
security:
- Environment API Key: []
tags:
- sdk
'/api/v1/environment-feature-versions/{id}/':
get:
operationId: api_v1_environment_feature_versions_retrieve
description: |-
This is an additional endpoint to retrieve a specific version without needing
to provide the environment or feature as part of the URL.
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentFeatureVersionRetrieve'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Feature states
/api/v1/environments/:
get:
operationId: list_environments
description: Lists all environments the user has access to
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
- name: project
in: query
description: ID of the project to filter by.
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedEnvironmentSerializerWithMetadataList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
post:
operationId: api_v1_environments_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEnvironment'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateEnvironment'
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateEnvironment'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEnvironment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{api_key}/':
get:
operationId: api_v1_environments_retrieve
parameters:
- name: api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentRetrieveSerializerWithMetadata'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
put:
operationId: api_v1_environments_update
parameters:
- name: api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEnvironment'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/UpdateEnvironment'
multipart/form-data:
schema:
$ref: '#/components/schemas/UpdateEnvironment'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEnvironment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
patch:
operationId: api_v1_environments_partial_update
parameters:
- name: api_key
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedUpdateEnvironment'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedUpdateEnvironment'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedUpdateEnvironment'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEnvironment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
delete:
operationId: api_v1_environments_destroy
parameters:
- name: api_key
in: path
required: true
schema:
type: string
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{api_key}/clone/':
post:
operationId: api_v1_environments_clone_create
parameters:
- name: api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CloneEnvironment'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CloneEnvironment'
multipart/form-data:
schema:
$ref: '#/components/schemas/CloneEnvironment'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CloneEnvironment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{api_key}/delete-traits/':
post:
operationId: api_v1_environments_delete_traits_create
parameters:
- name: api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteAllTraitKeys'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DeleteAllTraitKeys'
multipart/form-data:
schema:
$ref: '#/components/schemas/DeleteAllTraitKeys'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteAllTraitKeys'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{api_key}/disable-v2-versioning/':
post:
operationId: api_v1_environments_disable_v2_versioning_create
parameters:
- name: api_key
in: path
required: true
schema:
type: string
responses:
'202':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{api_key}/document/':
get:
operationId: api_v1_environments_document_retrieve
parameters:
- name: api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V1EnvironmentDocumentResponse'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{api_key}/enable-v2-versioning/':
post:
operationId: api_v1_environments_enable_v2_versioning_create
parameters:
- name: api_key
in: path
required: true
schema:
type: string
responses:
'202':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{api_key}/my-permissions/':
get:
operationId: api_v1_environments_my_permissions_retrieve
parameters:
- name: api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UserObjectPermissions'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{api_key}/trait-keys/':
get:
operationId: api_v1_environments_trait_keys_retrieve
parameters:
- name: api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/TraitKeys'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{api_key}/user-detailed-permissions/{user_id}/':
get:
operationId: api_v1_environments_user_detailed_permissions_retrieve
parameters:
- name: api_key
in: path
required: true
schema:
type: string
- name: user_id
in: path
required: true
schema:
type: string
pattern: ^\d+$
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UserDetailedPermissions'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/api-keys/':
get:
operationId: api_v1_environments_api_keys_list
description: Manage server-side SDK keys for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EnvironmentAPIKey'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
post:
operationId: api_v1_environments_api_keys_create
description: Manage server-side SDK keys for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentAPIKey'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/EnvironmentAPIKey'
multipart/form-data:
schema:
$ref: '#/components/schemas/EnvironmentAPIKey'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentAPIKey'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/api-keys/{id}/':
put:
operationId: api_v1_environments_api_keys_update
description: Manage server-side SDK keys for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this environment api key.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentAPIKey'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/EnvironmentAPIKey'
multipart/form-data:
schema:
$ref: '#/components/schemas/EnvironmentAPIKey'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentAPIKey'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
patch:
operationId: api_v1_environments_api_keys_partial_update
description: Manage server-side SDK keys for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this environment api key.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedEnvironmentAPIKey'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedEnvironmentAPIKey'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedEnvironmentAPIKey'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentAPIKey'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
delete:
operationId: api_v1_environments_api_keys_destroy
description: Manage server-side SDK keys for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this environment api key.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/cohorts/':
get:
operationId: api_v1_environments_cohorts_list
description: List the environment's cohorts.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Cohort'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
x-flagsmith-minimum-plan: START_UP
post:
operationId: api_v1_environments_cohorts_create
description: Create a cohort and the managed segment that targets it.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Cohort'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Cohort'
multipart/form-data:
schema:
$ref: '#/components/schemas/Cohort'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Cohort'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
x-flagsmith-minimum-plan: START_UP
'/api/v1/environments/{environment_api_key}/cohorts/{cohort_id}/':
get:
operationId: api_v1_environments_cohorts_retrieve
description: Retrieve a cohort.
parameters:
- name: cohort_id
in: path
description: A unique integer value identifying this cohort.
required: true
schema:
type: integer
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Cohort'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
x-flagsmith-minimum-plan: START_UP
patch:
operationId: api_v1_environments_cohorts_partial_update
description: 'Update the cohort''s managed segment name, description and metadata.'
parameters:
- name: cohort_id
in: path
description: A unique integer value identifying this cohort.
required: true
schema:
type: integer
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedCohort'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedCohort'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedCohort'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Cohort'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
x-flagsmith-minimum-plan: START_UP
delete:
operationId: api_v1_environments_cohorts_destroy
description: Request cohort deletion. Memberships are drained from identity data first; the cohort and its segment are deleted once drained.
parameters:
- name: cohort_id
in: path
description: A unique integer value identifying this cohort.
required: true
schema:
type: integer
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'202':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
x-flagsmith-minimum-plan: START_UP
'/api/v1/environments/{environment_api_key}/cohorts/{cohort_id}/sync-csv/':
post:
operationId: api_v1_environments_cohorts_sync_csv_create
description: Replace the cohort's members with the identifiers found in the uploaded CSV file and trigger a sync to identity data. `identifier_column` is the 0-based index of the column holding the identifiers; `has_header` skips the first row when true.
parameters:
- name: cohort_id
in: path
description: A unique integer value identifying this cohort.
required: true
schema:
type: integer
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/CohortCsvSync'
responses:
'202':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CohortCsvSyncResult'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'413':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
x-flagsmith-minimum-plan: START_UP
'/api/v1/environments/{environment_api_key}/cohorts/sync-keys/':
get:
operationId: api_v1_environments_cohorts_sync_keys_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CohortSyncKey'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
x-flagsmith-minimum-plan: START_UP
post:
operationId: api_v1_environments_cohorts_sync_keys_create
description: Create a cohort sync key. The response is the only time the plaintext key is available.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CohortSyncKey'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CohortSyncKey'
multipart/form-data:
schema:
$ref: '#/components/schemas/CohortSyncKey'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CohortSyncKey'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
x-flagsmith-minimum-plan: START_UP
'/api/v1/environments/{environment_api_key}/cohorts/sync-keys/{prefix}/':
delete:
operationId: api_v1_environments_cohorts_sync_keys_destroy
description: Revoke a cohort sync key.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: prefix
in: path
required: true
schema:
type: string
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
x-flagsmith-minimum-plan: START_UP
'/api/v1/environments/{environment_api_key}/create-change-request/':
post:
operationId: create_environment_feature_change_request
description: Creates a new change request for feature flag modifications in an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeRequestCreate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ChangeRequestCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/ChangeRequestCreate'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeRequestCreate'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsError'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
'/api/v1/environments/{environment_api_key}/edge-identities/':
get:
operationId: api_v1_environments_edge_identities_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: last_evaluated_key
in: query
description: Used as the starting point for the page
required: false
schema:
type: string
- name: page_size
in: query
description: Number of results to return per page.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedEdgeIdentityList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
post:
operationId: api_v1_environments_edge_identities_create
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentity'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/EdgeIdentity'
multipart/form-data:
schema:
$ref: '#/components/schemas/EdgeIdentity'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentity'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/edge-identities/{edge_identity_identity_uuid}/edge-featurestates/':
get:
operationId: api_v1_environments_edge_identities_edge_featurestates_list
parameters:
- name: edge_identity_identity_uuid
in: path
required: true
schema:
type: string
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: feature
in: query
description: ID of the feature to filter by
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EdgeIdentityFeatureState'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
post:
operationId: api_v1_environments_edge_identities_edge_featurestates_create
parameters:
- name: edge_identity_identity_uuid
in: path
required: true
schema:
type: string
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentityFeatureState'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/EdgeIdentityFeatureState'
multipart/form-data:
schema:
$ref: '#/components/schemas/EdgeIdentityFeatureState'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentityFeatureState'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/edge-identities/{edge_identity_identity_uuid}/edge-featurestates/{featurestate_uuid}/':
get:
operationId: api_v1_environments_edge_identities_edge_featurestates_retrieve
parameters:
- name: edge_identity_identity_uuid
in: path
required: true
schema:
type: string
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: featurestate_uuid
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentityFeatureState'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
put:
operationId: api_v1_environments_edge_identities_edge_featurestates_update
parameters:
- name: edge_identity_identity_uuid
in: path
required: true
schema:
type: string
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: featurestate_uuid
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentityFeatureState'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/EdgeIdentityFeatureState'
multipart/form-data:
schema:
$ref: '#/components/schemas/EdgeIdentityFeatureState'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentityFeatureState'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
delete:
operationId: api_v1_environments_edge_identities_edge_featurestates_destroy
parameters:
- name: edge_identity_identity_uuid
in: path
required: true
schema:
type: string
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: featurestate_uuid
in: path
required: true
schema:
type: string
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/edge-identities/{edge_identity_identity_uuid}/edge-featurestates/all/':
get:
operationId: api_v1_environments_edge_identities_edge_featurestates_all_list
parameters:
- name: edge_identity_identity_uuid
in: path
required: true
schema:
type: string
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IdentityAllFeatureStates'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/edge-identities/{edge_identity_identity_uuid}/edge-featurestates/clone-from-given-identity/':
post:
operationId: api_v1_environments_edge_identities_edge_featurestates_clone_from_given_identity_create
description: Clone feature states from a given source identity.
parameters:
- name: edge_identity_identity_uuid
in: path
required: true
schema:
type: string
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentitySourceIdentityRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/EdgeIdentitySourceIdentityRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/EdgeIdentitySourceIdentityRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IdentityAllFeatureStates'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/edge-identities/{identity_uuid}/':
get:
operationId: api_v1_environments_edge_identities_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: identity_uuid
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentity'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
put:
operationId: api_v1_environments_edge_identities_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: identity_uuid
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentityUpdate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/EdgeIdentityUpdate'
multipart/form-data:
schema:
$ref: '#/components/schemas/EdgeIdentityUpdate'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentityUpdate'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
patch:
operationId: api_v1_environments_edge_identities_partial_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: identity_uuid
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedEdgeIdentityUpdate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedEdgeIdentityUpdate'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedEdgeIdentityUpdate'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentityUpdate'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
delete:
operationId: api_v1_environments_edge_identities_destroy
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: identity_uuid
in: path
required: true
schema:
type: string
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/edge-identities/{identity_uuid}/list-traits/':
get:
operationId: api_v1_environments_edge_identities_list_traits_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: identity_uuid
in: path
required: true
schema:
type: string
- name: last_evaluated_key
in: query
description: Used as the starting point for the page
required: false
schema:
type: string
- name: page_size
in: query
description: Number of results to return per page.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedEdgeIdentityTraitsList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/edge-identities/{identity_uuid}/update-traits/':
put:
operationId: api_v1_environments_edge_identities_update_traits_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: identity_uuid
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentityTraits'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/EdgeIdentityTraits'
multipart/form-data:
schema:
$ref: '#/components/schemas/EdgeIdentityTraits'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentityTraits'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/edge-identity-overrides':
get:
operationId: api_v1_environments_edge_identity_overrides_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: feature
in: query
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GetEdgeIdentityOverrides'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/experiment-metrics/':
get:
operationId: list_metrics
description: (Beta) Lists experiment metrics for an environment. Supports search by name via the q parameter.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
schema:
type: integer
- name: q
in: query
description: Search metrics by name.
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedMetricList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
post:
operationId: create_metric
description: '(Beta) Creates a metric with name, description, aggregation type, expected direction, and event definition.'
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Metric'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Metric'
multipart/form-data:
schema:
$ref: '#/components/schemas/Metric'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Metric'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
'/api/v1/environments/{environment_api_key}/experiment-metrics/{id}/':
get:
operationId: get_metric
description: '(Beta) Retrieves details of a specific metric, including which experiments use it.'
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this metric.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Metric'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
put:
operationId: update_metric
description: (Beta) Updates a metric's properties.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this metric.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Metric'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Metric'
multipart/form-data:
schema:
$ref: '#/components/schemas/Metric'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Metric'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
patch:
operationId: api_v1_environments_experiment_metrics_partial_update
description: Manage experiment metrics for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this metric.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedMetric'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedMetric'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedMetric'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Metric'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
delete:
operationId: api_v1_environments_experiment_metrics_destroy
description: Manage experiment metrics for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this metric.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/experiments/':
get:
operationId: list_experiments
description: (Beta) Lists experiments for an environment. Supports filtering by status and searching by experiment or feature name.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
schema:
type: integer
- name: q
in: query
description: Search by experiment or feature name.
schema:
type: string
- name: status
in: query
description: 'Filter by experiment status (DRAFT, RUNNING, PAUSED, COMPLETED).'
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedExperimentListList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
post:
operationId: create_experiment
description: (Beta) Creates an experiment for a multivariate feature. Metrics can be attached inline. Only one active experiment per feature is allowed.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Experiment'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Experiment'
multipart/form-data:
schema:
$ref: '#/components/schemas/Experiment'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Experiment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
'/api/v1/environments/{environment_api_key}/experiments/{experiment_experiment_id}/metrics/':
get:
operationId: api_v1_environments_experiments_metrics_list
description: Manage metrics for an experiment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_experiment_id
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExperimentMetric'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
post:
operationId: api_v1_environments_experiments_metrics_create
description: Manage metrics for an experiment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_experiment_id
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentMetric'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ExperimentMetric'
multipart/form-data:
schema:
$ref: '#/components/schemas/ExperimentMetric'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentMetric'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/experiments/{experiment_experiment_id}/metrics/{id}/':
get:
operationId: api_v1_environments_experiments_metrics_retrieve
description: Manage metrics for an experiment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_experiment_id
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentMetric'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
put:
operationId: api_v1_environments_experiments_metrics_update
description: Manage metrics for an experiment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_experiment_id
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentMetric'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ExperimentMetric'
multipart/form-data:
schema:
$ref: '#/components/schemas/ExperimentMetric'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentMetric'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
patch:
operationId: api_v1_environments_experiments_metrics_partial_update
description: Manage metrics for an experiment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_experiment_id
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedExperimentMetric'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedExperimentMetric'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedExperimentMetric'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentMetric'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
delete:
operationId: api_v1_environments_experiments_metrics_destroy
description: Manage metrics for an experiment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_experiment_id
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/experiments/{experiment_id}/':
get:
operationId: get_experiment
description: '(Beta) Retrieves experiment details including feature configuration, attached metrics, and rollout state.'
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_id
in: path
description: A unique integer value identifying this experiment.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentDetail'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
put:
operationId: update_experiment
description: (Beta) Updates an experiment's name or its hypothesis.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_id
in: path
description: A unique integer value identifying this experiment.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Experiment'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Experiment'
multipart/form-data:
schema:
$ref: '#/components/schemas/Experiment'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Experiment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
patch:
operationId: api_v1_environments_experiments_partial_update
description: Manage experiments for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_id
in: path
description: A unique integer value identifying this experiment.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedExperiment'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedExperiment'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedExperiment'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Experiment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
delete:
operationId: api_v1_environments_experiments_destroy
description: Manage experiments for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_id
in: path
description: A unique integer value identifying this experiment.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/experiments/{experiment_id}/complete/':
post:
operationId: api_v1_environments_experiments_complete_create
description: Manage experiments for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_id
in: path
description: A unique integer value identifying this experiment.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentList'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ExperimentList'
multipart/form-data:
schema:
$ref: '#/components/schemas/ExperimentList'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/experiments/{experiment_id}/exposures/':
get:
operationId: get_experiment_exposures
description: (Beta) Retrieves variant exposure counts for an experiment. Returns null if not yet computed.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_id
in: path
description: A unique integer value identifying this experiment.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Experiment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
'/api/v1/environments/{environment_api_key}/experiments/{experiment_id}/exposures/refresh/':
post:
operationId: api_v1_environments_experiments_exposures_refresh_create
description: Manage experiments for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_id
in: path
description: A unique integer value identifying this experiment.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Experiment'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Experiment'
multipart/form-data:
schema:
$ref: '#/components/schemas/Experiment'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Experiment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/experiments/{experiment_id}/pause/':
post:
operationId: api_v1_environments_experiments_pause_create
description: Manage experiments for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_id
in: path
description: A unique integer value identifying this experiment.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentList'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ExperimentList'
multipart/form-data:
schema:
$ref: '#/components/schemas/ExperimentList'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/experiments/{experiment_id}/results/':
get:
operationId: get_experiment_results
description: (Beta) Retrieves statistical results for an experiment's metrics. Returns null if not yet computed.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_id
in: path
description: A unique integer value identifying this experiment.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Experiment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
'/api/v1/environments/{environment_api_key}/experiments/{experiment_id}/results/refresh/':
post:
operationId: api_v1_environments_experiments_results_refresh_create
description: Manage experiments for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_id
in: path
description: A unique integer value identifying this experiment.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Experiment'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Experiment'
multipart/form-data:
schema:
$ref: '#/components/schemas/Experiment'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Experiment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/experiments/{experiment_id}/rollout/':
patch:
operationId: api_v1_environments_experiments_rollout_partial_update
description: 'Sets an experiment''s rollout: the percentage of eligible identities enrolled, the variant weights they are split across, and optionally the targeted audience. The audience can only be changed before the experiment starts serving traffic.'
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_id
in: path
description: A unique integer value identifying this experiment.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedExperimentRollout'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedExperimentRollout'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedExperimentRollout'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/experiments/{experiment_id}/start/':
post:
operationId: api_v1_environments_experiments_start_create
description: Manage experiments for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: experiment_id
in: path
description: A unique integer value identifying this experiment.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentList'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ExperimentList'
multipart/form-data:
schema:
$ref: '#/components/schemas/ExperimentList'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/experiments/results/':
get:
operationId: api_v1_environments_experiments_results_retrieve
description: |-
Get experiment results for a feature.
Returns conversion rates and statistical significance for each variant
of a feature flag experiment.
Trait naming convention:
- Variant tracking: `exp_{feature}_variant` (string value)
- Conversion tracking: `exp_{feature}_converted` (boolean value)
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: feature
in: query
description: Feature name to analyse
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentResults'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/features/{feature_id}/dependencies/':
get:
operationId: api_v1_environments_features_dependencies_retrieve
description: List the features the feature depends on in the environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: feature_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DependencyList'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorDetail'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
'/api/v1/environments/{environment_api_key}/features/{feature_id}/dependencies/{prerequisite_feature_id}/':
post:
operationId: api_v1_environments_features_dependencies_create
description: Make the feature depend on the prerequisite feature being enabled.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: feature_id
in: path
required: true
schema:
type: integer
- name: prerequisite_feature_id
in: path
required: true
schema:
type: integer
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DependencyEdge'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DependencyRefusedDetail'
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorDetail'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
delete:
operationId: api_v1_environments_features_dependencies_destroy
description: Stop the feature depending on the prerequisite feature.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: feature_id
in: path
required: true
schema:
type: integer
- name: prerequisite_feature_id
in: path
required: true
schema:
type: integer
responses:
'204':
description: No response body
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorDetail'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorDetail'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
'/api/v1/environments/{environment_api_key}/features/{feature_id}/dependents/':
get:
operationId: api_v1_environments_features_dependents_retrieve
description: List the features depending on the feature in the environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: feature_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DependencyList'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorDetail'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
'/api/v1/environments/{environment_api_key}/features/{feature_pk}/create-segment-override/':
post:
operationId: create_segment_override
description: 'Creates a segment override for a feature in an environment in a single call, setting both the segment binding and its value. Applies to environments without v2 feature versioning (use_v2_feature_versioning: false).'
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: feature_pk
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomCreateSegmentOverrideFeatureState'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CustomCreateSegmentOverrideFeatureState'
multipart/form-data:
schema:
$ref: '#/components/schemas/CustomCreateSegmentOverrideFeatureState'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomCreateSegmentOverrideFeatureState'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
'/api/v1/environments/{environment_api_key}/featurestates/':
get:
operationId: api_v1_environments_featurestates_list
description: |-
View set to manage feature states. Nested beneath environments and environments + identities
to allow for filtering on both.
parameters:
- name: anyIdentity
in: query
description: Pass any value to get results that have an identity override. Do not pass for default behaviour.
schema:
type: string
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: feature
in: query
description: ID of the feature to filter by.
schema:
type: integer
- name: feature_name
in: query
description: Name of the feature to filter by.
schema:
type: string
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedFeatureStateSerializerWithIdentityList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Feature states
post:
operationId: api_v1_environments_featurestates_create
description: |-
DEPRECATED: please use `/features/featurestates/` instead.
Override create method to add environment and identity (if present) from URL parameters.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
multipart/form-data:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Feature states
'/api/v1/environments/{environment_api_key}/featurestates/{id}/':
get:
operationId: api_v1_environments_featurestates_retrieve
description: |-
View set to manage feature states. Nested beneath environments and environments + identities
to allow for filtering on both.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this feature state.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Feature states
put:
operationId: update_environment_feature_state
description: 'Updates a feature state in an environment, including enabled status and value. Applies to environments without v2 feature versioning (use_v2_feature_versioning: false).'
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this feature state.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
multipart/form-data:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
patch:
operationId: api_v1_environments_featurestates_partial_update
description: Override partial_update as overridden update method assumes partial True for all requests.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this feature state.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedFeatureStateSerializerCreate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedFeatureStateSerializerCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedFeatureStateSerializerCreate'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureStateSerializerCreate'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Feature states
delete:
operationId: api_v1_environments_featurestates_destroy
description: |-
View set to manage feature states. Nested beneath environments and environments + identities
to allow for filtering on both.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this feature state.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Feature states
'/api/v1/environments/{environment_api_key}/identities/':
get:
operationId: api_v1_environments_identities_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedIdentityList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
post:
operationId: api_v1_environments_identities_create
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Identity'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Identity'
multipart/form-data:
schema:
$ref: '#/components/schemas/Identity'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Identity'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/identities/{identity_pk}/featurestates/':
get:
operationId: api_v1_environments_identities_featurestates_list
description: |-
View set to manage feature states. Nested beneath environments and environments + identities
to allow for filtering on both.
parameters:
- name: anyIdentity
in: query
description: Pass any value to get results that have an identity override. Do not pass for default behaviour.
schema:
type: string
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: feature
in: query
description: ID of the feature to filter by.
schema:
type: integer
- name: feature_name
in: query
description: Name of the feature to filter by.
schema:
type: string
- name: identity_pk
in: path
required: true
schema:
type:
- integer
- 'null'
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedFeatureStateSerializerWithIdentityList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
post:
operationId: api_v1_environments_identities_featurestates_create
description: |-
DEPRECATED: please use `/features/featurestates/` instead.
Override create method to add environment and identity (if present) from URL parameters.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: identity_pk
in: path
required: true
schema:
type:
- integer
- 'null'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
multipart/form-data:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/identities/{identity_pk}/featurestates/{id}/':
get:
operationId: api_v1_environments_identities_featurestates_retrieve
description: |-
View set to manage feature states. Nested beneath environments and environments + identities
to allow for filtering on both.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this feature state.
required: true
schema:
type: integer
- name: identity_pk
in: path
required: true
schema:
type:
- integer
- 'null'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
put:
operationId: api_v1_environments_identities_featurestates_update
description: |-
Override update method to always assume update request is partial and create / update
feature state value.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this feature state.
required: true
schema:
type: integer
- name: identity_pk
in: path
required: true
schema:
type:
- integer
- 'null'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
multipart/form-data:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureStateSerializerBasic'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
patch:
operationId: api_v1_environments_identities_featurestates_partial_update
description: Override partial_update as overridden update method assumes partial True for all requests.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this feature state.
required: true
schema:
type: integer
- name: identity_pk
in: path
required: true
schema:
type:
- integer
- 'null'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedFeatureStateSerializerCreate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedFeatureStateSerializerCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedFeatureStateSerializerCreate'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureStateSerializerCreate'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
delete:
operationId: api_v1_environments_identities_featurestates_destroy
description: |-
View set to manage feature states. Nested beneath environments and environments + identities
to allow for filtering on both.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this feature state.
required: true
schema:
type: integer
- name: identity_pk
in: path
required: true
schema:
type:
- integer
- 'null'
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/identities/{identity_pk}/featurestates/all/':
get:
operationId: api_v1_environments_identities_featurestates_all_retrieve
description: |-
View set to manage feature states. Nested beneath environments and environments + identities
to allow for filtering on both.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: identity_pk
in: path
required: true
schema:
type:
- integer
- 'null'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureStateSerializerCreate'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/identities/{identity_pk}/featurestates/clone-from-given-identity/':
post:
operationId: api_v1_environments_identities_featurestates_clone_from_given_identity_create
description: Clone feature states from a given source identity.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: identity_pk
in: path
required: true
schema:
type:
- integer
- 'null'
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IdentitySourceIdentityRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/IdentitySourceIdentityRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/IdentitySourceIdentityRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedIdentityAllFeatureStatesList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/identities/{identity_pk}/traits/':
get:
operationId: api_v1_environments_identities_traits_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: identity_pk
in: path
required: true
schema:
type: integer
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedTraitList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
post:
operationId: api_v1_environments_identities_traits_create
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: identity_pk
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Trait'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Trait'
multipart/form-data:
schema:
$ref: '#/components/schemas/Trait'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Trait'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/identities/{identity_pk}/traits/{id}/':
get:
operationId: api_v1_environments_identities_traits_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this trait.
required: true
schema:
type: integer
- name: identity_pk
in: path
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Trait'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
put:
operationId: api_v1_environments_identities_traits_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this trait.
required: true
schema:
type: integer
- name: identity_pk
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Trait'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Trait'
multipart/form-data:
schema:
$ref: '#/components/schemas/Trait'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Trait'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
patch:
operationId: api_v1_environments_identities_traits_partial_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this trait.
required: true
schema:
type: integer
- name: identity_pk
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedTrait'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedTrait'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedTrait'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Trait'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
delete:
operationId: api_v1_environments_identities_traits_destroy
parameters:
- name: deleteAllMatchingTraits
in: query
description: Deletes all traits in this environment matching the key of the deleted trait
schema:
type: boolean
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this trait.
required: true
schema:
type: integer
- name: identity_pk
in: path
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/identities/{id}/':
get:
operationId: api_v1_environments_identities_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this identity.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Identity'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
put:
operationId: api_v1_environments_identities_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this identity.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Identity'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Identity'
multipart/form-data:
schema:
$ref: '#/components/schemas/Identity'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Identity'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
patch:
operationId: api_v1_environments_identities_partial_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this identity.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedIdentity'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedIdentity'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedIdentity'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Identity'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
delete:
operationId: api_v1_environments_identities_destroy
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this identity.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/{environment_api_key}/integrations/amplitude/':
get:
operationId: api_v1_environments_integrations_amplitude_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AmplitudeConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
post:
operationId: api_v1_environments_integrations_amplitude_create
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AmplitudeConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AmplitudeConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/AmplitudeConfiguration'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AmplitudeConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/amplitude/{id}/':
get:
operationId: api_v1_environments_integrations_amplitude_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this amplitude configuration.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AmplitudeConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
put:
operationId: api_v1_environments_integrations_amplitude_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this amplitude configuration.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AmplitudeConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AmplitudeConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/AmplitudeConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AmplitudeConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
patch:
operationId: api_v1_environments_integrations_amplitude_partial_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this amplitude configuration.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedAmplitudeConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedAmplitudeConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedAmplitudeConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AmplitudeConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
delete:
operationId: api_v1_environments_integrations_amplitude_destroy
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this amplitude configuration.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/dynatrace/':
get:
operationId: api_v1_environments_integrations_dynatrace_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DynatraceConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
post:
operationId: api_v1_environments_integrations_dynatrace_create
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DynatraceConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DynatraceConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/DynatraceConfiguration'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DynatraceConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/dynatrace/{id}/':
get:
operationId: api_v1_environments_integrations_dynatrace_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this dynatrace configuration.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DynatraceConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
put:
operationId: api_v1_environments_integrations_dynatrace_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this dynatrace configuration.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DynatraceConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DynatraceConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/DynatraceConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DynatraceConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
patch:
operationId: api_v1_environments_integrations_dynatrace_partial_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this dynatrace configuration.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedDynatraceConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedDynatraceConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedDynatraceConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DynatraceConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
delete:
operationId: api_v1_environments_integrations_dynatrace_destroy
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this dynatrace configuration.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/grafana/':
get:
operationId: api_v1_environments_integrations_grafana_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GrafanaProjectConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
post:
operationId: api_v1_environments_integrations_grafana_create
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GrafanaProjectConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/GrafanaProjectConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/GrafanaProjectConfiguration'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GrafanaProjectConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/grafana/{id}/':
get:
operationId: api_v1_environments_integrations_grafana_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this grafana project configuration.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GrafanaProjectConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
put:
operationId: api_v1_environments_integrations_grafana_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this grafana project configuration.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GrafanaProjectConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/GrafanaProjectConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/GrafanaProjectConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GrafanaProjectConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
patch:
operationId: api_v1_environments_integrations_grafana_partial_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this grafana project configuration.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedGrafanaProjectConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedGrafanaProjectConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedGrafanaProjectConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GrafanaProjectConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
delete:
operationId: api_v1_environments_integrations_grafana_destroy
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this grafana project configuration.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/heap/':
get:
operationId: api_v1_environments_integrations_heap_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/HeapConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
post:
operationId: api_v1_environments_integrations_heap_create
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/HeapConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/HeapConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/HeapConfiguration'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/HeapConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/heap/{id}/':
get:
operationId: api_v1_environments_integrations_heap_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this heap configuration.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/HeapConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
put:
operationId: api_v1_environments_integrations_heap_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this heap configuration.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/HeapConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/HeapConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/HeapConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/HeapConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
patch:
operationId: api_v1_environments_integrations_heap_partial_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this heap configuration.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedHeapConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedHeapConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedHeapConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/HeapConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
delete:
operationId: api_v1_environments_integrations_heap_destroy
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this heap configuration.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/mixpanel/':
get:
operationId: api_v1_environments_integrations_mixpanel_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MixpanelConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
post:
operationId: api_v1_environments_integrations_mixpanel_create
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MixpanelConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/MixpanelConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/MixpanelConfiguration'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MixpanelConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/mixpanel/{id}/':
get:
operationId: api_v1_environments_integrations_mixpanel_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this mixpanel configuration.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MixpanelConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
put:
operationId: api_v1_environments_integrations_mixpanel_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this mixpanel configuration.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MixpanelConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/MixpanelConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/MixpanelConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MixpanelConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
patch:
operationId: api_v1_environments_integrations_mixpanel_partial_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this mixpanel configuration.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedMixpanelConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedMixpanelConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedMixpanelConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MixpanelConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
delete:
operationId: api_v1_environments_integrations_mixpanel_destroy
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this mixpanel configuration.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/rudderstack/':
get:
operationId: api_v1_environments_integrations_rudderstack_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RudderstackConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
post:
operationId: api_v1_environments_integrations_rudderstack_create
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RudderstackConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/RudderstackConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/RudderstackConfiguration'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RudderstackConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/rudderstack/{id}/':
get:
operationId: api_v1_environments_integrations_rudderstack_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this rudderstack configuration.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RudderstackConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
put:
operationId: api_v1_environments_integrations_rudderstack_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this rudderstack configuration.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RudderstackConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/RudderstackConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/RudderstackConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RudderstackConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
patch:
operationId: api_v1_environments_integrations_rudderstack_partial_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this rudderstack configuration.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedRudderstackConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedRudderstackConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedRudderstackConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RudderstackConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
delete:
operationId: api_v1_environments_integrations_rudderstack_destroy
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this rudderstack configuration.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/segment/':
get:
operationId: api_v1_environments_integrations_segment_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SegmentConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
post:
operationId: api_v1_environments_integrations_segment_create
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SegmentConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SegmentConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/SegmentConfiguration'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SegmentConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/segment/{id}/':
get:
operationId: api_v1_environments_integrations_segment_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this segment configuration.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SegmentConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
put:
operationId: api_v1_environments_integrations_segment_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this segment configuration.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SegmentConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SegmentConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/SegmentConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SegmentConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
patch:
operationId: api_v1_environments_integrations_segment_partial_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this segment configuration.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedSegmentConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedSegmentConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedSegmentConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SegmentConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
delete:
operationId: api_v1_environments_integrations_segment_destroy
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this segment configuration.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/sentry/':
get:
operationId: api_v1_environments_integrations_sentry_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SentryChangeTrackingConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
post:
operationId: api_v1_environments_integrations_sentry_create
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SentryChangeTrackingConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SentryChangeTrackingConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/SentryChangeTrackingConfiguration'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SentryChangeTrackingConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/sentry/{id}/':
get:
operationId: api_v1_environments_integrations_sentry_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this sentry change tracking configuration.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SentryChangeTrackingConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
put:
operationId: api_v1_environments_integrations_sentry_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this sentry change tracking configuration.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SentryChangeTrackingConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SentryChangeTrackingConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/SentryChangeTrackingConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SentryChangeTrackingConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
patch:
operationId: api_v1_environments_integrations_sentry_partial_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this sentry change tracking configuration.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedSentryChangeTrackingConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedSentryChangeTrackingConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedSentryChangeTrackingConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SentryChangeTrackingConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
delete:
operationId: api_v1_environments_integrations_sentry_destroy
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this sentry change tracking configuration.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/slack/':
get:
operationId: api_v1_environments_integrations_slack_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SlackEnvironment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
post:
operationId: api_v1_environments_integrations_slack_create
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SlackEnvironment'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SlackEnvironment'
multipart/form-data:
schema:
$ref: '#/components/schemas/SlackEnvironment'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SlackEnvironment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/slack-channels/':
get:
operationId: api_v1_environments_integrations_slack_channels_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SlackChannelList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/slack/{id}/':
get:
operationId: api_v1_environments_integrations_slack_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this slack environment.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SlackEnvironment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
put:
operationId: api_v1_environments_integrations_slack_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this slack environment.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SlackEnvironment'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SlackEnvironment'
multipart/form-data:
schema:
$ref: '#/components/schemas/SlackEnvironment'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SlackEnvironment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
patch:
operationId: api_v1_environments_integrations_slack_partial_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this slack environment.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedSlackEnvironment'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedSlackEnvironment'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedSlackEnvironment'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SlackEnvironment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
delete:
operationId: api_v1_environments_integrations_slack_destroy
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this slack environment.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/slack/callback/':
get:
operationId: api_v1_environments_integrations_slack_callback_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SlackEnvironment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/slack/oauth/':
get:
operationId: api_v1_environments_integrations_slack_oauth_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SlackEnvironment'
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/slack/signature/':
get:
operationId: api_v1_environments_integrations_slack_signature_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SlackEnvironment'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/webhook/':
get:
operationId: api_v1_environments_integrations_webhook_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WebhookConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
post:
operationId: api_v1_environments_integrations_webhook_create
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WebhookConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/WebhookConfiguration'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/integrations/webhook/{id}/':
get:
operationId: api_v1_environments_integrations_webhook_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this webhook configuration.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
put:
operationId: api_v1_environments_integrations_webhook_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this webhook configuration.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WebhookConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/WebhookConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
patch:
operationId: api_v1_environments_integrations_webhook_partial_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this webhook configuration.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedWebhookConfiguration'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedWebhookConfiguration'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedWebhookConfiguration'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookConfiguration'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
delete:
operationId: api_v1_environments_integrations_webhook_destroy
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this webhook configuration.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Integrations
'/api/v1/environments/{environment_api_key}/list-change-requests/':
get:
operationId: list_environment_change_requests
description: Retrieves all change requests for an environment.
parameters:
- name: committed
in: query
description: Filter on the committed status of a change request.
schema:
type:
- boolean
- 'null'
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: feature_id
in: query
description: Filter for a particular feature.
schema:
type: integer
- name: live_from_after
in: query
description: Filter change requests due to go live after this datetime.
schema:
type: string
format: date-time
- name: page
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
in: query
description: Number of results to return per page.
schema:
type: integer
- name: search
in: query
description: Fuzzy search across Change Request titles.
schema:
type: string
minLength: 1
- name: segment_id
in: query
description: Filter change requests which match a specific segment id.
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeRequestList'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsError'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
'/api/v1/environments/{environment_api_key}/metrics/':
get:
operationId: api_v1_environments_metrics_list
description: Get metrics for this environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedEnvironmentMetricsList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/onboarding-status/':
get:
operationId: api_v1_environments_onboarding_status_retrieve
description: Obtain information on whether features for this environment have been evaluated yet.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentOnboardingStatus'
tags:
- Environments
'/api/v1/environments/{environment_api_key}/user-group-permissions/':
get:
operationId: api_v1_environments_user_group_permissions_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ListUserPermissionGroupEnvironmentPermission'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Permissions
post:
operationId: api_v1_environments_user_group_permissions_create
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdateUserPermissionGroupEnvironmentPermission'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateUpdateUserPermissionGroupEnvironmentPermission'
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateUpdateUserPermissionGroupEnvironmentPermission'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdateUserPermissionGroupEnvironmentPermission'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Permissions
'/api/v1/environments/{environment_api_key}/user-group-permissions/{id}/':
get:
operationId: api_v1_environments_user_group_permissions_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this user permission group environment permission.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdateUserPermissionGroupEnvironmentPermission'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Permissions
put:
operationId: api_v1_environments_user_group_permissions_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this user permission group environment permission.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdateUserPermissionGroupEnvironmentPermission'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateUpdateUserPermissionGroupEnvironmentPermission'
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateUpdateUserPermissionGroupEnvironmentPermission'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdateUserPermissionGroupEnvironmentPermission'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Permissions
patch:
operationId: api_v1_environments_user_group_permissions_partial_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this user permission group environment permission.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedCreateUpdateUserPermissionGroupEnvironmentPermission'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedCreateUpdateUserPermissionGroupEnvironmentPermission'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedCreateUpdateUserPermissionGroupEnvironmentPermission'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdateUserPermissionGroupEnvironmentPermission'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Permissions
delete:
operationId: api_v1_environments_user_group_permissions_destroy
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this user permission group environment permission.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Permissions
'/api/v1/environments/{environment_api_key}/user-permissions/':
get:
operationId: api_v1_environments_user_permissions_list
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ListUserEnvironmentPermission'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Permissions
post:
operationId: api_v1_environments_user_permissions_create
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdateUserEnvironmentPermission'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateUpdateUserEnvironmentPermission'
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateUpdateUserEnvironmentPermission'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdateUserEnvironmentPermission'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Permissions
'/api/v1/environments/{environment_api_key}/user-permissions/{id}/':
get:
operationId: api_v1_environments_user_permissions_retrieve
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this user environment permission.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdateUserEnvironmentPermission'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Permissions
put:
operationId: api_v1_environments_user_permissions_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this user environment permission.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdateUserEnvironmentPermission'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateUpdateUserEnvironmentPermission'
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateUpdateUserEnvironmentPermission'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdateUserEnvironmentPermission'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Permissions
patch:
operationId: api_v1_environments_user_permissions_partial_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this user environment permission.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedCreateUpdateUserEnvironmentPermission'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedCreateUpdateUserEnvironmentPermission'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedCreateUpdateUserEnvironmentPermission'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdateUserEnvironmentPermission'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Permissions
delete:
operationId: api_v1_environments_user_permissions_destroy
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this user environment permission.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Permissions
'/api/v1/environments/{environment_api_key}/warehouse-connections/':
get:
operationId: api_v1_environments_warehouse_connections_list
description: Manage data warehouse connections for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WarehouseConnection'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
post:
operationId: api_v1_environments_warehouse_connections_create
description: Manage data warehouse connections for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseConnection'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WarehouseConnection'
multipart/form-data:
schema:
$ref: '#/components/schemas/WarehouseConnection'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseConnection'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/warehouse-connections/{connection_id}/':
get:
operationId: api_v1_environments_warehouse_connections_retrieve
description: Manage data warehouse connections for an environment.
parameters:
- name: connection_id
in: path
description: A unique integer value identifying this warehouse connection.
required: true
schema:
type: integer
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseConnection'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
put:
operationId: api_v1_environments_warehouse_connections_update
description: Manage data warehouse connections for an environment.
parameters:
- name: connection_id
in: path
description: A unique integer value identifying this warehouse connection.
required: true
schema:
type: integer
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseConnection'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WarehouseConnection'
multipart/form-data:
schema:
$ref: '#/components/schemas/WarehouseConnection'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseConnection'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
patch:
operationId: api_v1_environments_warehouse_connections_partial_update
description: Manage data warehouse connections for an environment.
parameters:
- name: connection_id
in: path
description: A unique integer value identifying this warehouse connection.
required: true
schema:
type: integer
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedWarehouseConnection'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedWarehouseConnection'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedWarehouseConnection'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseConnection'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
delete:
operationId: api_v1_environments_warehouse_connections_destroy
description: Manage data warehouse connections for an environment.
parameters:
- name: connection_id
in: path
description: A unique integer value identifying this warehouse connection.
required: true
schema:
type: integer
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/warehouse-connections/{connection_id}/events/':
get:
operationId: api_v1_environments_warehouse_connections_events_list
description: List the distinct event names in the connection's warehouse.
parameters:
- name: connection_id
in: path
description: A unique integer value identifying this warehouse connection.
required: true
schema:
type: integer
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseEventNamesResult'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseEventNamesUnsupported'
'503':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseEventNamesUnavailable'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/warehouse-connections/{connection_id}/test-warehouse-connection/':
post:
operationId: api_v1_environments_warehouse_connections_test_warehouse_connection_create
description: Manage data warehouse connections for an environment.
parameters:
- name: connection_id
in: path
description: A unique integer value identifying this warehouse connection.
required: true
schema:
type: integer
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseConnection'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WarehouseConnection'
multipart/form-data:
schema:
$ref: '#/components/schemas/WarehouseConnection'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseConnection'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/warehouse-connections/test-warehouse-connection/':
post:
operationId: api_v1_environments_warehouse_connections_test_warehouse_connection_config_create
description: Manage data warehouse connections for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseConnection'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WarehouseConnection'
multipart/form-data:
schema:
$ref: '#/components/schemas/WarehouseConnection'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WarehouseConnectionTestResult'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
'/api/v1/environments/{environment_api_key}/webhooks/':
get:
operationId: api_v1_environments_webhooks_list
description: Manage webhooks for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Webhook'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Webhooks
post:
operationId: api_v1_environments_webhooks_create
description: Manage webhooks for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Webhook'
multipart/form-data:
schema:
$ref: '#/components/schemas/Webhook'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Webhooks
'/api/v1/environments/{environment_api_key}/webhooks/{id}/':
put:
operationId: api_v1_environments_webhooks_update
description: Manage webhooks for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this webhook.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Webhook'
multipart/form-data:
schema:
$ref: '#/components/schemas/Webhook'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Webhooks
patch:
operationId: api_v1_environments_webhooks_partial_update
description: Manage webhooks for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this webhook.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedWebhook'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedWebhook'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedWebhook'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Webhooks
delete:
operationId: api_v1_environments_webhooks_destroy
description: Manage webhooks for an environment.
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
- name: id
in: path
description: A unique integer value identifying this webhook.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Webhooks
'/api/v1/environments/{environment_pk}/feature-lifecycle-counts/':
get:
operationId: get_feature_lifecycle_counts
description: Retrieves the count of features in each lifecycle stage for the specified environment.
parameters:
- name: environment_pk
in: path
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureLifecycleCounts'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
'/api/v1/environments/{environment_pk}/features/{feature_pk}/versions/':
get:
operationId: get_environment_feature_versions
description: 'Retrieves version information for a feature flag in a specific environment. Applies to environments with v2 feature versioning (use_v2_feature_versioning: true).'
parameters:
- name: environment_pk
in: path
required: true
schema:
type: integer
- name: feature_pk
in: path
required: true
schema:
type: integer
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedEnvironmentFeatureVersionList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
post:
operationId: create_environment_feature_version
description: 'Creates a new version for a feature flag in a specific environment. Applies to environments with v2 feature versioning (use_v2_feature_versioning: true).'
parameters:
- name: environment_pk
in: path
required: true
schema:
type: integer
- name: feature_pk
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentFeatureVersionCreate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/EnvironmentFeatureVersionCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/EnvironmentFeatureVersionCreate'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentFeatureVersionCreate'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
'/api/v1/environments/{environment_pk}/features/{feature_pk}/versions/{environment_feature_version_pk}/featurestates/':
get:
operationId: get_environment_feature_version_states
description: 'Retrieves feature state information for a specific version in an environment. Applies to environments with v2 feature versioning (use_v2_feature_versioning: true).'
parameters:
- name: environment_feature_version_pk
in: path
required: true
schema:
type:
- string
- 'null'
format: uuid
- name: environment_pk
in: path
required: true
schema:
type: integer
- name: feature_pk
in: path
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CustomEnvironmentFeatureVersionFeatureState'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
post:
operationId: create_environment_feature_version_state
description: 'Creates a new feature state for a specific version in an environment. Applies to environments with v2 feature versioning (use_v2_feature_versioning: true).'
parameters:
- name: environment_feature_version_pk
in: path
required: true
schema:
type:
- string
- 'null'
format: uuid
- name: environment_pk
in: path
required: true
schema:
type: integer
- name: feature_pk
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomEnvironmentFeatureVersionFeatureState'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CustomEnvironmentFeatureVersionFeatureState'
multipart/form-data:
schema:
$ref: '#/components/schemas/CustomEnvironmentFeatureVersionFeatureState'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomEnvironmentFeatureVersionFeatureState'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
'/api/v1/environments/{environment_pk}/features/{feature_pk}/versions/{environment_feature_version_pk}/featurestates/{id}/':
put:
operationId: update_environment_feature_version_state
description: 'Updates an existing feature state for a specific version in an environment. Applies to environments with v2 feature versioning (use_v2_feature_versioning: true).'
parameters:
- name: environment_feature_version_pk
in: path
required: true
schema:
type:
- string
- 'null'
format: uuid
- name: environment_pk
in: path
required: true
schema:
type: integer
- name: feature_pk
in: path
required: true
schema:
type: integer
- name: id
in: path
description: A unique integer value identifying this feature state.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CustomEnvironmentFeatureVersionFeatureState'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CustomEnvironmentFeatureVersionFeatureState'
multipart/form-data:
schema:
$ref: '#/components/schemas/CustomEnvironmentFeatureVersionFeatureState'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomEnvironmentFeatureVersionFeatureState'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
patch:
operationId: api_v1_environments_features_versions_featurestates_partial_update
parameters:
- name: environment_feature_version_pk
in: path
required: true
schema:
type:
- string
- 'null'
format: uuid
- name: environment_pk
in: path
required: true
schema:
type: integer
- name: feature_pk
in: path
required: true
schema:
type: integer
- name: id
in: path
description: A unique integer value identifying this feature state.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedCustomEnvironmentFeatureVersionFeatureState'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedCustomEnvironmentFeatureVersionFeatureState'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedCustomEnvironmentFeatureVersionFeatureState'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomEnvironmentFeatureVersionFeatureState'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Feature states
delete:
operationId: api_v1_environments_features_versions_featurestates_destroy
parameters:
- name: environment_feature_version_pk
in: path
required: true
schema:
type:
- string
- 'null'
format: uuid
- name: environment_pk
in: path
required: true
schema:
type: integer
- name: feature_pk
in: path
required: true
schema:
type: integer
- name: id
in: path
description: A unique integer value identifying this feature state.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Feature states
'/api/v1/environments/{environment_pk}/features/{feature_pk}/versions/{id}/':
delete:
operationId: api_v1_environments_features_versions_destroy
parameters:
- name: environment_pk
in: path
required: true
schema:
type: integer
- name: feature_pk
in: path
required: true
schema:
type: integer
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
'/api/v1/environments/{environment_pk}/features/{feature_pk}/versions/{id}/publish/':
post:
operationId: publish_environment_feature_version
description: 'Publishes a feature version to make it live in the environment. Applies to environments with v2 feature versioning (use_v2_feature_versioning: true).'
parameters:
- name: environment_pk
in: path
required: true
schema:
type: integer
- name: feature_pk
in: path
required: true
schema:
type: integer
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentFeatureVersionPublish'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/EnvironmentFeatureVersionPublish'
multipart/form-data:
schema:
$ref: '#/components/schemas/EnvironmentFeatureVersionPublish'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentFeatureVersionPublish'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
'/api/v1/environments/environments/{environment_api_key}/edge-identities-featurestates':
put:
operationId: api_v1_environments_environments_edge_identities_featurestates_update
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentityWithIdentifierFeatureStateRequestBody'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/EdgeIdentityWithIdentifierFeatureStateRequestBody'
multipart/form-data:
schema:
$ref: '#/components/schemas/EdgeIdentityWithIdentifierFeatureStateRequestBody'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EdgeIdentityFeatureState'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
delete:
operationId: api_v1_environments_environments_edge_identities_featurestates_destroy
parameters:
- name: environment_api_key
in: path
required: true
schema:
type: string
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Identities
'/api/v1/environments/get-by-uuid/{uuid}/':
get:
operationId: api_v1_environments_get_by_uuid_retrieve
parameters:
- name: uuid
in: path
required: true
schema:
type: string
pattern: '^[0-9a-f-]+$'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentSerializerWithMetadata'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
/api/v1/environments/permissions/:
get:
operationId: api_v1_environments_permissions_list
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedPermissionModelList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Environments
/api/v1/events/:
post:
operationId: api_v1_events_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SDKExperimentationEventBatch'
responses:
'202':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SDKEventBatchResult'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SDKEventBatchResult'
'404':
description: ''
content:
application/json:
schema:
type: object
additionalProperties: {}
'413':
description: ''
content:
text/plain:
schema:
type: string
security:
- Environment API Key: []
tags:
- Other
'/api/v1/feature-health/{path}':
post:
operationId: api_v1_feature_health_create
parameters:
- name: path
in: path
required: true
schema:
type: string
pattern: '^.{0,100}$'
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
- {}
tags:
- Feature states
/api/v1/features/create-feature-export/:
post:
operationId: api_v1_features_create_feature_export_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFeatureExport'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CreateFeatureExport'
multipart/form-data:
schema:
$ref: '#/components/schemas/CreateFeatureExport'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureExport'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
'/api/v1/features/download-feature-export/{feature_export_id}/':
get:
operationId: api_v1_features_download_feature_export_retrieve
description: This endpoint is to download a feature export file from a specific environment
parameters:
- name: feature_export_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
additionalProperties: true
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
/api/v1/features/download-flagsmith-on-flagsmith/:
get:
operationId: api_v1_features_download_flagsmith_on_flagsmith_retrieve
description: This endpoint is to download a feature export to enable Flagsmith on Flagsmith
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
additionalProperties: true
security:
- tokenAuth: []
- Master API Key: []
- {}
tags:
- Features
'/api/v1/features/feature-import/{environment_id}':
post:
operationId: api_v1_features_feature_import_create
parameters:
- name: environment_id
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureImportUpload'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FeatureImportUpload'
multipart/form-data:
schema:
$ref: '#/components/schemas/FeatureImportUpload'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureImport'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
/api/v1/features/feature-segments/:
get:
operationId: list_feature_segments
description: Lists segment overrides for a feature in an environment.
parameters:
- name: environment
in: query
required: true
schema:
type: integer
- name: feature
in: query
required: true
schema:
type: integer
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedFeatureSegmentListList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
post:
operationId: api_v1_features_feature_segments_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureSegmentCreate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/FeatureSegmentCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/FeatureSegmentCreate'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureSegmentCreate'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
'/api/v1/features/feature-segments/{id}/':
get:
operationId: api_v1_features_feature_segments_retrieve
parameters:
- name: id
in: path
description: A unique integer value identifying this feature segment.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureSegmentList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
delete:
operationId: delete_feature_segment
description: 'Deletes a segment override. Applies to environments without v2 feature versioning (use_v2_feature_versioning: false).'
parameters:
- name: id
in: path
description: A unique integer value identifying this feature segment.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
'/api/v1/features/feature-segments/get-by-uuid/{uuid}/':
get:
operationId: api_v1_features_feature_segments_get_by_uuid_retrieve
parameters:
- name: uuid
in: path
required: true
schema:
type: string
pattern: '^[0-9a-f-]+$'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeatureSegmentList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
/api/v1/features/feature-segments/update-priorities/:
post:
operationId: api_v1_features_feature_segments_update_priorities_create
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FeatureSegmentChangePriorities'
application/x-www-form-urlencoded:
schema:
type: array
items:
$ref: '#/components/schemas/FeatureSegmentChangePriorities'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/FeatureSegmentChangePriorities'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedFeatureSegmentListList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
/api/v1/features/featurestates/:
get:
operationId: api_v1_features_featurestates_list
parameters:
- name: environment
in: query
description: ID of the environment.
required: true
schema:
type: integer
- name: feature
in: query
schema:
type: integer
- name: feature_segment
in: query
schema:
type: integer
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedWritableNestedFeatureStateList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Feature states
post:
operationId: api_v1_features_featurestates_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WritableNestedFeatureState'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WritableNestedFeatureState'
multipart/form-data:
schema:
$ref: '#/components/schemas/WritableNestedFeatureState'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableNestedFeatureState'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Feature states
'/api/v1/features/featurestates/{id}/':
put:
operationId: update_feature_state
description: 'Updates a feature state, including its enabled status and value. Also updates a segment override''s value for environments without v2 feature versioning (use_v2_feature_versioning: false).'
parameters:
- name: id
in: path
description: A unique integer value identifying this feature state.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WritableNestedFeatureState'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/WritableNestedFeatureState'
multipart/form-data:
schema:
$ref: '#/components/schemas/WritableNestedFeatureState'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableNestedFeatureState'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
patch:
operationId: api_v1_features_featurestates_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this feature state.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedWritableNestedFeatureState'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedWritableNestedFeatureState'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedWritableNestedFeatureState'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableNestedFeatureState'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Feature states
'/api/v1/features/featurestates/get-by-uuid/{uuid}/':
get:
operationId: api_v1_features_featurestates_get_by_uuid_retrieve
parameters:
- name: uuid
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WritableNestedFeatureState'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Feature states
'/api/v1/features/get-by-uuid/{uuid}/':
get:
operationId: api_v1_features_get_by_uuid_retrieve
parameters:
- name: uuid
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFeature'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
'/api/v1/features/workflows/change-requests/{id}/':
get:
operationId: api_v1_features_workflows_change_requests_retrieve
parameters:
- name: id
in: path
description: A unique integer value identifying this change request.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeRequestRetrieve'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
put:
operationId: api_v1_features_workflows_change_requests_update
parameters:
- name: id
in: path
description: A unique integer value identifying this change request.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeRequestUpdate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ChangeRequestUpdate'
multipart/form-data:
schema:
$ref: '#/components/schemas/ChangeRequestUpdate'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeRequestUpdate'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
patch:
operationId: api_v1_features_workflows_change_requests_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this change request.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedChangeRequestUpdate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedChangeRequestUpdate'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedChangeRequestUpdate'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeRequestUpdate'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
delete:
operationId: api_v1_features_workflows_change_requests_destroy
parameters:
- name: id
in: path
description: A unique integer value identifying this change request.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
'/api/v1/features/workflows/change-requests/{id}/approve/':
post:
operationId: api_v1_features_workflows_change_requests_approve_create
parameters:
- name: id
in: path
description: A unique integer value identifying this change request.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeRequestRetrieve'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsError'
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsError'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
'/api/v1/features/workflows/change-requests/{id}/commit/':
post:
operationId: api_v1_features_workflows_change_requests_commit_create
parameters:
- name: id
in: path
description: A unique integer value identifying this change request.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeRequestRetrieve'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsError'
'403':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowsError'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
/api/v1/flags/:
get:
operationId: sdk_v1_flags
description: |-
Retrieve the feature flags for an environment.
---
*Note*: when providing the `feature` query argument, this endpoint will
return either a single object or a 404 (if the feature does not exist) rather
than a list.
---
*Note*: using this endpoint with an identifier is deprecated.
Please use `/api/v1/identities/?identifier=<identifier>` instead.
parameters:
- name: feature
in: query
description: Name of the feature to get the state of
schema:
type: string
minLength: 1
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
type: object
description: Represents a single flag (feature state) returned by the Flagsmith SDK.
properties:
feature:
description: 'Represents a Flagsmith feature, defined at project level.'
type: object
properties:
id:
type: integer
name:
type: string
type:
type: string
enum:
- STANDARD
- MULTIVARIATE
required:
- id
- name
- type
enabled:
type: boolean
feature_state_value:
nullable: true
oneOf:
- type: integer
- type: boolean
- type: string
variant:
type: string
nullable: true
reason:
type: string
nullable: true
metadata:
description: 'Additional, non-evaluation data about a feature state.'
type: object
properties:
experiment:
description: Represents the experiment a feature state is part of. Only present while the experiment is running.
type: object
properties:
id:
type: integer
name:
type: string
in_experiment:
type: boolean
required:
- id
- in_experiment
- name
required:
- enabled
- feature
- feature_state_value
security:
- Environment API Key: []
tags:
- sdk
'/api/v1/flags/{feature_id}/multivariate-options/':
get:
operationId: api_v1_flags_multivariate_options_list
parameters:
- name: feature_id
in: path
required: true
schema:
type: string
pattern: '^[0-9]+$'
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FeatureMVOptionsValuesResponse'
security:
- Environment API Key: []
tags:
- Features
'/api/v1/flags/{identifier}':
get:
operationId: sdk_v1_flags_2
description: |-
Retrieve the feature flags for an environment.
---
*Note*: when providing the `feature` query argument, this endpoint will
return either a single object or a 404 (if the feature does not exist) rather
than a list.
---
*Note*: using this endpoint with an identifier is deprecated.
Please use `/api/v1/identities/?identifier=<identifier>` instead.
parameters:
- name: feature
in: query
description: Name of the feature to get the state of
schema:
type: string
minLength: 1
- name: identifier
in: path
required: true
schema:
type: string
pattern: '^[-\w@%.]+$'
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
type: object
description: Represents a single flag (feature state) returned by the Flagsmith SDK.
properties:
feature:
description: 'Represents a Flagsmith feature, defined at project level.'
type: object
properties:
id:
type: integer
name:
type: string
type:
type: string
enum:
- STANDARD
- MULTIVARIATE
required:
- id
- name
- type
enabled:
type: boolean
feature_state_value:
nullable: true
oneOf:
- type: integer
- type: boolean
- type: string
variant:
type: string
nullable: true
reason:
type: string
nullable: true
metadata:
description: 'Additional, non-evaluation data about a feature state.'
type: object
properties:
experiment:
description: Represents the experiment a feature state is part of. Only present while the experiment is running.
type: object
properties:
id:
type: integer
name:
type: string
in_experiment:
type: boolean
required:
- id
- in_experiment
- name
required:
- enabled
- feature
- feature_state_value
security:
- Environment API Key: []
tags:
- sdk
/api/v1/github-webhook/:
post:
operationId: api_v1_github_webhook_create
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
- {}
tags:
- Webhooks
'/api/v1/gitlab-webhook/{webhook_uuid}/':
post:
operationId: api_v1_gitlab_webhook_create
parameters:
- name: webhook_uuid
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
- {}
tags:
- Other
/api/v1/identities/:
get:
operationId: sdk_v1_get_identities
description: Retrieve the flags and traits for an identity.
parameters:
- name: identifier
in: query
required: true
schema:
type: string
minLength: 1
- name: transient
in: query
schema:
type: boolean
default: false
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V1IdentitiesResponse'
security:
- Environment API Key: []
tags:
- sdk
post:
operationId: sdk_v1_post_identities
description: 'Identify a user, set their traits, and retrieve their flags.'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/V1IdentitiesRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/V1IdentitiesRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/V1IdentitiesRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/V1IdentitiesResponse'
security:
- Environment API Key: []
tags:
- sdk
/api/v1/metadata/fields/:
get:
operationId: api_v1_metadata_fields_list
parameters:
- name: organisation
in: query
description: Organisation ID to filter by
required: true
schema:
type: integer
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedMetadataFieldList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Metadata
post:
operationId: api_v1_metadata_fields_create
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataField'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/MetadataField'
multipart/form-data:
schema:
$ref: '#/components/schemas/MetadataField'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataField'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Metadata
'/api/v1/metadata/fields/{id}/':
get:
operationId: api_v1_metadata_fields_retrieve
parameters:
- name: id
in: path
description: A unique integer value identifying this metadata field.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataField'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Metadata
put:
operationId: api_v1_metadata_fields_update
parameters:
- name: id
in: path
description: A unique integer value identifying this metadata field.
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataField'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/MetadataField'
multipart/form-data:
schema:
$ref: '#/components/schemas/MetadataField'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataField'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Metadata
patch:
operationId: api_v1_metadata_fields_partial_update
parameters:
- name: id
in: path
description: A unique integer value identifying this metadata field.
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedMetadataField'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedMetadataField'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedMetadataField'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MetadataField'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Metadata
delete:
operationId: api_v1_metadata_fields_destroy
parameters:
- name: id
in: path
description: A unique integer value identifying this metadata field.
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Metadata
'/api/v1/multivariate/options/get-by-uuid/{uuid}/':
get:
operationId: api_v1_multivariate_options_get_by_uuid_retrieve
parameters:
- name: uuid
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MultivariateFeatureOption'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Features
/api/v1/oauth/authorize/:
get:
operationId: api_v1_oauth_authorize_retrieve
description: Validate an authorisation request and return application info.
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Other
post:
operationId: api_v1_oauth_authorize_create
description: Process a consent decision and return the redirect URI.
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Other
/api/v1/onboarding/request/send/:
post:
operationId: api_v1_onboarding_request_send_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SelfHostedOnboardingSupportSendRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SelfHostedOnboardingSupportSendRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/SelfHostedOnboardingSupportSendRequest'
responses:
'204':
description: No response body
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Onboarding
/api/v1/organisations/:
get:
operationId: list_organizations
description: Lists all organisations accessible with the provided user API key.
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedOrganisationSerializerFullList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
post:
operationId: api_v1_organisations_create
description: Override create method to add new organisation to authenticated user
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OrganisationSerializerFull'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/OrganisationSerializerFull'
multipart/form-data:
schema:
$ref: '#/components/schemas/OrganisationSerializerFull'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OrganisationSerializerFull'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
'/api/v1/organisations/{organisation_id}/licence':
put:
operationId: api_v1_organisations_licence_update
parameters:
- name: organisation_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
'/api/v1/organisations/{organisation_pk}/api-usage-notification/':
get:
operationId: api_v1_organisations_api_usage_notification_list
parameters:
- name: organisation_pk
in: path
required: true
schema:
type: integer
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedOrganisationAPIUsageNotificationList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
'/api/v1/organisations/{organisation_pk}/audit/':
get:
operationId: api_v1_organisations_audit_list
parameters:
- name: environments
in: query
schema:
type: array
items:
type: integer
minimum: 0
- name: is_system_event
in: query
schema:
type:
- boolean
- 'null'
- name: organisation_pk
in: path
required: true
schema:
type: string
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
schema:
type: integer
- name: project
in: query
schema:
type: integer
- name: search
in: query
schema:
type: string
maxLength: 256
minLength: 3
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAuditLogListList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Audit
'/api/v1/organisations/{organisation_pk}/audit/{id}/':
get:
operationId: api_v1_organisations_audit_retrieve
parameters:
- name: id
in: path
description: A unique integer value identifying this audit log.
required: true
schema:
type: integer
- name: organisation_pk
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AuditLogRetrieve'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Audit
'/api/v1/organisations/{organisation_pk}/edge-proxy/keys/':
get:
operationId: api_v1_organisations_edge_proxy_keys_list
parameters:
- name: organisation_pk
in: path
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ProxyKey'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
post:
operationId: api_v1_organisations_edge_proxy_keys_create
parameters:
- name: organisation_pk
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyKey'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ProxyKey'
multipart/form-data:
schema:
$ref: '#/components/schemas/ProxyKey'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyKey'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
'/api/v1/organisations/{organisation_pk}/edge-proxy/keys/{prefix}/':
get:
operationId: api_v1_organisations_edge_proxy_keys_retrieve
parameters:
- name: organisation_pk
in: path
required: true
schema:
type: integer
- name: prefix
in: path
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyKey'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
put:
operationId: api_v1_organisations_edge_proxy_keys_update
parameters:
- name: organisation_pk
in: path
required: true
schema:
type: integer
- name: prefix
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyKey'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ProxyKey'
multipart/form-data:
schema:
$ref: '#/components/schemas/ProxyKey'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyKey'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
patch:
operationId: api_v1_organisations_edge_proxy_keys_partial_update
parameters:
- name: organisation_pk
in: path
required: true
schema:
type: integer
- name: prefix
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedProxyKey'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedProxyKey'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedProxyKey'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ProxyKey'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
delete:
operationId: api_v1_organisations_edge_proxy_keys_destroy
parameters:
- name: organisation_pk
in: path
required: true
schema:
type: integer
- name: prefix
in: path
required: true
schema:
type: string
responses:
'204':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
'/api/v1/organisations/{organisation_pk}/github/create-cleanup-issue/':
post:
operationId: api_v1_organisations_github_create_cleanup_issue_create
parameters:
- name: organisation_pk
in: path
required: true
schema:
type: integer
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
'/api/v1/organisations/{organisation_pk}/github/issues/':
get:
operationId: api_v1_organisations_github_issues_retrieve
parameters:
- name: organisation_pk
in: path
required: true
schema:
type: integer
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
'/api/v1/organisations/{organisation_pk}/github/pulls/':
get:
operationId: api_v1_organisations_github_pulls_retrieve
parameters:
- name: organisation_pk
in: path
required: true
schema:
type: integer
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
'/api/v1/organisations/{organisation_pk}/github/repo-contributors/':
get:
operationId: api_v1_organisations_github_repo_contributors_retrieve
parameters:
- name: organisation_pk
in: path
required: true
schema:
type: integer
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
'/api/v1/organisations/{organisation_pk}/github/repositories/':
get:
operationId: api_v1_organisations_github_repositories_retrieve
parameters:
- name: organisation_pk
in: path
required: true
schema:
type: integer
responses:
'200':
description: No response body
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
'/api/v1/organisations/{organisation_pk}/groups/':
get:
operationId: list_organization_groups
description: Retrieves all permission groups within the organisation.
parameters:
- name: organisation_pk
in: path
required: true
schema:
type: integer
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedListUserPermissionGroupList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- mcp
post:
operationId: api_v1_organisations_groups_create
parameters:
- name: organisation_pk
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListUserPermissionGroup'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ListUserPermissionGroup'
multipart/form-data:
schema:
$ref: '#/components/schemas/ListUserPermissionGroup'
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListUserPermissionGroup'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
'/api/v1/organisations/{organisation_pk}/groups/{group_pk}/roles/':
get:
operationId: api_v1_organisations_groups_roles_list
parameters:
- name: group_pk
in: path
required: true
schema:
type: string
- name: organisation_pk
in: path
required: true
schema:
type: string
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedRoleList'
security:
- tokenAuth: []
- Master API Key: []
tags:
- Organisations
'/api/v1/organisations/{organisation_pk}/groups/{group_pk}/roles/{id}/':
delete:
operationId: api_v1_organisations_groups_roles_destroy
parameters:
- name: group_pk
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
- name: organisation_pk
in: path
required: true
schema:
type: string
responses:
'204':
description: No response body
security:
- tokenAuth: [