Monitors
List Monitors
Maximum number of monitors to return.
1000MonitorListResponseWrapper defines the response structure for listing monitors.
No content
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
POST /api/monitors/list HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 199
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"limit": 1000
}No content
Get Monitor Definition (YAML)
UUID of the monitor to retrieve
MonitorYamlResponse defines the response structure for getting a monitor's YAML.
No content
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
GET /api/monitors/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*
No content
Create Monitor
CreateMonitorResponseWrapper defines the response structure for creating a monitor.
No content
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
POST /api/monitors HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2480
{
"annotations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"autoResolve": true,
"catalog": {
"category": "text",
"id": "text",
"tags": [
"text"
],
"version": 1
},
"category": "text",
"display": {
"contextHeaderLabels": [
"text"
],
"description": "text",
"header": "text",
"resourceHeaderLabels": [
"text"
]
},
"evaluationInterval": {
"interval": "text",
"pendingFor": "text"
},
"executionErrorState": "OK",
"isPaused": true,
"labels": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"measurementType": "state",
"model": {
"queries": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"dataType": "text",
"datasourceID": "text",
"datasourceType": "text",
"expression": "text",
"filters": "text",
"instantRollup": "text",
"name": "text",
"pipeline": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"function": "[Circular Reference]",
"metric": "text",
"template": "text"
},
"queryType": "text",
"relativeTimerange": {
"from": "text",
"to": "text"
},
"rollup": {
"function": "text",
"time": 1
},
"sqlPipeline": {
"except": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
],
"filters": "[Circular Reference]",
"from": "[Circular Reference]",
"groupBy": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
],
"having": "[Circular Reference]",
"limit": 1,
"offset": 1,
"orderBy": [
{
"direction": "text",
"selector": {
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
}
],
"selectors": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
]
}
}
],
"reducers": [
{
"expression": "text",
"inputName": "text",
"name": "text",
"relativeTimerange": {
"from": "text",
"to": "text"
},
"type": "text"
}
],
"thresholds": [
{
"inputName": "text",
"name": "text",
"operator": "gt",
"relativeTimerange": {
"from": "text",
"to": "text"
},
"values": [
1
]
}
]
},
"noDataState": "OK",
"routing": [
"text"
],
"severity": "text",
"team": "text",
"title": "text"
}No content
Update Monitor
UUID of the monitor to update
No content
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
PUT /api/monitors/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2480
{
"annotations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"autoResolve": true,
"catalog": {
"category": "text",
"id": "text",
"tags": [
"text"
],
"version": 1
},
"category": "text",
"display": {
"contextHeaderLabels": [
"text"
],
"description": "text",
"header": "text",
"resourceHeaderLabels": [
"text"
]
},
"evaluationInterval": {
"interval": "text",
"pendingFor": "text"
},
"executionErrorState": "OK",
"isPaused": true,
"labels": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"measurementType": "state",
"model": {
"queries": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"dataType": "text",
"datasourceID": "text",
"datasourceType": "text",
"expression": "text",
"filters": "text",
"instantRollup": "text",
"name": "text",
"pipeline": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"function": "[Circular Reference]",
"metric": "text",
"template": "text"
},
"queryType": "text",
"relativeTimerange": {
"from": "text",
"to": "text"
},
"rollup": {
"function": "text",
"time": 1
},
"sqlPipeline": {
"except": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
],
"filters": "[Circular Reference]",
"from": "[Circular Reference]",
"groupBy": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
],
"having": "[Circular Reference]",
"limit": 1,
"offset": 1,
"orderBy": [
{
"direction": "text",
"selector": {
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
}
],
"selectors": [
{
"additionalFilter": "text",
"alias": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"isNullable": true,
"key": "text",
"origin": "text",
"processors": [
{
"args": [
"text"
],
"op": "text"
}
],
"type": "text"
}
]
}
}
],
"reducers": [
{
"expression": "text",
"inputName": "text",
"name": "text",
"relativeTimerange": {
"from": "text",
"to": "text"
},
"type": "text"
}
],
"thresholds": [
{
"inputName": "text",
"name": "text",
"operator": "gt",
"relativeTimerange": {
"from": "text",
"to": "text"
},
"values": [
1
]
}
]
},
"noDataState": "OK",
"routing": [
"text"
],
"severity": "text",
"team": "text",
"title": "text"
}No content
Delete Monitor
UUID of the monitor to delete
No content
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
DELETE /api/monitors/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*
No content
Retrieves all silences with optional filtering.
Filter to show only active silences
Maximum number of silences to return
Number of silences to skip
No content
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
GET /api/monitors/silences HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*
No content
Creates a new silence for monitoring alerts.
Optional comment for the silence
End time for the silence (must be after StartsAt)
Start time for the silence
No content
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
POST /api/monitors/silences HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 182
{
"BackendID": "text",
"ClientID": "text",
"comment": "text",
"endsAt": "2025-09-01T13:54:41.184Z",
"matchers": [
{
"Name": "text",
"Type": 1,
"Value": "text"
}
],
"startsAt": "2025-09-01T13:54:41.184Z"
}No content
Retrieves a specific silence by its UUID.
UUID of the silence to retrieve
No content
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
GET /api/monitors/silences/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*
No content
Updates an existing silence by its UUID.
UUID of the silence to update
Optional comment for the silence
End time for the silence (must be after StartsAt)
Start time for the silence
No content
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
PUT /api/monitors/silences/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 182
{
"BackendID": "text",
"ClientID": "text",
"comment": "text",
"endsAt": "2025-09-01T13:54:41.184Z",
"matchers": [
{
"Name": "text",
"Type": 1,
"Value": "text"
}
],
"startsAt": "2025-09-01T13:54:41.184Z"
}No content
Deletes a silence by its UUID.
UUID of the silence to delete
No content
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
DELETE /api/monitors/silences/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*
No content
Executes a Prometheus query (instant or range) against the metrics server. Accepts either a direct 'promql' string or components ('pipeline', 'filters', 'conditions', 'subPipelines') to build the query.
No content
ErrorResponse defines a common error response structure.
ErrorResponse defines a common error response structure.
POST /api/metrics/query HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1529
{
"Conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"End": "2025-09-01T13:54:41.184Z",
"Filters": "text",
"Pipeline": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"function": {
"args": [
"text"
],
"name": "text",
"pipelines": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"function": {
"args": [
"text"
],
"name": "text",
"pipelines": "[Circular Reference]"
},
"metric": "text",
"template": "text"
}
]
},
"metric": "text",
"template": "text"
},
"Promql": "text",
"QueryType": "range",
"Start": "2025-09-01T13:54:41.184Z",
"Step": "text",
"SubPipelines": {
"ANY_ADDITIONAL_PROPERTY": {
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"function": {
"args": [
"text"
],
"name": "text",
"pipelines": [
{
"conditions": [
{
"additionalFilter": "text",
"autoComplete": true,
"filterKeys": [
"text"
],
"filters": [
{
"op": "text",
"value": null
}
],
"isNullable": true,
"key": "text",
"origin": "text",
"type": "text"
}
],
"function": {
"args": [
"text"
],
"name": "text",
"pipelines": "[Circular Reference]"
},
"metric": "text",
"template": "text"
}
]
},
"metric": "text",
"template": "text"
}
}
}No content
Last updated