ActiveGates auto-update configuration API - GET an ActiveGate
Gets the auto-update configuration of the specified Environment ActiveGate.
The request produces an application/json
payload.
GET |
|
Authentication
To execute this request, you need the Read ActiveGates (activeGates.read
) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
agId | string |
The ID of the required ActiveGate. |
path | required |
Response
Response codes
Code | Description |
---|---|
200 | Success |
404 | Not found. See response body for details. |
Response body
The ActiveGateAutoUpdateConfig object
Configuration of the ActiveGate auto-updates.
Element | Type | Description |
---|---|---|
setting | string | The state of the ActiveGate auto-update: enabled, disabled, or inherited. If set to |
effectiveSetting | string | The actual state of the ActiveGate auto-update. Applicable only if the setting parameter is set to |
{
"setting": "INHERITED",
"effectiveSetting": "ENABLED"
}