Environments-13
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
| GET | |
| POST | |
| GET | |
| GET | |
| GET | |
| POST | |
| GET | |
| PATCH | |
| DELETE | 
List all environments exports
Required API key scopes
export:readPath parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Query parameters
- limitintegerNumber of results to return per page. 
- offsetintegerThe initial index from which to return the results. 
Response
Example request
GET Example response
Status 200
List all environments exports
Required API key scopes
export:readPath parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Query parameters
- limitintegerNumber of results to return per page. 
- offsetintegerThe initial index from which to return the results. 
Response
Example request
GET Example response
Status 200
Create environments exports
Required API key scopes
export:writePath parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request parameters
- dashboardinteger
- insightinteger
- export_format
- export_context
- expires_afterstring
Response
Example request
POST Example response
Status 201
Create environments exports
Required API key scopes
export:writePath parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request parameters
- dashboardinteger
- insightinteger
- export_format
- export_context
- expires_afterstring
Response
Example request
POST Example response
Status 201
Retrieve environments exports
Required API key scopes
export:readPath parameters
- idintegerA unique integer value identifying this exported asset. 
- project_idstringProject 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 Example response
Status 200
Retrieve environments exports
Required API key scopes
export:readPath parameters
- idintegerA unique integer value identifying this exported asset. 
- project_idstringProject 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 Example response
Status 200
Retrieve environments exports content
Required API key scopes
export:readPath parameters
- idintegerA unique integer value identifying this exported asset. 
- project_idstringProject 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 Example response
Status 200 No response body
Retrieve environments exports content
Required API key scopes
export:readPath parameters
- idintegerA unique integer value identifying this exported asset. 
- project_idstringProject 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 Example response
Status 200 No response body
List all environments file system
Required API key scopes
file_system:readPath parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Query parameters
- limitintegerNumber of results to return per page. 
- offsetintegerThe initial index from which to return the results. 
- searchstringA search term. 
Response
Example request
GET Example response
Status 200
List all environments file system
Required API key scopes
file_system:readPath parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Query parameters
- limitintegerNumber of results to return per page. 
- offsetintegerThe initial index from which to return the results. 
- searchstringA search term. 
Response
Example request
GET Example response
Status 200
Create environments file system
Required API key scopes
file_system:writePath parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Response
Example request
POST Example response
Status 201
Create environments file system
Required API key scopes
file_system:writePath parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Response
Example request
POST Example response
Status 201
Retrieve environments file system
Required API key scopes
file_system:readPath parameters
- idstringA UUID string identifying this file system. 
- project_idstringProject 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 Example response
Status 200
Retrieve environments file system
Required API key scopes
file_system:readPath parameters
- idstringA UUID string identifying this file system. 
- project_idstringProject 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 Example response
Status 200
Update environments file system
Required API key scopes
file_system:writePath parameters
- idstringA UUID string identifying this file system. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Response
Example request
PATCH Example response
Status 200
Update environments file system
Required API key scopes
file_system:writePath parameters
- idstringA UUID string identifying this file system. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request parameters
- pathstring
- typestring
- refstring
- hrefstring
- meta
- shortcutboolean
Response
Example request
PATCH Example response
Status 200
Delete environments file system
Required API key scopes
file_system:writePath parameters
- idstringA UUID string identifying this file system. 
- project_idstringProject 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 Example response
Status 204 No response body
Delete environments file system
Required API key scopes
file_system:writePath parameters
- idstringA UUID string identifying this file system. 
- project_idstringProject 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