Note: This section was moved from BRM to BAM in version 7.11.0.
This configures the Web API that allows the BAM Web UI to interact with BAM. To enable the API, either http_port OR https_port must be set.
Web API configuration parameters.
This section is OPTIONAL; MANDATORY parameters only need to be specified if this section exists
The header for this section is [webapi]
| Name | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| bind_address | yes | string | N/A | This parameter was introduced in version 7.11.0 The IP address that the API binds to |
| http_port | no | integer | 9988 | This parameter was introduced in version 7.11.0 The port to use for web API connections over HTTP Min: 1, Max: 65535 |
| https_port | no | integer | 9989 | This parameter was introduced in version 7.11.0 The port used for web API connections over HTTPS Min: 1, Max: 65535 |
| password_reset_token_lifespan | no | integer | 900 | This parameter was introduced in version 7.11.0 The amount of time (in seconds) that password reset tokens are valid for Min: 1 |
| access_token_lifespan | no | integer | 3600 | This parameter was introduced in version 7.11.0 The amount of time (in seconds) that access tokens are valid for before they need to be refreshed Min: 1 |
| webui_address | no | string | http://[auto_detected_local_address]/bam | This parameter was introduced in version 7.11.0 A URL pointing to the web UI. By default, the system will generate it from the local address. Should be in the format: <protocol>://<server address>:<port>/<path> e.g. https://my.server:443/bam Port is not necessary if it is hosted on the default port for the chosen protocol (80 for http, 443 for https) This URL is used when generating password reset emails |