Edits the auto-update configuration of the specified Environment ActiveGate.
The request consumes an application/json payload.
| PUT | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/autoUpdate |
| Environment and Cluster ActiveGate (default port 9999) | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/activeGates/{agId}/autoUpdate |
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.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| agId | string | The ID of the required ActiveGate. | path | Required |
| body | Active | JSON body of the request, containing auto update parameters. | body | Required |
ActiveGateAutoUpdateConfig objectConfiguration of the ActiveGate auto-updates.
| Element | Type | Description | Required |
|---|---|---|---|
| effectiveSetting | string | The actual state of the ActiveGate auto-update. Applicable only if the setting parameter is set to The element can hold these values
| Optional |
| setting | string | The state of the ActiveGate auto-update: enabled, disabled, or inherited. If set to The element can hold these values
| Required |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"effectiveSetting": "ENABLED","setting": "INHERITED"}
| Code | Type | Description |
|---|---|---|
| 204 | - | Success. The auto-update configuration have been updated. Response doesn't have a body. |
| 400 | Error | Failed. The input is invalid. |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| code | integer | The HTTP status code |
| constraintViolations | Constraint | A list of constraint violations |
| message | string | The error message |
ConstraintViolation objectA list of constraint violations
| Element | Type | Description |
|---|---|---|
| location | string | - |
| message | string | - |
| parameterLocation | string | -The element can hold these values
|
| path | string | - |
{"error": {"code": 1,"constraintViolations": [{"location": "string","message": "string","parameterLocation": "HEADER","path": "string"}],"message": "string"}}
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 | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/autoUpdate/validator |
| Environment and Cluster ActiveGate (default port 9999) | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/activeGates/{agId}/autoUpdate/validator |
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.
| Code | Type | Description |
|---|---|---|
| 204 | - | Validated. The submitted auto-update configuration is valid. Response doesn't have a body. |
| 400 | Error | Failed. The input is invalid. |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| code | integer | The HTTP status code |
| constraintViolations | Constraint | A list of constraint violations |
| message | string | The error message |
ConstraintViolation objectA list of constraint violations
| Element | Type | Description |
|---|---|---|
| location | string | - |
| message | string | - |
| parameterLocation | string | -The element can hold these values
|
| path | string | - |
{"error": {"code": 1,"constraintViolations": [{"location": "string","message": "string","parameterLocation": "HEADER","path": "string"}],"message": "string"}}