Extensions 2.0 API - GET list of monitoring configuration events

Reference
Published Apr 07, 2021

This API is deprecated.

Lists events linked to the specified monitoring configuration.

The request produces an application/json payload.

GET	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/events`
GET	Environment ActiveGateCluster ActiveGate	`https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/extensions/{extensionName}/monitoringConfigurations/{configurationId}/events`

Authentication

To execute this request, you need an access token with extensionConfigurations.read scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
extensionName	string	The name of the requested extension 2.0.	path	required
configurationId	string	The ID of the requested monitoring configuration.	path	required
from	string	The start of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week. You can also specify relative timeframe without an alignment: `now-NU`. Supported time units for the relative timeframe are: `m`: minutes `h`: hours `d`: days `w`: weeks `M`: months `y`: years If not set, the relative timeframe of two hours is used (`now-2h`).	query	optional
to	string	The end of the requested timeframe. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week. You can also specify relative timeframe without an alignment: `now-NU`. Supported time units for the relative timeframe are: `m`: minutes `h`: hours `d`: days `w`: weeks `M`: months `y`: years If not set, the current timestamp is used.	query	optional
dt.entity.host	string	Host that uses this monitoring configuration. Example: `HOST-ABCDEF0123456789`	query	optional
dt.active_gate.id	string	Hexadecimal ID of Active Gate that uses this monitoring configuration. Example: `0x1a2b3c4d`	query	optional
dt.extension.ds	string	Data source that uses this monitoring configuration. Example: `snmp`	query	optional
content	string	Content of the event	query	optional
status	string	Status of the event `ERROR` `INFO` `NONE` `WARN`	query	optional

Response

Response codes

Code	Type	Description
200	ExtensionEventsList	Success
404	ErrorEnvelope	Failed. The requested resource doesn't exist.
4XX	ErrorEnvelope	Client side error.
5XX	ErrorEnvelope	Server side error.

Response body objects

The `ExtensionEventsList` object

Element	Type	Description
extensionEvents	ExtensionEventDto[]	A list of extension events.

The `ExtensionEventDto` object

A list of extension events.

Element	Type	Description
content	string	Content of the event
dt.active_gate.id	string	Hexadecimal ID of Active Gate that uses this monitoring configuration. Example: `0x1a2b3c4d`
dt.entity.host	string	Host that uses this monitoring configuration. Example: `HOST-ABCDEF0123456789`
dt.extension.ds	string	Data source that uses this monitoring configuration. Example: `snmp`
severity	string	Severity of the event
status	string	Status of the event `ERROR` `INFO` `NONE` `WARN`
timestamp	string	Timestamp of the event

Response body JSON model

{
  "extensionEvents": [
    {
      "content": "string",
      "dt.active_gate.id": "string",
      "dt.entity.host": "string",
      "dt.extension.ds": "string",
      "severity": "string",
      "status": "ERROR",
      "timestamp": "string"
    }
  ]
}

Extensions 1.0