ActiveGate remote configuration management API - GET a configuration job
Gets parameters of a configuration job for ActiveGates.
The request produces an application/json payload.
| GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/{id} |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/remoteConfigurationManagement/{id} | |
| Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/{id} |
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 |
|---|---|---|---|---|
| id | string | The ID of the required remote configuration management job. | path | required |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | RemoteConfigurationManagementJob | Success |
| 404 | ErrorEnvelope | Failed. The requested resource doesn't exist. |
| 4XX | ErrorEnvelope | Client side error. |
| 5XX | ErrorEnvelope | Server side error. |
Response body objects
The RemoteConfigurationManagementJob object
Remote configuration management job.
| 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. |
| operations | RemoteConfigurationManagementOperation[] | A list of executed remote configuration management jobs. |
| processedEntitiesCount | integer | Number of entities that were already processed at the time the response was created. |
| startTime | string | Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was started. |
| timeoutTime | string | Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the running remote configuration management job will time-out. This field is present only for running jobs. |
| totalEntitiesCount | integer | Total number of entities to process. |
The RemoteConfigurationManagementOperation object
Definition of a single remote configuration management operation.
| Element | Type | Description |
|---|---|---|
| attribute | string | The attribute which is affected by the operation.
|
| operation | string | The operation performed on given attribute.
|
| value | string | The value which should be assigned to given attribute. |
Response body JSON model
{"endTime": "2020-11-05T08:15:30.144Z","entityType": "ACTIVE_GATE or ONE_AGENT","id": "7974003406714390819","operations": [{"attribute": "networkZone","operation": "set","value": "exampleNetworkZoneName"}],"processedEntitiesCount": 1,"startTime": "2020-11-05T08:15:30.144Z","timeoutTime": "2020-11-05T08:15:30.144Z","totalEntitiesCount": 1}