• Home
  • API
  • Environment
  • Remote configuration management
  • OneAgent
  • GET a configuration job

OneAgent remote configuration management API - GET a configuration job

Gets parameters of a configuration job for OneAgents.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/{id}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/oneagents/remoteConfigurationManagement/{id}
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/{id}

Authentication

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

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

Parameters

ParameterTypeDescriptionInRequired
idstring

The ID of the required remote configuration management job.

pathrequired

Response

Response codes

CodeTypeDescription
200RemoteConfigurationManagementJob

Success

404ErrorEnvelope

Failed. The requested resource doesn't exist.

Response body objects

The RemoteConfigurationManagementJob object

Remote configuration management job.

ElementTypeDescription
processedEntitiesCountinteger

Number of entities that were already processed at the time the response was created.

totalEntitiesCountinteger

Total number of entities to process.

timeoutTimestring

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.

operationsRemoteConfigurationManagementOperation[]

A list of executed remote configuration management jobs.

entityTypestring

Type of entities modified by remote configuration management.

The element can hold these values
  • ACTIVE_GATE
  • ONE_AGENT
idstring

The ID of the remote configuration management job.

startTimestring

Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was started.

endTimestring

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.

ElementTypeDescription
attributestring

The attribute which is affected by the operation.

The element can hold these values
  • group
  • hostGroup
  • networkZone
valuestring

The value which should be assigned to given attribute.

operationstring

The operation performed on given attribute.

The element can hold these values
  • clear
  • set

Response body JSON model

json
{
  "processedEntitiesCount": 1,
  "totalEntitiesCount": 1,
  "timeoutTime": "2020-11-05T08:15:30.144Z",
  "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"
}