Redgate Monitor 14

Preview: The v2 API is in preview and may change without notice before it's generally available.

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

Method	Path	Description
GET	`/api/v2/monitored-servers`	List monitored servers
GET	`/api/v2/monitored-servers/{entityId}`	Get a monitored server

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.

Query parameters

status array · enum · OPTIONAL

Match servers whose status is one of the supplied values. Allowed values: 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. Allowed values: Entity types.

GET /api/v2/monitored-servers

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

Responses

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"
}

Response object: JSendFailure

{
  "status": "fail",
  "data": {
    "<field>": "<message>"
  }
}

Response object: JSendMessageOnlyError

{
  "status": "error",
  "message": "<text>"
}

Response object: JSendMessageOnlyError

{
  "status": "error",
  "message": "<text>"
}

Response object: JSendFailure

{
  "status": "fail",
  "data": {
    "<field>": "<message>"
  }
}

Response object: ProblemDetails

No example available.

Response object: JSendError

{
  "status": "error",
  "message": "<text>"
}

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.

Path parameters

entityId string · entity-id · REQUIRED

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

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

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

Responses

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"
}

Response object: JSendFailure

{
  "status": "fail",
  "data": {
    "<field>": "<message>"
  }
}

Response object: JSendMessageOnlyError

{
  "status": "error",
  "message": "<text>"
}

Response object: JSendMessageOnlyError

{
  "status": "error",
  "message": "<text>"
}

Response object: JSendFailure

{
  "status": "fail",
  "data": {
    "<field>": "<message>"
  }
}

Response object: JSendFailure

{
  "status": "fail",
  "data": {
    "<field>": "<message>"
  }
}

Response object: ProblemDetails

No example available.

Response object: JSendError

{
  "status": "error",
  "message": "<text>"
}

Redgate Monitor 14

Monitored servers

Operations

List monitored servers

Query parameters

GET /api/v2/monitored-servers

Responses

Get a monitored server

Path parameters

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

Responses