Customer
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
GET | |
POST | |
GET | |
PATCH | |
DELETE |
List all accounts
Required API key scopes
account:readQuery parameters
- account_executivestring
- account_ownerstring
- all_roles_unassignedboolean
- csmstring
- limitinteger
- offsetinteger
- orderingstringOne of:
"-created_at""-name""-updated_at""created_at""name""updated_at" - searchstring
- tagsstring
Response
Example request
GET /api /environments /:project_id /accountsExample response
Status 200
RESPONSE
Create accounts
Required API key scopes
account:writeRequest parameters
- namestring
- external_idstringnull
- propertiesobjectnull
- tagsarray
Response
Example request
POST /api /environments /:project_id /accountsExample response
Status 201
RESPONSE
Retrieve accounts
Required API key scopes
account:readPath parameters
- idstring
Response
Example request
GET /api /environments /:project_id /accounts /:idExample response
Status 200
RESPONSE
Update accounts
Required API key scopes
account:writePath parameters
- idstring
Request parameters
- namestring
- external_idstringnull
- propertiesobjectnull
- tagsarray
Response
Example request
PATCH /api /environments /:project_id /accounts /:idExample response
Status 200
RESPONSE
Delete accounts
Required API key scopes
account:writePath parameters
- idstring
Example request
DELETE /api /environments /:project_id /accounts /:idExample response
Status 204 No response body
List all groups types metrics
Required API key scopes
usage_metric:readPath parameters
- group_type_indexinteger
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /projects /:project_id /groups_types /:group_type_index /metricsExample response
Status 200
RESPONSE
Create groups types metrics
Required API key scopes
usage_metric:writePath parameters
- group_type_indexinteger
Request parameters
- namestring
- formatDefault:
numeric - intervalintegerDefault:
7 - displayDefault:
number - filtersobject
- mathDefault:
count - math_propertystringnull
Response
Example request
POST /api /projects /:project_id /groups_types /:group_type_index /metricsExample response
Status 201
RESPONSE
Retrieve groups types metrics
Required API key scopes
usage_metric:readPath parameters
- group_type_indexinteger
- idstring
Response
Example request
GET /api /projects /:project_id /groups_types /:group_type_index /metrics /:idExample response
Status 200
RESPONSE
Update groups types metrics
Required API key scopes
usage_metric:writePath parameters
- group_type_indexinteger
- idstring
Request parameters
- namestring
- formatDefault:
numeric - intervalintegerDefault:
7 - displayDefault:
number - filtersobject
- mathDefault:
count - math_propertystringnull
Response
Example request
PATCH /api /projects /:project_id /groups_types /:group_type_index /metrics /:idExample response
Status 200
RESPONSE
Delete groups types metrics
Required API key scopes
usage_metric:writePath parameters
- group_type_indexinteger
- idstring
Example request
DELETE /api /projects /:project_id /groups_types /:group_type_index /metrics /:id