ActiveGate remote configuration management API - POST a job preview

You can generate a preview before performing the actual configuration change.

The preview tells you:

  • How many entities are currently configured as described in the payload
  • How many entities will be configured this way when the reconfiguration request is sent

The request consumes an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/remoteConfigurationManagement/preview
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/preview

Authentication

To execute this request, you need an access token with activeGates.write scope.

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

Parameters

Parameter
Type
Description
In
Required
body

JSON body of the request, containing remote configuration management job definition.

body
required

Request body objects

The RemoteConfigurationManagementOperationActiveGateRequest object

Remote configuration management operation creation request.

Element
Type
Description
Required
entities
string[]

A list of entities IDs for which remote configuration management is to be executed.

required
operations

A list of remote configuration management operations to be executed.

required

The RemoteConfigurationManagementOperation object

Definition of a single remote configuration management operation.

Element
Type
Description
Required
attribute
string

The attribute which is affected by the operation.

  • group
  • hostGroup
  • hostProperty
  • hostTag
  • networkZone
required
operation
string

The operation performed on given attribute.

  • clear
  • set
required
value
string

The value which should be assigned to given attribute.

optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "entities": [
    "0x2b7c0b02",
    "0x4928065d"
  ],
  "operations": [
    {
      "attribute": "networkZone",
      "operation": "set",
      "value": "exampleNetworkZoneName"
    }
  ]
}

Response

Response codes

Code
Type
Description
200

Success

400

Failed. The input is invalid.

4XX

Client side error.

5XX

Server side error.

Response body objects

The RemoteConfigurationManagementPreviewList object

A list of remote configuration management jobs previews.

Element
Type
Description
previews

A list of remote configuration management jobs previews.

The RemoteConfigurationManagementJobPreview object

A preview of remote configuration management job.

Element
Type
Description
alreadyConfiguredEntitiesCount
integer

The number of entities that are currently configured as defined by remote configuration management operation.

attribute
string

The attribute which is affected by the operation.

  • group
  • hostGroup
  • hostProperty
  • hostTag
  • networkZone
operation
string

The operation performed on given attribute.

  • clear
  • set
targetEntitiesCount
integer

The number of entities that will be configured as defined by remote configuration management after it is completed.

value
string

The value which should be assigned to given attribute.

Response body JSON model

{
  "previews": [
    {
      "alreadyConfiguredEntitiesCount": 1,
      "attribute": "networkZone",
      "operation": "set",
      "targetEntitiesCount": 2,
      "value": "exampleNetworkZoneName"
    }
  ]
}