ActiveGate remote configuration management API - GET current job

  • Reference
  • Published Oct 06, 2022

Gets parameters of a currently running configuration job for ActiveGates.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/current
Environment and Cluster ActiveGate (default port 9999)https://{your-activegate-domain}:9999/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

CodeTypeDescription
200RemoteConfigurationManagementJob

Success

204-

No remote configuration management job is currently running

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The RemoteConfigurationManagementJob object

Remote configuration management job.

ElementTypeDescription
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.

entityTypestring

Type of entities modified by remote configuration management.

The element can hold these values
  • ACTIVE_GATE
  • ONE_AGENT
failedEntitiesRemoteIdentityOperationFailedEntityDto[]

A list of failed remote configuration management jobs.

idstring

The ID of the remote configuration management job.

inProgressEntitiesstring[]

A list of in-progress remote configuration management jobs.

operationsRemoteConfigurationManagementOperation[]

A list of executed (successful and failed) remote configuration management jobs.

processedEntitiesCountinteger

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

startTimestring

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

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.

totalEntitiesCountinteger

Total number of entities to process.

The RemoteIdentityOperationFailedEntityDto object

Failed remote configuration management information.

ElementTypeDescription
entityIdstring

Entity ID for which remote configuration management request was failed

failureMessagestring

Communication settings changing failure error description

failureReasonstring

Reason of communication settings changing failure.

The element can hold these values
  • CONNECTION_FAILURE
  • TIMEOUT

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
  • hostProperty
  • hostTag
  • networkZone
operationstring

The operation performed on given attribute.

The element can hold these values
  • clear
  • set
valuestring

The value which should be assigned to given attribute.

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "endTime": "2020-11-05T08:15:30.144Z",
  "entityType": "ACTIVE_GATE or ONE_AGENT",
  "failedEntities": [
    {
      "entityId": "HOST-D454A967666E7970",
      "failureMessage": "Failed to access new tenant: f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "failureReason": "CONNECTION_FAILURE"
    }
  ],
  "id": "7974003406714390819",
  "inProgressEntities": [
    "HOST-D454A967666E7970"
  ],
  "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
}
{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}