Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

APIGOV-29730 - clean removed variable #615

Merged
merged 1 commit into from
Feb 21, 2025
Merged

APIGOV-29730 - clean removed variable #615

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions content/en/docs/connect_manage_environ/connect_api_manager/agent-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,12 @@ All common agent variables can be found [here](/docs/connect_manage_environ/conn
| Variable name | Description |
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| APIMANAGER_APIVERSION | The API version of the API Manager (default value: `1.3`). |
| APIMANAGER_APPORGPOLLINTERVAL | The frequency in which the agent checks for application and organization changes. Default: 5m, Minimum: 30s. Units: ns, us, ms, s, m, h |
| APIMANAGER_AUTH_PASSWORD | The password created for the API Manager username created for this agent (created in API Manager). |
| APIMANAGER_AUTH_USERNAME | The API Manager username for this agent. Created in API Manager (must be API Manager Admin). |
| APIMANAGER_CLIENTTIMEOUT | The time interval at which the HTTP client times out making HTTP requests to API Manager. Default: 60s. Units: ns, us, ms, s, m, h |
| APIMANAGER_REQUESTSETTINGS_RETRIES | The number of retries the agent will make for an API call to API Manager. Default: 5 (Available in Discovery v1.12.12 and Traceability v1.12.11 or newer) |
| APIMANAGER_REQUESTSETTINGS_INITIALDELAY | The initial amount of time, see APIMANAGER_REQUESTSETTINGS_BACKOFF, the agent waits between retry attempts for API calls to API Manager. Default 2s (Available in Discovery v1.12.12 and Traceability v1.12.11 or newer) |
| APIMANAGER_REQUESTSETTINGS_BACKOFF | When set to true, default, the agent will double the amount of time between retries when making API calls to API Manager. (Available in Discovery v1.12.12 and Traceability v1.12.11 or newer) |
| APIMANAGER_REQUESTSETTINGS_RETRIES | The number of retries the agent will make for an API call to API Manager. Default: 5 (Available in Discovery v1.12.12 and Traceability v1.12.11 or newer) |
| APIMANAGER_REQUESTSETTINGS_INITIALDELAY | The initial amount of time, see APIMANAGER_REQUESTSETTINGS_BACKOFF, the agent waits between retry attempts for API calls to API Manager. Default 2s (Available in Discovery v1.12.12 and Traceability v1.12.11 or newer) |
| APIMANAGER_REQUESTSETTINGS_BACKOFF | When set to true, default, the agent will double the amount of time between retries when making API calls to API Manager. (Available in Discovery v1.12.12 and Traceability v1.12.11 or newer) |
| APIMANAGER_HOST | The host API Manager is running on (default value: `localhost`). |
| APIMANAGER_PORT | The port API Manager is listening on (default value: `8075`). |
| APIMANAGER_POLLINTERVAL | The frequency in which API Manager is polled for new endpoints. Default and Minimum: 30s. Units: ns, us, ms, s, m, h |
Expand All @@ -112,7 +111,7 @@ All common agent variables can be found [here](/docs/connect_manage_environ/conn

| Variable name | Description |
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| APIMANAGER_DISCOVERYIGNORETAGS | Comma-separated blacklist of tags that should not be on a proxy before sending to Amplify Engage. Takes precedence over APIMANAGER_FILTER. |
| APIMANAGER_DISCOVERYIGNORETAGS | Comma-separated blacklist of tags that should not be on a proxy before sending to Amplify Engage. Takes precedence over APIMANAGER_FILTER. |
| APIMANAGER_FILTER | Expression to filter the API you want the agent to discover. See [Discover APIs](/docs/connect_manage_environ/connect_api_manager/filtering-apis-to-be-discovered/). |

#### Invoke policy handling
Expand Down Expand Up @@ -214,7 +213,7 @@ APIMANAGER_CUSTOM_OAUTHEXT_CLIENTID_LABEL="Azure AD Client Id"
| INPUTS_CLOSE_REMOVED | The agent will close the harvester of the file when it has been removed from disk (default value: `2h`). See [close_removed](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-log.html#filebeat-input-log-close-removed). |
| INPUTS_CLEAN_REMOVED | The agent will remove the state of the file when it has been removed from from the disk (default value: `2h`). See [clean_removed](https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-input-log.html#filebeat-input-log-clean-removed). |
| TRACEABILITY_REDACTION_JMSPROPERTIES_SANITIZE | Determines what portions of a JMS Property value to sanitize. Example: `[{keyMatch:"jmsProviderURL",valueMatch:".{0,10}$"}]` to sanitize the `jmsProviderURL` property to mask the last ten characters or less. |
| TRACEABILITY_REDACTION_JMSPROPERTIES_SHOW | Determines what JMS Properties to send to Amplify Engage. By default, all JMS properties are redacted. Example: `[{keyMatch:".*"}]` to send all JMS properties. |
| TRACEABILITY_REDACTION_JMSPROPERTIES_SHOW | Determines what JMS Properties to send to Amplify Engage. By default, all JMS properties are redacted. Example: `[{keyMatch:".*"}]` to send all JMS properties. |
| APIGATEWAY_AUTH_USERNAME | Your Axway API Gateway username: should have an API Operator role. |
| APIGATEWAY_AUTH_PASSWORD | Your Axway API Gateway user password. |
| APIGATEWAY_CLIENTTIMEOUT | The time interval at which the HTTP client times out making HTTP requests to API Gateway (ns - default, us, ms, s, m, h). Set to 60s. |
Expand Down