Redgate Monitor 14

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

MonitoredServer

Represents a monitored server (server, cluster, or cloud instance).

Attribute	Type	Nullable	Description
`EntityId`	string	NO	Opaque, URL-safe identifier for this server. Pass this value to `GET /monitored-servers/{entityId}` to retrieve the server directly, or as an `entityIds` filter on other v2 endpoints (e.g. `GET /metrics/data`).
`Name`	string	NO	The display name of the server.
`Alias`	string	YES	Optional user-defined alias for the server. `null` when no alias has been set.
`EntityType`	string	NO	The type of server (e.g. `SqlServer`, `LinuxMachine`). See Entity types.
`Group`	string	NO	The top-level group this server belongs to.
`Status`	MonitoredEntityStatusCategory	NO	The current monitoring status of the server.
`Tags`	string array	NO	User-defined tags attached to this server.
`ParentEntityId`	string	YES	ID of the parent server, if this server is nested (e.g. a SQL Server under a host machine). `null` for top-level servers.

MonitoredEntityStatusCategory

The monitoring status of a server.

Value
`Monitoring`
`Suspended`
`NotMonitoring`
`CredentialDecryptionFailed`

Entity types

The values the entity type fields (MonitoredServer.EntityType, Metric.SupportedServerTypes, MetricSeries.EntityType, MetricParentEntity.EntityType) and the entityType / supportedServerTypes query parameters can take.

Value	Description
`AmazonRdsHost`	Amazon RDS host instance
`AmazonRdsSqlServer`	Amazon RDS SQL Server instance
`AzureFlexHost`	A host running an Azure Database Flexible Server deployment
`AzureManagedInstance`	Azure SQL Managed Instance
`AzureSqlDatabase`	An individual Azure SQL Database, hosted under an Azure SQL logical server
`AzureSqlServer`	Virtual SQL Server in Azure used to group Azure SQL Databases
`Cluster`	Windows cluster instance (This will be a machine in the case of a standalone machine)
`GoogleCloudHost`	A host for a Google Cloud SQL instance
`LinuxMachine`	Linux machine instance
`Machine`	Windows machine which hosts a SQL Server instance
`MongoDbInstance`	A MongoDB instance
`MySqlInstance`	A MySQL instance
`OracleDataGuard`	An Oracle Data Guard configuration
`OracleInstance`	An Oracle Database instance
`PostgresServer`	Postgres server instance
`SqlServer`	Sql Server instance on a Windows machine
`SqlServerInstance`	Sql Server instance on a Linux machine

Metric

Describes a metric available for querying.

Attribute	Type	Nullable	Description
`Id`	string	NO	Opaque identifier for this metric. Pass this value as `metricIds` in `GET /metrics/data` to retrieve sampled data.
`Name`	string	NO	Human-readable display name of the metric.
`SupportedServerTypes`	string array	NO	Server types this metric applies to (e.g. `Machine`, `SqlServer`). See Entity types.

MetricSeries

A time series of data points for one metric and one monitored entity.

Attribute	Type	Nullable	Description
`MetricId`	string	NO	ID of the metric this series belongs to (matches `Metric.Id`).
`MetricName`	string	NO	Display name of the metric.
`EntityType`	string	NO	Type of the entity this series belongs to. See Entity types.
`EntityId`	string	NO	Opaque entity ID for the entity directly attached to metric. Pass this value or any entity id in the server hierarchy as `entityIds` in `GET /metrics/data` to restrict future queries to this entity.
`EntityName`	string	NO	Display name of the entity.
`DataUnit`	string	NO	Unit of measurement for the data values (e.g. `Milliseconds`, `Percent`). Dimensionless metrics use `Number`.
`DataPoints`	MetricDataPoint array	NO	Ordered list of sampled values over the requested time range. Empty when no data exists for the range.
`ParentEntity`	MetricParentEntity	NO	The parent entity in the server hierarchy (e.g. the host machine for a SQL Server instance). `null` for top-level entities.

MetricParentEntity

Identifies a parent entity in the server hierarchy.

Attribute	Type	Nullable	Description
`EntityId`	string	NO	Opaque entity ID.
`EntityName`	string	NO	Display name of the entity.
`EntityType`	string	NO	Type of the entity. See Entity types.
`ParentEntity`	MetricParentEntity	NO	Further ancestor in the hierarchy, if any. `null` at the top of the hierarchy; the chain terminates when this field is `null`.

MetricDataPoint

A single sampled value at a point in time.

Attribute	Type	Nullable	Description
`Timestamp`	string	NO	UTC timestamp of the sample.
`Value`	double	NO	The measured value. Units are specified by `MetricSeries.DataUnit`.

JSendFailure

The JSend "fail" envelope — the request was rejected because of something in the request itself (bad parameters, not found).

Attribute	Type	Nullable	Description
`status`	string	NO	Always `fail` for this envelope.
`data`	object	NO	Map of field name to the validation message for that field.

Example object

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

JSendError

The JSend "error" envelope — something went wrong that isn't about the request itself (rate limit, server error).

Attribute	Type	Nullable	Description
`status`	string	NO	Always `error` for this envelope.
`message`	string	NO	Human-readable description of what went wrong.

Example object

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

JSendMessageOnlyError

The JSend "error" envelope returned for authentication and authorization failures (401, 403). Same shape as JSendError.

Attribute	Type	Nullable	Description
`status`	string	NO	Always `error` for this envelope.
`message`	string	NO	Human-readable description of what went wrong.

Example object

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

ProblemDetails

An RFC 7807 problem response, returned for 429 (Too Many Requests).

Attribute	Type	Nullable	Description
`Type`	string	YES	A URI reference identifying the problem type.
`Title`	string	YES	A short, human-readable summary of the problem type.
`Status`	int	YES	The HTTP status code for this occurrence of the problem.
`Detail`	string	YES	A human-readable explanation specific to this occurrence of the problem.
`Instance`	string	YES	A URI reference identifying the specific occurrence of the problem.

Redgate Monitor 14

Models

MonitoredServer

MonitoredEntityStatusCategory

Entity types

Metric

MetricSeries

MetricParentEntity

MetricDataPoint

JSendFailure

JSendError

JSendMessageOnlyError

ProblemDetails