Monitors

post

List Monitors

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Body

limitinteger · int64Optional

Maximum number of monitors to return (default 1000).

querystringOptional

GCQL filter string (filters only, no pipes or aggregations). Supported fields: monitor_name, type.

skipinteger · int64Optional

Number of monitors to skip for pagination.

sortstringOptional

Field to sort by: "name" (default) or "type".

Responses

200

MonitorListResponseWrapper defines the response structure for listing monitors.

application/json

donebooleanOptional

Whether all matching results have been returned (no more pages).

400

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

post

/api/monitors/list

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

{
  "conditions": [
    {
      "additionalFilter": "text",
      "autoComplete": true,
      "filterKeys": [
        "text"
      ],
      "filters": [
        {
          "op": "text",
          "value": null
        }
      ],
      "isNullable": true,
      "key": "text",
      "origin": "text",
      "type": "text"
    }
  ],
  "limit": 1,
  "query": "text",
  "skip": 1,
  "sort": "text"
}

{
  "done": true,
  "monitors": [
    {
      "title": "text",
      "type": "text",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

get

Get Monitor Definition (YAML)

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

UUID of the monitor to retrieve

Responses

200

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

application/json

integer · uint8[]Optional

400

ErrorResponse defines a common error response structure.

application/json

404

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

get

/api/monitors/{id}

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

[
  1
]

post

Create Monitor

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Body

autoResolvebooleanOptional

Whether the alert should auto-resolve.

categorystringOptional

Category of the monitor.

executionErrorStatestring · enumOptional

State to enter if execution fails.

Possible values:

isPausedbooleanOptional

Whether the monitor is paused.

measurementTypestring · enumOptional

Type of measurement (state or event).

Possible values:

noDataStatestring · enumOptional

State to enter if no data is returned.

Possible values:

routingstring[]Optional

Routing information.

severitystringOptional

Severity level (e.g., critical, warning, info).

teamstringOptional

Team associated with the monitor.

titlestringRequired

Title of the monitor.

Responses

200

CreateMonitorResponseWrapper defines the response structure for creating a monitor.

application/json

monitorIdstringOptional

The UUID of the newly created monitor.

400

ErrorResponse defines a common error response structure.

application/json

403

ErrorResponse defines a common error response structure.

application/json

409

ErrorResponse defines a common error response structure.

application/json

422

ErrorResponse defines a common error response structure.

application/json

500

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

post

/api/monitors

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

{
  "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]",
          "sample": 1,
          "selectors": "[Circular Reference]",
          "transforms": [
            {
              "alias": "text",
              "args": [
                "text"
              ],
              "sourceColumn": "text",
              "type": "json_unpack"
            }
          ],
          "union": "[Circular Reference]"
        }
      }
    ],
    "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": {
    "connectedApps": [
      "text"
    ],
    "disableRenotification": true,
    "method": "notificationRoutes",
    "renotificationInterval": null,
    "statusFilters": [
      "text"
    ]
  },
  "routing": [
    "text"
  ],
  "severity": "text",
  "team": "text",
  "title": "text"
}

{
  "monitorId": "text"
}

put

Update Monitor

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

UUID of the monitor to update

Body

autoResolvebooleanOptional

Whether the alert should auto-resolve.

categorystringOptional

Category of the monitor.

executionErrorStatestring · enumOptional

State to enter if execution fails.

Possible values:

isPausedbooleanOptional

Whether the monitor is paused.

measurementTypestring · enumOptional

Type of measurement (state or event).

Possible values:

noDataStatestring · enumOptional

State to enter if no data is returned.

Possible values:

routingstring[]Optional

Routing information.

severitystringOptional

Severity level (e.g., critical, warning, info).

teamstringOptional

Team associated with the monitor.

titlestringRequired

Title of the monitor.

Responses

202

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

400

ErrorResponse defines a common error response structure.

application/json

404

ErrorResponse defines a common error response structure.

application/json

409

ErrorResponse defines a common error response structure.

application/json

422

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

put

/api/monitors/{id}

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

{
  "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]",
          "sample": 1,
          "selectors": "[Circular Reference]",
          "transforms": [
            {
              "alias": "text",
              "args": [
                "text"
              ],
              "sourceColumn": "text",
              "type": "json_unpack"
            }
          ],
          "union": "[Circular Reference]"
        }
      }
    ],
    "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": {
    "connectedApps": [
      "text"
    ],
    "disableRenotification": true,
    "method": "notificationRoutes",
    "renotificationInterval": null,
    "statusFilters": [
      "text"
    ]
  },
  "routing": [
    "text"
  ],
  "severity": "text",
  "team": "text",
  "title": "text"
}

No content

delete

Delete Monitor

Required scopes

This endpoint requires the following scopes:

Authorizations

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.

