Environments-14
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
POST | |
GET | |
PATCH | |
DELETE | |
GET | |
POST | |
GET | |
POST | |
GET | |
GET |
Create environments file system shortcut
Required API key scopes
file_system_shortcut: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
- pathstring
- typestring
- refstring
- hrefstring
Response
Example request
POST
/api /environments /:project_id /file_system_shortcut
Example response
Status 201
Retrieve environments file system shortcut
Required API key scopes
file_system_shortcut:read
Path parameters
- idstring
A UUID string identifying this file system shortcut.
- 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 /file_system_shortcut /:id
Example response
Status 200
Retrieve environments file system shortcut
Required API key scopes
file_system_shortcut:read
Path parameters
- idstring
A UUID string identifying this file system shortcut.
- 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 /file_system_shortcut /:id
Example response
Status 200
Update environments file system shortcut
Required API key scopes
file_system_shortcut:write
Path parameters
- idstring
A UUID string identifying this file system shortcut.
- 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
- pathstring
- typestring
- refstring
- hrefstring
Response
Example request
PATCH
/api /environments /:project_id /file_system_shortcut /:id
Example response
Status 200
Update environments file system shortcut
Required API key scopes
file_system_shortcut:write
Path parameters
- idstring
A UUID string identifying this file system shortcut.
- 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
- pathstring
- typestring
- refstring
- hrefstring
Response
Example request
PATCH
/api /environments /:project_id /file_system_shortcut /:id
Example response
Status 200
Delete environments file system shortcut
Required API key scopes
file_system_shortcut:write
Path parameters
- idstring
A UUID string identifying this file system shortcut.
- 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 /file_system_shortcut /:id
Example response
Status 204 No response body
Delete environments file system shortcut
Required API key scopes
file_system_shortcut:write
Path parameters
- idstring
A UUID string identifying this file system shortcut.
- 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 /file_system_shortcut /:id
Example response
Status 204 No response body
List all environments groups
List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/
Required API key scopes
group: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
- cursorstring
The pagination cursor value.
- group_type_indexinteger
Specify the group type to list
- searchstring
Search the group name
Response
Example request
GET
/api /environments /:project_id /groups
Example response
Status 200
List all environments groups
List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/
Required API key scopes
group: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
- cursorstring
The pagination cursor value.
- group_type_indexinteger
Specify the group type to list
- searchstring
Search the group name
Response
Example request
GET
/api /environments /:project_id /groups
Example response
Status 200
Create environments groups
Required API key scopes
group: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
- group_type_indexinteger
- group_keystring
- group_properties
Response
Example request
POST
/api /environments /:project_id /groups
Example response
Status 201
Create environments groups
Required API key scopes
group: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
- group_type_indexinteger
- group_keystring
- group_properties
Response
Example request
POST
/api /environments /:project_id /groups
Example response
Status 201
Retrieve environments groups activity
Required API key scopes
activity_log: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
- group_type_indexinteger
Specify the group type to find
- idstring
Specify the id of the user to find groups for
Example request
GET
/api /environments /:project_id /groups /activity
Example response
Status 200 No response body
Retrieve environments groups activity
Required API key scopes
activity_log: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
- group_type_indexinteger
Specify the group type to find
- idstring
Specify the id of the user to find groups for
Example request
GET
/api /environments /:project_id /groups /activity
Example response
Status 200 No response body
Create environments groups delete property
Required API key scopes
group: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/.
Query parameters
- group_keystring
Specify the key of the group to find
- group_type_indexinteger
Specify the group type to find
Request parameters
- group_type_indexinteger
- group_keystring
- group_properties
Example request
POST
/api /environments /:project_id /groups /delete_property
Example response
Status 200 No response body
Create environments groups delete property
Required API key scopes
group: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/.
Query parameters
- group_keystring
Specify the key of the group to find
- group_type_indexinteger
Specify the group type to find
Request parameters
- group_type_indexinteger
- group_keystring
- group_properties
Example request
POST
/api /environments /:project_id /groups /delete_property
Example response
Status 200 No response body
Retrieve environments groups find
Required API key scopes
group: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
- group_keystring
Specify the key of the group to find
- group_type_indexinteger
Specify the group type to find
Example request
GET
/api /environments /:project_id /groups /find
Example response
Status 200 No response body
Retrieve environments groups find
Required API key scopes
group: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
- group_keystring
Specify the key of the group to find
- group_type_indexinteger
Specify the group type to find
Example request
GET
/api /environments /:project_id /groups /find
Example response
Status 200 No response body
Retrieve environments groups property definitions
Required API key scopes
group: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 /groups /property_definitions