Monitored Entities
Published 04 April 2024
The Monitored entities endpoints allow you to retrieve monitored entity types and monitored entities. Additional documentation for this endpoint can be found by navigating to http://your-web-server:port/api-docs.
Monitored entity types
/api/v1/monitored-entities/types
The monitored entity types endpoint provides a list of entity types in Redgate monitor that can be used in retrieving data from the monitored entities endpoint.
Attributes
| entityType | The specific unique entity type |
|---|---|
| description | Detailed information about the specific monitored entity type |
Limitation
| Rate limit | Defaults to 100 API requests per minute, you can refer rate limiting to change these default values. |
|---|
Monitored entities
/api/v1/monitored-entities
The monitored entities endpoint provides a list of monitored entities on Redgate Monitor
Parameters
| Name | Mandatory/Optional | Type | Default | Description |
|---|---|---|---|---|
| entityType | Optional | String | None | Entity type which can be retrieved from the monitored entities types endpoint |
Attributes
| id | The unique identifier of a monitored entity |
|---|---|
| displayName | Name of the monitored entity |
| type | The monitored entity type |
| fullyQualifiedName | The full name of the entity including it parent or Alias of the monitored entity if it has been set in Redgate Monitor |
| group | The group the monitored entity belongs to. |
| monitoringStatus | The state in which the monitored entity is in, possible values are Monitoring, Not Monitoring and Suspended |
| parentId | The parent entity id of the monitored entity, the value is null if the specific entity is the highest level. |
Limitation
| Rate limit | Defaults to 100 API requests per minute, you can refer rate limiting to change these default values. |
|---|