application/json

404

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

delete

/api/monitors/{id}

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

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

application/json

activebooleanOptional

commentstringOptional

createdBystringOptional

createdByEmailstringOptional

endsAtstring · date-timeOptional

idstring · uuidOptional

recurringSilenceIdstring · uuidOptional

startsAtstring · date-timeOptional

400

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

get

/api/monitors/silences

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

[
  {
    "active": true,
    "comment": "text",
    "createdBy": "text",
    "createdByEmail": "text",
    "endsAt": "2026-03-27T20:01:57.336Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "matchers": [
      {
        "isEqual": true,
        "isRegex": true,
        "name": "text",
        "value": "text"
      }
    ],
    "recurringSilenceId": "123e4567-e89b-12d3-a456-426614174000",
    "startsAt": "2026-03-27T20:01:57.336Z"
  }
]

Create Silence

post

Creates a new silence for monitoring alerts.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Body

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

application/json

activebooleanOptional

commentstringOptional

createdBystringOptional

createdByEmailstringOptional

endsAtstring · date-timeOptional

idstring · uuidOptional

recurringSilenceIdstring · uuidOptional

startsAtstring · date-timeOptional

400

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

post

/api/monitors/silences

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-03-27T20:01:57.336Z",
  "matchers": [
    {
      "isEqual": true,
      "isRegex": true,
      "name": "text",
      "value": "text"
    }
  ],
  "startsAt": "2026-03-27T20:01:57.336Z"
}

{
  "active": true,
  "comment": "text",
  "createdBy": "text",
  "createdByEmail": "text",
  "endsAt": "2026-03-27T20:01:57.336Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "matchers": [
    {
      "isEqual": true,
      "isRegex": true,
      "name": "text",
      "value": "text"
    }
  ],
  "recurringSilenceId": "123e4567-e89b-12d3-a456-426614174000",
  "startsAt": "2026-03-27T20:01:57.336Z"
}

Get Silence by ID

get

Retrieves a specific silence by its UUID.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

UUID of the silence to retrieve

Responses

200Success

application/json

activebooleanOptional

commentstringOptional

createdBystringOptional

createdByEmailstringOptional

endsAtstring · date-timeOptional

idstring · uuidOptional

recurringSilenceIdstring · uuidOptional

startsAtstring · date-timeOptional

400

ErrorResponse defines a common error response structure.

application/json

404

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

get

/api/monitors/silences/{id}

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

{
  "active": true,
  "comment": "text",
  "createdBy": "text",
  "createdByEmail": "text",
  "endsAt": "2026-03-27T20:01:57.336Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "matchers": [
    {
      "isEqual": true,
      "isRegex": true,
      "name": "text",
      "value": "text"
    }
  ],
  "recurringSilenceId": "123e4567-e89b-12d3-a456-426614174000",
  "startsAt": "2026-03-27T20:01:57.336Z"
}

Update Silence

put

Updates an existing silence by its UUID.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Path parameters

idstringRequired

UUID of the silence to update

Body

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

application/json

activebooleanOptional

commentstringOptional

createdBystringOptional

createdByEmailstringOptional

endsAtstring · date-timeOptional

idstring · uuidOptional

recurringSilenceIdstring · uuidOptional

startsAtstring · date-timeOptional

400

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

put

/api/monitors/silences/{id}

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-03-27T20:01:57.336Z",
  "matchers": [
    {
      "isEqual": true,
      "isRegex": true,
      "name": "text",
      "value": "text"
    }
  ],
  "startsAt": "2026-03-27T20:01:57.336Z"
}

{
  "active": true,
  "comment": "text",
  "createdBy": "text",
  "createdByEmail": "text",
  "endsAt": "2026-03-27T20:01:57.336Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "matchers": [
    {
      "isEqual": true,
      "isRegex": true,
      "name": "text",
      "value": "text"
    }
  ],
  "recurringSilenceId": "123e4567-e89b-12d3-a456-426614174000",
  "startsAt": "2026-03-27T20:01:57.336Z"
}

Delete Silence

delete

Deletes a silence by its UUID.

Required scopes

This endpoint requires the following scopes:

Authorizations

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.

application/json

500

ErrorResponse defines a common error response structure.

application/json

delete

/api/monitors/silences/{id}

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

AuthorizationstringRequired

Body

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

application/json

400

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

post

/api/metrics/query

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-03-27T20:01:57.336Z",
  "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-03-27T20:01:57.336Z",
  "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 8 months ago

hashtagGet All Silences

hashtagCreate Silence

hashtagGet Silence by ID

hashtagUpdate Silence

hashtagDelete Silence

hashtagExecute Prometheus query.

Get All Silences

Create Silence

Get Silence by ID

Update Silence

Delete Silence

Execute Prometheus query.