Monitors

post

List Monitors

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Body

application/json

limitinteger · int64Optional

Maximum number of monitors to return.

Default: 1000

Responses

200

MonitorListResponseWrapper defines the response structure for listing monitors.

No content

400

ErrorResponse defines a common error response structure.

500

ErrorResponse defines a common error response structure.

post

/api/monitors/list

HTTPcURLJavaScriptPython

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

Get Monitor Definition (YAML)

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

idstringRequired

UUID of the monitor to retrieve

Responses

200

MonitorYamlResponse defines the response structure for getting a monitor's YAML.

No content

400

ErrorResponse defines a common error response structure.

404

ErrorResponse defines a common error response structure.

500

ErrorResponse defines a common error response structure.

get

/api/monitors/{id}

HTTPcURLJavaScriptPython

GET /api/monitors/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*

No content

post

Create Monitor

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Body

application/x-yaml

Responses

200

CreateMonitorResponseWrapper defines the response structure for creating a monitor.

No content

400

ErrorResponse defines a common error response structure.

403

ErrorResponse defines a common error response structure.

409

ErrorResponse defines a common error response structure.

422

ErrorResponse defines a common error response structure.

500

NoContentResponse indicates success but that no response body is expected or included.

post

/api/monitors

HTTPcURLJavaScriptPython

POST /api/monitors HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/x-yaml
Accept: */*
Content-Length: 2061

{
  "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"
    ],
    "templateLanguage": "jinja2"
  },
  "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": {
          "domain": "text",
          "except": "[Circular Reference]",
          "filters": "[Circular Reference]",
          "from": "[Circular Reference]",
          "groupBy": "[Circular Reference]",
          "having": "[Circular Reference]",
          "join": "[Circular Reference]",
          "limit": 1,
          "limitBy": "[Circular Reference]",
          "mathExpression": "[Circular Reference]",
          "offset": 1,
          "orderBy": "[Circular Reference]",
          "selectors": "[Circular Reference]",
          "transforms": [
            {
              "alias": "text",
              "args": [
                "text"
              ],
              "sourceColumn": "text",
              "type": "json_unpack"
            }
          ]
        }
      }
    ],
    "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",
  "notificationSettings": {
    "renotificationInterval": null
  },
  "routing": [
    "text"
  ],
  "severity": "text",
  "team": "text",
  "title": "text"
}

No content

put

Update Monitor

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

idstringRequired

UUID of the monitor to update

Body

application/x-yaml

Responses

202

NoContentResponse indicates success but that no response body is expected or included.

400

ErrorResponse defines a common error response structure.

404

ErrorResponse defines a common error response structure.

409

ErrorResponse defines a common error response structure.

422

ErrorResponse defines a common error response structure.

500

ErrorResponse defines a common error response structure.

put

/api/monitors/{id}

HTTPcURLJavaScriptPython

PUT /api/monitors/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/x-yaml
Accept: */*
Content-Length: 2061

{
  "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"
    ],
    "templateLanguage": "jinja2"
  },
  "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": {
          "domain": "text",
          "except": "[Circular Reference]",
          "filters": "[Circular Reference]",
          "from": "[Circular Reference]",
          "groupBy": "[Circular Reference]",
          "having": "[Circular Reference]",
          "join": "[Circular Reference]",
          "limit": 1,
          "limitBy": "[Circular Reference]",
          "mathExpression": "[Circular Reference]",
          "offset": 1,
          "orderBy": "[Circular Reference]",
          "selectors": "[Circular Reference]",
          "transforms": [
            {
              "alias": "text",
              "args": [
                "text"
              ],
              "sourceColumn": "text",
              "type": "json_unpack"
            }
          ]
        }
      }
    ],
    "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",
  "notificationSettings": {
    "renotificationInterval": null
  },
  "routing": [
    "text"
  ],
  "severity": "text",
  "team": "text",
  "title": "text"
}

No content

delete

Delete Monitor

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

idstringRequired

UUID of the monitor to delete

Responses

200

NoContentResponse indicates success but that no response body is expected or included.

No content

400

ErrorResponse defines a common error response structure.

404

ErrorResponse defines a common error response structure.

