ActiveGate remote configuration management API - GET current job

Gets parameters of a currently running 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/current`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/remoteConfigurationManagement/current`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/current`

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

The request doesn't provide any configurable parameters.

Response

Response codes

Code	Type	Description
200	RemoteConfigurationManagementJob	Success
204		No remote configuration management job is currently running

Response body objects

The `RemoteConfigurationManagementJob` object

Remote configuration management job.

Element	Type	Description
processedEntitiesCount	integer	Number of entities that were already processed at the time the response was created.
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.
operations	RemoteConfigurationManagementOperation[]	A list of executed remote configuration management jobs.
entityType	string	Type of entities modified by remote configuration management. The element can hold these values `ACTIVE_GATE` `ONE_AGENT`
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.
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.

The `RemoteConfigurationManagementOperation` object

Definition of a single remote configuration management operation.

Element	Type	Description
attribute	string	The attribute which is affected by the operation. The element can hold these values `group` `hostGroup` `networkZone`
value	string	The value which should be assigned to given attribute.
operation	string	The operation performed on given attribute. The element can hold these values `clear` `set`

Response body JSON model

json
{
  "processedEntitiesCount": 1,
  "timeoutTime": "2020-11-05T08:15:30.144Z",
  "totalEntitiesCount": 1,
  "operations": [
    {
      "attribute": "networkZone",
      "value": "exampleNetworkZoneName",
      "operation": "set"
    }
  ],
  "entityType": "ACTIVE_GATE or ONE_AGENT",
  "id": "7974003406714390819",
  "startTime": "2020-11-05T08:15:30.144Z",
  "endTime": "2020-11-05T08:15:30.144Z"
}