Environments-7
For instructions on how to authenticate to use this endpoint, see API overview.
List all endpoints for the team.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
GET | |
POST | |
POST | |
GET | |
POST | |
GET | |
PATCH | |
DELETE |
Retrieve environments endpoints
Required API key scopes
endpoint:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
GET
/api /environments /:project_id /endpoints
Example response
Status 200 No response body
Create environments endpoints
Create a new endpoint
Required API key scopes
endpoint:write
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- description
- is_active
- name
- query
Example request
POST
/api /environments /:project_id /endpoints
Example response
Status 201 No response body
Retrieve environments endpoints retrieve
Required API key scopes
endpoint:read
Path parameters
- namestring
URL-safe name for the endpoint
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
GET
/api /environments /:project_id /endpoints /:name
Example response
Status 200 No response body
Update environments endpoints
Path parameters
- namestring
URL-safe name for the endpoint
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
PATCH
/api /environments /:project_id /endpoints /:name
Example response
Status 200 No response body
Delete environments endpoints
Delete a endpoint.
Required API key scopes
endpoint:write
Path parameters
- namestring
URL-safe name for the endpoint
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
DELETE
/api /environments /:project_id /endpoints /:name
Example response
Status 204 No response body
Retrieve environments endpoints run
Update an existing endpoint. Parameters are optional.
Required API key scopes
endpoint:read
Path parameters
- namestring
URL-safe name for the endpoint
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
GET
/api /environments /:project_id /endpoints /:name /run
Example response
Status 200 No response body
Create environments endpoints run
Update an existing endpoint. Parameters are optional.
Required API key scopes
endpoint:read
Path parameters
- namestring
URL-safe name for the endpoint
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- client_query_id
Client provided query ID. Can be used to retrieve the status or cancel the query.
- filters_override
- query_override
- refreshDefault:
blocking
Whether results should be calculated sync or async, and how much to rely on the cache:
'blocking'
- calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache'async'
- kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache'lazy_async'
- kick off background calculation, UNLESS there are somewhat fresh results in the cache'force_blocking'
- calculate synchronously, even if fresh results are already cached'force_async'
- kick off background calculation, even if fresh results are already cached'force_cache'
- return cached data or a cache miss; always completes immediately as it never calculates Background calculation can be tracked using thequery_status
response field.
- variables_override
- variables_values
Example request
POST
/api /environments /:project_id /endpoints /:name /run
Example response
Status 200 No response body
Create environments endpoints last execution times
Get the last execution times in the past 6 monthsfor multiple endpoints.
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- namesarray
Response
Example request
POST
/api /environments /:project_id /endpoints /last_execution_times
Example response
Status 200
List all environments error tracking assignment rules
Required API key scopes
error_tracking:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Example request
GET
/api /environments /:project_id /error_tracking /assignment_rules
Example response
Status 200
List all environments error tracking assignment rules
Required API key scopes
error_tracking:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Example request
GET
/api /environments /:project_id /error_tracking /assignment_rules
Example response
Status 200
Create environments error tracking assignment rules
Required API key scopes
error_tracking:write
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- filters
- order_keyinteger
- disabled_data
Response
Example request
POST
/api /environments /:project_id /error_tracking /assignment_rules
Example response
Status 201
Create environments error tracking assignment rules
Required API key scopes
error_tracking:write
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- filters
- order_keyinteger
- disabled_data
Response
Example request
POST
/api /environments /:project_id /error_tracking /assignment_rules
Example response
Status 201
Retrieve environments error tracking assignment rules
Required API key scopes
error_tracking:read
Path parameters
- idstring
A UUID string identifying this error tracking assignment rule.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Example request
GET
/api /environments /:project_id /error_tracking /assignment_rules /:id
Example response
Status 200
Retrieve environments error tracking assignment rules
Required API key scopes
error_tracking:read
Path parameters
- idstring
A UUID string identifying this error tracking assignment rule.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Example request
GET
/api /environments /:project_id /error_tracking /assignment_rules /:id
Example response
Status 200
Update environments error tracking assignment rules
Required API key scopes
error_tracking:write
Path parameters
- idstring
A UUID string identifying this error tracking assignment rule.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- filters
- order_keyinteger
- disabled_data
Response
Example request
PATCH
/api /environments /:project_id /error_tracking /assignment_rules /:id
Example response
Status 200
Update environments error tracking assignment rules
Required API key scopes
error_tracking:write
Path parameters
- idstring
A UUID string identifying this error tracking assignment rule.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request parameters
- filters
- order_keyinteger
- disabled_data
Response
Example request
PATCH
/api /environments /:project_id /error_tracking /assignment_rules /:id
Example response
Status 200
Delete environments error tracking assignment rules
Required API key scopes
error_tracking:write
Path parameters
- idstring
A UUID string identifying this error tracking assignment rule.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Example request
DELETE
/api /environments /:project_id /error_tracking /assignment_rules /:id