• Home
  • Dynatrace API
  • Environment
  • Remote configuration management
  • ActiveGate
  • POST a job preview

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.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/activeGates/remoteConfigurationManagement/preview
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/remoteConfigurationManagement/preview
Environment ActiveGatehttps://{your-activegate-domain}/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

ParameterTypeDescriptionInRequired
bodyRemoteConfigurationManagementOperationActiveGateRequest

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

bodyrequired

Request body objects

The RemoteConfigurationManagementOperationActiveGateRequest object

Remote configuration management operation creation request.

ElementTypeDescriptionRequired
entitiesstring[]

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

required
operationsRemoteConfigurationManagementOperation[]

A list of remote configuration management operations to be executed.

required

The RemoteConfigurationManagementOperation object

Definition of a single remote configuration management operation.

ElementTypeDescriptionRequired
attributestring

The attribute which is affected by the operation.

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

The value which should be assigned to given attribute.

optional
operationstring

The operation performed on given attribute.

The element can hold these values
  • clear
  • set
required

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.

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

Response

Response codes

CodeTypeDescription
200RemoteConfigurationManagementPreviewList

Success

400RemoteConfigurationManagementValidationResult

Failed. The input is invalid.

Response body objects

The RemoteConfigurationManagementPreviewList object

A list of remote configuration management jobs previews.

ElementTypeDescription
previewsRemoteConfigurationManagementJobPreview[]

A list of remote configuration management jobs previews.

The RemoteConfigurationManagementJobPreview object

A preview of remote configuration management job.

ElementTypeDescription
alreadyConfiguredEntitiesCountinteger

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

targetEntitiesCountinteger

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

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
{ "previews": [ { "alreadyConfiguredEntitiesCount": 1, "targetEntitiesCount": 2, "attribute": "networkZone", "value": "exampleNetworkZoneName", "operation": "set" } ] }