Core-4
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
GET | |
GET | |
GET | |
GET | |
GET | |
POST | |
GET | |
GET | |
POST | |
DELETE | |
POST | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
GET | |
POST |
Retrieve environments integrations jira projects
Path parameters
- environment_idstring
- idinteger
Example request
GET /api /environments /:environment_id /integrations /:id /jira_projectsExample response
Status 200 No response body
Retrieve environments integrations linear teams
Path parameters
- environment_idstring
- idinteger
Example request
GET /api /environments /:environment_id /integrations /:id /linear_teamsExample response
Status 200 No response body
Retrieve environments integrations linkedin ads accounts
Path parameters
- environment_idstring
- idinteger
Example request
GET /api /environments /:environment_id /integrations /:id /linkedin_ads_accountsExample response
Status 200 No response body
Retrieve environments integrations linkedin ads conversion rules
Path parameters
- environment_idstring
- idinteger
Example request
GET /api /environments /:environment_id /integrations /:id /linkedin_ads_conversion_rulesExample response
Status 200 No response body
Retrieve environments integrations twilio phone numbers
Path parameters
- environment_idstring
- idinteger
Example request
GET /api /environments /:environment_id /integrations /:id /twilio_phone_numbersExample response
Status 200 No response body
Retrieve environments integrations authorize
Path parameters
- environment_idstring
Example request
GET /api /environments /:environment_id /integrations /authorizeExample response
Status 200 No response body
Create environments integrations domain connect apply url
Unified endpoint for generating Domain Connect apply URLs.
Accepts a context ("email" or "proxy") and the relevant resource ID. The backend resolves the domain, template variables, and service ID based on context, then builds the signed apply URL.
Path parameters
- environment_idstring
Request parameters
- kind
- config
Example request
POST /api /environments /:environment_id /integrations /domain-connect /apply-urlExample response
Status 200 No response body
Retrieve environments integrations domain connect check
Path parameters
- environment_idstring
Example request
GET /api /environments /:environment_id /integrations /domain-connect /checkExample response
Status 200 No response body
List all environments session recordings sharing
Required API key scopes
sharing_configuration:readPath parameters
- environment_idstring
- recording_idstring
Example request
GET /api /environments /:environment_id /session_recordings /:recording_id /sharingExample response
Status 200
RESPONSE
Create environments session recordings sharing passwords
Create a new password for the sharing configuration.
Required API key scopes
sharing_configuration:writePath parameters
- environment_idstring
- recording_idstring
Request parameters
- enabledboolean
- settings
- password_requiredboolean
Response
Example request
POST /api /environments /:environment_id /session_recordings /:recording_id /sharing /passwordsExample response
Status 200
RESPONSE
Delete environments session recordings sharing passwords
Delete a password from the sharing configuration.
Required API key scopes
sharing_configuration:writePath parameters
- environment_idstring
- password_idstring
- recording_idstring
Example request
DELETE /api /environments /:environment_id /session_recordings /:recording_id /sharing /passwords /:password_idExample response
Status 204 No response body
Create environments session recordings sharing refresh
Required API key scopes
sharing_configuration:writePath parameters
- environment_idstring
- recording_idstring
Request parameters
- enabledboolean
- settings
- password_requiredboolean
Response
Example request
POST /api /environments /:environment_id /session_recordings /:recording_id /sharing /refreshExample response
Status 200
RESPONSE
List all environments subscriptions
Required API key scopes
subscription:readPath parameters
- environment_idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /environments /:environment_id /subscriptionsExample response
Status 200
RESPONSE
Create environments subscriptions
Required API key scopes
subscription:writePath parameters
- environment_idstring
Request parameters
- dashboardinteger
- insightinteger
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarray
- bysetposinteger
- countinteger
- start_datestring
- until_datestring
- deletedboolean
- titlestring
- invite_messagestring
Response
Example request
POST /api /environments /:environment_id /subscriptionsExample response
Status 201
RESPONSE
Retrieve environments subscriptions
Required API key scopes
subscription:readPath parameters
- environment_idstring
- idinteger
Response
Example request
GET /api /environments /:environment_id /subscriptions /:idExample response
Status 200
RESPONSE
Update environments subscriptions
Required API key scopes
subscription:writePath parameters
- environment_idstring
- idinteger
Request parameters
- dashboardinteger
- insightinteger
- target_type
- target_valuestring
- frequency
- intervalinteger
- byweekdayarray
- bysetposinteger
- countinteger
- start_datestring
- until_datestring
- deletedboolean
- titlestring
- invite_messagestring
Response
Example request
PATCH /api /environments /:environment_id /subscriptions /:idExample response
Status 200
RESPONSE
Delete environments subscriptions
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
subscription:writePath parameters
- environment_idstring
- idinteger
Example request
DELETE /api /environments /:environment_id /subscriptions /:idExample response
Status 405 No response body
List all domains
Required API key scopes
organization:readPath parameters
- organization_idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /organizations /:organization_id /domainsExample response
Status 200
RESPONSE
Create domains
Required API key scopes
organization:writePath parameters
- organization_idstring
Request parameters
- domainstring
- jit_provisioning_enabledboolean
- sso_enforcementstring
- saml_entity_idstring
- saml_acs_urlstring
- saml_x509_certstring
- scim_enabledboolean
Response
Example request
POST /api /organizations /:organization_id /domainsExample response
Status 201
RESPONSE