Anything Redgate Monitor is configured to monitor: database instances, the machines hosting them, clusters, and cloud instances. Servers are organized into groups and may be nested (e.g. a SQL Server instance under a host machine).

Operations

List monitored servers

Returns all monitored servers visible to the authenticated user, optionally filtered by status, tags, groups, or entity type. Each filter accepts one or more values (repeat the query parameter, e.g. ?status=Monitoring&status=Suspended). Filters combine with AND across the categories; values within a single filter combine with OR. Omitting a filter returns servers regardless of that property. This endpoint fans out to all Base Monitors and aggregates their results.

GET /api/v2/monitored-servers

curl -G https://your-host/api/v2/monitored-servers \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode "status=Monitoring" \
  --data-urlencode "tags=value" \
  --data-urlencode "groups=value" \
  --data-urlencode "entityType=AmazonRdsHost"

Query parameters

status array · enum OPTIONAL

Match servers whose status is one of the supplied values.

See MonitoredEntityStatusCategory.

tags array · string[] OPTIONAL

Match servers that carry at least one of the supplied tags (case-insensitive).

groups array · string[] OPTIONAL

Match servers whose top-level group is one of the supplied values (case-insensitive).

entityType array · entity-type · enum OPTIONAL

Match servers whose type is one of the supplied values.

See Entity types.

Responses

200 — The list of matching monitored servers (empty array if none match)

Response object: MonitoredServer array

{
  "data": [
    {
      "entityId": "r1,4:base,s36:4bba3b44-5634-4b33-aff8-f53c4315efe3,7:Cluster,1,4:Name,s15:dev-prod,",
      "name": "PROD-SQL-01",
      "alias": "Production SQL Server",
      "entityType": "SqlServer",
      "group": "Production",
      "status": "Monitoring",
      "tags": [
        "production",
        "finance"
      ],
      "parentEntityId": "r1,4:base,s36:4bba3b44-5634-4b33-aff8-f53c4315efe3,7:Cluster,1,4:Name,s15:dev-prod,"
    }
  ],
  "status": "success"
}

{
  "status": "fail",
  "data": {}
}

{
  "status": "error",
  "message": "string"
}

{
  "status": "error",
  "message": "string"
}

{
  "status": "fail",
  "data": {}
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "status": "error",
  "message": "string"
}

Get a monitored server

Returns the server with the given entityId. The entityId is an opaque, URL-safe string returned by GET /monitored-servers. It encodes both the server and the Base Monitor it belongs to, so it is not portable across Redgate Monitor installations.

GET /api/v2/monitored-servers/{entityId}

curl https://your-host/api/v2/monitored-servers/{entityId} \
  -H "Authorization: Bearer $TOKEN"

Path parameters

entityId string · entity-id REQUIRED

The entity ID, as returned by GET /monitored-servers.

Responses

200 — The requested server

Response object: MonitoredServer

{
  "data": {
    "entityId": "r1,4:base,s36:4bba3b44-5634-4b33-aff8-f53c4315efe3,7:Cluster,1,4:Name,s15:dev-prod,",
    "name": "PROD-SQL-01",
    "alias": "Production SQL Server",
    "entityType": "SqlServer",
    "group": "Production",
    "status": "Monitoring",
    "tags": [
      "production",
      "finance"
    ],
    "parentEntityId": "r1,4:base,s36:4bba3b44-5634-4b33-aff8-f53c4315efe3,7:Cluster,1,4:Name,s15:dev-prod,"
  },
  "status": "success"
}

{
  "status": "fail",
  "data": {}
}

{
  "status": "error",
  "message": "string"
}

{
  "status": "error",
  "message": "string"
}

{
  "status": "fail",
  "data": {}
}

{
  "status": "fail",
  "data": {}
}

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "status": "error",
  "message": "string"
}