ActiveGate remote configuration management API - GET finished jobs
Lists completed configuration job for ActiveGates.
The request produces an application/json
payload.
GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/remoteConfigurationManagement |
Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement |
Authentication
To execute this request, you need an access token with activeGates.read
scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
from | string | The start of the requested timeframe for a remote configuration management job. You can use one of the following formats:
| query | optional |
to | string | The end of the requested timeframe for a remote configuration management job. You can use one of the following formats:
If not set, the current timestamp is used. | query | optional |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Remote | Success |
4XX | Error | Client side error. |
5XX | Error | Server side error. |
Response body objects
The RemoteConfigurationManagementJobList
object
A list of remote configuration management jobs.
Element | Type | Description |
---|---|---|
jobs | Remote | A list of remote configuration management jobs. |
The RemoteConfigurationManagementJobSummary
object
Remote configuration management job with basic data.
Element | Type | Description |
---|---|---|
endTime | string | Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was finished. This field is present only for finished jobs. |
entityType | string | Type of entities modified by remote configuration management.
|
id | string | The ID of the remote configuration management job. |
startTime | string | Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was started. |
Response body JSON model
{"jobs": [{"endTime": "2020-11-05T08:15:30.144Z","entityType": "ACTIVE_GATE or ONE_AGENT","id": "7974003406714390819","startTime": "2020-11-05T08:15:30.144Z"}]}