MonitoringUsers

API reference

Every HTTP endpoint of the monitoring module: authentication, IAM action, parameters, bodies and status codes.

Generated from the module's code when its image was built — do not edit. Paths are relative to https://api.example.com.

Docs

`GET /docs/monitoring/manifest.json`

Authentication: required
Operation name: DocsManifest_monitoring

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid

`GET /docs/monitoring/{path}`

Authentication: required
Operation name: DocsFile_monitoring

Parameters

Name	In	Type	Required
`path`	path	`string`	Yes

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid

Monitoring & Alerts

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/monitoring/{resourceType}/{resourceName}`

Authentication: required
IAM action: monitoring/read — evaluated at the resource in the path

Parameters

Name	In	Type	Required
`boundaryId`	path	`uuid`	Yes
`resourceGroupName`	path	`string`	Yes
`resourceType`	path	`string`	Yes
`resourceName`	path	`string`	Yes
`aggregation`	query	`string`	Yes
`container`	query	`string`	No
`from`	query	`date-time`	Yes
`metric`	query	`string`	Yes
`to`	query	`date-time`	Yes

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid
`403`	The caller does not hold monitoring/read at the evaluated scope

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/monitoring/{resourceType}/{resourceName}/alerts`

Authentication: required
IAM action: monitoring/read — evaluated at the resource in the path

Parameters

Name	In	Type	Required
`boundaryId`	path	`uuid`	Yes
`resourceGroupName`	path	`string`	Yes
`resourceType`	path	`string`	Yes
`resourceName`	path	`string`	Yes
`includeResolved`	query	`boolean`	No
`limit`	query	`integer`	No

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid
`403`	The caller does not hold monitoring/read at the evaluated scope

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/monitoring/{resourceType}/{resourceName}/requests`

Authentication: required
IAM action: monitoring/read — evaluated at the resource in the path

Parameters

Name	In	Type	Required
`boundaryId`	path	`uuid`	Yes
`resourceGroupName`	path	`string`	Yes
`resourceType`	path	`string`	Yes
`resourceName`	path	`string`	Yes
`from`	query	`date-time`	Yes
`to`	query	`date-time`	Yes

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid
`403`	The caller does not hold monitoring/read at the evaluated scope

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/monitoring/{resourceType}/{resourceName}/utilization`

Authentication: required
IAM action: monitoring/read — evaluated at the resource in the path

Parameters

Name	In	Type	Required
`boundaryId`	path	`uuid`	Yes
`resourceGroupName`	path	`string`	Yes
`resourceType`	path	`string`	Yes
`resourceName`	path	`string`	Yes
`from`	query	`date-time`	Yes
`metric`	query	`string`	Yes
`to`	query	`date-time`	Yes

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid
`403`	The caller does not hold monitoring/read at the evaluated scope

`GET /boundaries/{boundaryId}/resources/monitoring/alerts`

Authentication: required
IAM action: monitoring/read — evaluated at the resource in the path

Parameters

Name	In	Type	Required
`boundaryId`	path	`uuid`	Yes

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid
`403`	The caller does not hold monitoring/read at the evaluated scope

Platform Monitoring

`GET /admin/monitoring/alerts`

Authentication: required
IAM action: monitoring/platform/read — evaluated at the platform root
Operation name: GetPlatformAlerts

Parameters

Name	In	Type	Required
`includeResolved`	query	`boolean`	No

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid
`403`	The caller does not hold monitoring/platform/read at the evaluated scope

`POST /admin/monitoring/alerts`

Authentication: required
IAM action: monitoring/platform/alerts/write — evaluated at the platform root
Operation name: IngestPlatformAlert

Request body: AlertIngestRequest

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid
`403`	The caller does not hold monitoring/platform/alerts/write at the evaluated scope

`GET /admin/monitoring/metrics`

Authentication: required
IAM action: monitoring/platform/read — evaluated at the platform root
Operation name: GetPlatformMetric

Parameters

Name	In	Type	Required
`aggregation`	query	`string`	Yes
`from`	query	`date-time`	Yes
`metric`	query	`string`	Yes
`resourceType`	query	`string`	No
`to`	query	`date-time`	Yes

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid
`403`	The caller does not hold monitoring/platform/read at the evaluated scope

`GET /admin/monitoring/nodes`

Authentication: required
IAM action: monitoring/platform/read — evaluated at the platform root
Operation name: GetPlatformNodeHealth

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid
`403`	The caller does not hold monitoring/platform/read at the evaluated scope

`GET /admin/monitoring/storage/claims`

Authentication: required
IAM action: monitoring/platform/read — evaluated at the platform root
Operation name: GetPlatformClaimStorage

Parameters

Name	In	Type	Required
`claim`	query	`string` `[]`	No
`lookbackMinutes`	query	`integer`	No
`namespace`	query	`string`	No

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid
`403`	The caller does not hold monitoring/platform/read at the evaluated scope

`GET /admin/monitoring/storage/volumes`

Authentication: required
IAM action: monitoring/platform/read — evaluated at the platform root
Operation name: GetPlatformUnhealthyVolumes

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid
`403`	The caller does not hold monitoring/platform/read at the evaluated scope

Other endpoints

`GET /readyz`

Authentication: none — anonymous callers are accepted
Operation name: StackshipReadiness

Responses

Status	Meaning	Body

Schemas

`AlertIngestRequest`

Property	Type	Nullable
`alertId`	`string`	No
`detail`	`string`	No
`level`	`AlertLevel`	No
`metadata`	`map` (`string`)	No
`resourceName`	`string`	No
`resourceType`	`string`	No
`status`	`AlertIngestStatus`	Yes
`subject`	`string`	No
`title`	`string`	No

`AlertIngestStatus`

One of: Firing, Resolved.

`AlertLevel`

One of: 0 = Recommendation, 1 = Information, 2 = Warning, 3 = Error, 4 = Critical, 5 = Insight.