Environments-12
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
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/.
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/.
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
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
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
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
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
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
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/.
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/.
Response
Status 200 No response body
Retrieve environments groups property values
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/.
Response
Status 200 No response body
Retrieve environments groups property values
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/.
Response
Status 200 No response body
Create environments groups update 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
Response
Status 200 No response body
Create environments groups update 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
Response
Status 200 No response body
List all environments hog functions
Required API key scopes
hog_function: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
- created_atstring
- created_byinteger
- enabledboolean
- idstring
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
- searchstring
A search term.
- typearray
Multiple values may be separated by commas.
- updated_atstring
Response
Status 200
List all environments hog functions
Required API key scopes
hog_function: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
- created_atstring
- created_byinteger
- enabledboolean
- idstring
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
- searchstring
A search term.
- typearray
Multiple values may be separated by commas.
- updated_atstring
Response
Status 200
Create environments hog functions
Required API key scopes
hog_function: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/.
Response
Status 201
Create environments hog functions
Required API key scopes
hog_function: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/.