500

ErrorResponse defines a common error response structure.

delete

/api/monitors/{id}

HTTPcURLJavaScriptPython

DELETE /api/monitors/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Get All Silences

get

Retrieves all silences with optional filtering.

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Query parameters

activebooleanOptional

Filter to show only active silences

limitinteger · int64Optional

Maximum number of silences to return

skipinteger · int64Optional

Number of silences to skip

Responses

200Success

No content

400

ErrorResponse defines a common error response structure.

500

ErrorResponse defines a common error response structure.

get

/api/monitors/silences

HTTPcURLJavaScriptPython

GET /api/monitors/silences HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Create Silence

post

Creates a new silence for monitoring alerts.

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Body

application/json

BackendIDstringOptional

ClientIDstringOptional

commentstringOptional

Optional comment for the silence

endsAtstring · date-timeRequired

End time for the silence (must be after StartsAt)

startsAtstring · date-timeRequired

Start time for the silence

Responses

200Success

No content

400

ErrorResponse defines a common error response structure.

500

ErrorResponse defines a common error response structure.

post

/api/monitors/silences

HTTPcURLJavaScriptPython

POST /api/monitors/silences HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "BackendID": "text",
  "ClientID": "text",
  "comment": "text",
  "endsAt": "2026-02-02T15:01:43.341Z",
  "matchers": [
    {
      "isEqual": true,
      "isRegex": true,
      "name": "text",
      "value": "text"
    }
  ],
  "startsAt": "2026-02-02T15:01:43.341Z"
}

No content

Get Silence by ID

get

Retrieves a specific silence by its UUID.

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

idstringRequired

UUID of the silence to retrieve

Responses

200Success

No content

400

ErrorResponse defines a common error response structure.

404

ErrorResponse defines a common error response structure.

500

ErrorResponse defines a common error response structure.

get

/api/monitors/silences/{id}

HTTPcURLJavaScriptPython

GET /api/monitors/silences/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Update Silence

put

Updates an existing silence by its UUID.

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

idstringRequired

UUID of the silence to update

Body

application/json

BackendIDstringOptional

ClientIDstringOptional

commentstringOptional

Optional comment for the silence

endsAtstring · date-timeOptional

End time for the silence (must be after StartsAt)

startsAtstring · date-timeOptional

Start time for the silence

Responses

200Success

No content

400

ErrorResponse defines a common error response structure.

500

ErrorResponse defines a common error response structure.

put

/api/monitors/silences/{id}

HTTPcURLJavaScriptPython

PUT /api/monitors/silences/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "BackendID": "text",
  "ClientID": "text",
  "comment": "text",
  "endsAt": "2026-02-02T15:01:43.341Z",
  "matchers": [
    {
      "isEqual": true,
      "isRegex": true,
      "name": "text",
      "value": "text"
    }
  ],
  "startsAt": "2026-02-02T15:01:43.341Z"
}

No content

Delete Silence

delete

Deletes a silence by its UUID.

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

idstringRequired

UUID of the silence to delete

Responses

200

NoContentResponse indicates success but that no response body is expected or included.

No content

400

ErrorResponse defines a common error response structure.

500

ErrorResponse defines a common error response structure.

delete

/api/monitors/silences/{id}

HTTPcURLJavaScriptPython

DELETE /api/monitors/silences/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Execute Prometheus query.

post

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Body

application/json

QueryRequest represents a request to query metrics

Endstring · date-timeOptional

End time for the query

FiltersstringOptional

GCQL filters to apply

PromqlstringOptional

Direct PromQL query string

QueryTypestring · enumOptional

Query type: either "range" or "instant" range MetricsQueryTypeRange instant MetricsQueryTypeInstant

Possible values:

Startstring · date-timeOptional

Start time for the query

StepstringOptional

Step duration for range queries (e.g., "1m", "5m")

Responses

200Success

No content

400

ErrorResponse defines a common error response structure.

500

ErrorResponse defines a common error response structure.

post

/api/metrics/query

HTTPcURLJavaScriptPython

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": "2026-02-02T15:01:43.341Z",
  "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": "2026-02-02T15:01:43.341Z",
  "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