The request consumes an application/json payload.
| POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/oneagents/remoteConfigurationManagement |
| Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement |
To execute this request, you need an access token with oneAgents.write scope.
To learn how to obtain and use it, see Tokens and authentication.
You identify your OneAgents by their IDs. Use the OneAgent on a host request to learn the IDs of OneAgents that you'd like to configure.
One Agents will be restarted (true) or not (false) after configuration. By default OneAgents will be restarted when network zone or host group are reconfigured - the restart is required to apply the changes.
JSON body of the request, containing remote configuration management job definition.
RemoteConfigurationManagementOperationOneAgentRequest objectRemote configuration management operation creation request.
A list of entities IDs for which remote configuration management is to be executed.
A list of remote configuration management operations to be executed.
RemoteConfigurationManagementOperation objectDefinition of a single remote configuration management operation.
The attribute which is affected by the operation.
grouphostGrouphostPropertyhostTagnetworkZoneThe operation performed on given attribute.
clearsetThe value which should be assigned to given attribute.
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"entities": ["HOST-D454A967666E7970","HOST-811760CFF2A5E872"],"operations": [{"attribute": "networkZone","operation": "set","value": "exampleNetworkZoneName"}]}
Other remote configuration management job is currently being executed
RemoteConfigurationManagementJob objectRemote configuration management job.
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.
Type of entities modified by remote configuration management.
ACTIVE_GATEONE_AGENTThe ID of the remote configuration management job.
A list of executed remote configuration management jobs.
Number of entities that were already processed at the time the response was created.
Date (in ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z') when the remote configuration management job was started.
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.
Total number of entities to process.
RemoteConfigurationManagementOperation objectDefinition of a single remote configuration management operation.
The attribute which is affected by the operation.
grouphostGrouphostPropertyhostTagnetworkZoneThe operation performed on given attribute.
clearsetThe value which should be assigned to given attribute.
{"endTime": "2020-11-05T08:15:30.144Z","entityType": "ACTIVE_GATE or ONE_AGENT","id": "7974003406714390819","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}
The response is not sent to the client until all OneAgents defined in the payload are processed. A OneAgent is considered to be processed when the reconfiguration message is sent to it; the actual reconfiguration is handled independently by the OneAgent.
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
The request consumes an application/json payload.
| POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/oneagents/remoteConfigurationManagement/validator |
| Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/oneagents/remoteConfigurationManagement/validator |
To execute this request, you need an access token with oneAgents.write scope.
To learn how to obtain and use it, see Tokens and authentication.
Success. Response doesn't have a body.