ActiveGate auto-update configuration API - GET an ActiveGate

  • Reference
  • Published Mar 15, 2021

Gets the auto-update configuration of the specified Environment ActiveGate.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/autoUpdate
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/activeGates/{agId}/autoUpdate

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

ParameterTypeDescriptionInRequired
agIdstring

The ID of the required ActiveGate.

pathrequired

Response

Response codes

CodeTypeDescription
200ActiveGateAutoUpdateConfig

Success

404ErrorEnvelope

Not found. See response body for details.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ActiveGateAutoUpdateConfig object

Configuration of the ActiveGate auto-updates.

ElementTypeDescription
effectiveSettingstring

The actual state of the ActiveGate auto-update.

Applicable only if the setting parameter is set to INHERITED. In that case, the value is taken from the parent setting. Otherwise, it's just a duplicate of the setting value.

  • ENABLED
  • DISABLED
settingstring

The state of the ActiveGate auto-update: enabled, disabled, or inherited.

If set to INHERITED, the setting is inherited from the global configuration set on the environment or Managed cluster level.

  • DISABLED
  • ENABLED
  • INHERITED

Response body JSON model

{
  "effectiveSetting": "ENABLED",
  "setting": "INHERITED"
}