API Manager settings

Reference guide for the Settings tab in the API Manager web UI.

20 minute read

Account settings

You can configure the following settings for a user account. For more information on managing users, see Manage users.

General

  • Image: Click to add a graphical image for the account (for example, .png, .gif, or .jpeg file).
  • Login name: Enter a user login name for the account. The default is apiadmin. This is the default API administrator user for API Manager.
  • Email: Enter an email address for the account. The default is apiadmin@localhost.
  • Enabled: Select whether the account is enabled. The apiadmin account is enabled by default.
  • Created on: Displays the date and time at which the account was created.
  • Current state: Displays the state of the account. The apiadmin account is Approved by default.

Membership

  • Role: Displays the membership role of the account. The default apiadmin account has an API Manager Administrator role.

Additional attributes

  • Phone: Enter a contact phone number for the account.
  • Description: Enter a description for the account. The default apiadmin account is described as API Administrator.

Password

  • Change password: Click to change the current password for the account. It is strongly recommended that you change the default password for security reasons.

The following restrictions apply:

  • API administrators can change the password for any internal (non-on-boarded) API Manager user.
  • Organization administrators can change the password for any internal user associated with their organization.
  • External user passwords on-boarded from external identity providers cannot be changed.

API Manager settings

You can configure the following settings on the API Manager tab:

API Manager

  • API Manager name: Enter the name displayed for API Manager in the email notifications sent to API providers (for example, your company name or website). Defaults to Axway API Manager. This setting is required.
  • API Manager host: Enter the host name that API Manager is available on. Defaults to the API Manager IP address. It is not recommended to have spaces or the URL encoded %20 in the host name.
  • Email reply to: Enter the reply to address for email sent from API Manager (for example, the automatically generated emails sent when user accounts are created). Defaults to no-reply@axway.com.
  • Email bounce: Enter the email address used to receive messages about the non-delivery of automatically generated email. Defaults to apiadmin@localhost.
  • Demo mode: Select whether demo mode is enabled. When this setting is enabled, API Manager automatically generates random data, and displays metrics on the Monitoring tab without needing to send traffic through the API Gateway. Demo mode is disabled by default.
  • Case-insensitive table sorting: Select whether case-insensitive sorting of data in tables is enabled. This is enabled by default.
  • Trial mode: Select whether trail mode is enabled for all organizations. Trial mode allows the API administrator to manage the lifespan of the organization, including any resources that belong to that organization (for example, users or applications). When this setting is enabled, API Manager displays TRIAL settings for the administrator when editing the organization on the Client Registry > Organizations page. Trial mode is disabled by default.
  • Default trial duration: When Trial mode is enabled, enter the duration of the trial in days. Defaults to 30 days. When the trial has ended, the organization expires, and users of the expired organization can no longer log in.

API Portal

  • API Portal: Select whether to enable API Portal. You should only enable this setting if you have an existing API Portal installation working with API Manager. When enabled, links in email notifications are addressed to the API Portal host or to the API Manager host, depending on whether you are an API consumer or API provider. This setting is disabled by default.
  • API Portal name: Enter the name displayed for API Portal in email notifications sent to API consumers (for example, your company name or website). Defaults to Axway API Portal. This setting is required.
  • API Portal host and port: Enter the host name or IP address and port used in auto-generated email links sent to API consumers (for example, www.example.com:443). The host is required, and the port is optional. If you do not enter a value, the default port is 443. Enter the host and port (optional), but not the scheme. For example, example.com:443 or example.com is correct, but https://example.com:443 or http://example.com is incorrect.

For more details on API Portal, see Administer API Portal.

General settings

  • User registration: Select whether to enable automatic user registration. This is enabled by default.
  • Auto-approve user registration: Select whether automatic approval of user registration requests is enabled. This is enabled by default.
  • Auto-approve applications: Select whether automatic approval of client applications is enabled. This is enabled by default.
  • Login name regular expression: Enter a valid regular expression to restrict the login names that you can enter. This does not retrospectively enforce login names. If you change the * default setting, you must update the loginNameValidationMessage in app.config. Defaults to [^;,\\/?#<>&;!]{1,}.
  • User name regular expression: Enter a valid regular expression to restrict the user names that you can enter. This does not retrospectively enforce existing user names. Defaults to ^[\\p{L}\\d .,\'_-]+$.
  • Enable application scopes: Select whether to enable scopes at the level of the client application. This allows the API administrator to create application-level scopes to permit access to resources that are not covered by API-level scopes (for example, for API method-level authorization). This setting is not enabled by default. For more details, see Configure API method-level authorization for client applications.
  • Apply application scope restrictions: When this option is selected, only the scopes that are enabled at the level of the client application are returned when a request is submitted that contains an empty scope list. This enables applications to have read-only access to an API. Scopes that are not specified in the application are not available when requesting a token for this application.
  • Enable query string version routing: Select whether to enable routing to different front-end API versions from a single base path using a query string parameter (for example, https://HOSTNAME:8065/api/helloworld?v=v1). This setting is unselected by default, and the URL path-based version is used instead. When selected, you must enter a value in the next setting, Query string version parameter.
  • Query string version parameter: Specifies the name of the query string version parameter used to route between different API versions (for example, a value of v requires /my_api?v=1 in the query string, while version requires /my_api?version=1). The name of the parameter will also be published in the Swagger generated for the front-end API in the API Catalog. For a detailed example, see Configure API routing based on version query string.

Password, login, and session management settings

  • Session timeout (minutes): Enter the number of minutes after which API Manager sessions time out. Defaults to 720 minutes (12 hours). Changing this value takes effect immediately.
  • Idle session timeout (minutes): Enter the number of minutes after which idle API Manager sessions time out. Defaults to 60 minutes. Changing this value takes effect immediately.
  • Change password on first login: Select whether to enforce a change of password when a user logs into API Manager for the first time. This is enabled by default.
  • Enable password reset: Select whether to enable the Forgot Password tab on the API Manager login page. For some providers (for example, LDAP), you cannot reset the user password, so you might need to disable this feature. This is enabled by default.
  • Enable password expiry: Select whether to enable password expiry for API Manager users. This is enabled by default. For more details, see Enforce password changes.
  • Days before passwords expire: Enter the number of days after which a user password expires. The default value is 90 days. This setting is only applicable if password expiry is enabled.
  • Minimum password length: Select the minimum number of characters required for user passwords. The default value is 6.
  • Lock user account on invalid login: Select whether a user should be locked out of API Manager for 30 minutes after 6 invalid logins have been attempted over a time period of 5 minutes. When a user account is locked, the user can either wait for the configured time period to elapse or use the Forgot Password capability (the user can log back in immediately when they receive a new autogenerated password). You can configure API Manager to use an external Identity Provider (IdP) for authentication. In this case users are considered external and are automatically added as API Manager users when they first login. If the external IdP has its own account lockout feature, and a user has been locked out (for whatever reason), API Manager sees this as invalid login attempt. If you use only an external IdP for user authentication you can disable this setting as the IdP performs the same task.

Organization administrator delegation

  • Delegate user management: Select whether organization administrators can create or remove applications, and approve requests from users to create applications. This is enabled by default.
  • Delegate application management: Select whether organization administrators can create or remove applications, and approve requests from users to create applications. This is enabled by default.

API registration

  • API default virtual host: Enter a host and port on which all registered and published APIs are available. The specified host must be DNS resolvable.
  • API promotion via policy: Select whether APIs can be promoted using a policy specified in Policy Studio. Enabling the API promotion via policy setting forces a reload of API Manager, and you must log in again. A Promote API option is also then added to the Frontend API management menu. This setting is disabled by default. For more information on API promotion, see Promote managed APIs.

API import

  • Strict certificate checking: Select whether to validate that the certificate is recognised as a valid server certificate during import.
  • Server certificate verification: Select whether to validate that the certificate presented by the server matches the Remote Host being connected to during import.
  • Mime validation: Select to perform MIME Type validation during import. MIME Type validation is implemented for OAS3 and Swagger 2 APIs. This setting is enabled by default.
  • Import timeout (seconds): Maximum amount of time to wait until an API is imported. This is particularly useful while importing OAS3 files with multiple parts.
  • Allow users to modify Backend APIs: Select to ensure that all APIs imported are editable by default.

Global policies

  • Enable Global Policies: Select whether to enable a global policies that are applied to all front-end API invocations (for example, mandatory security, compliance, or governance policies). This setting is disabled by default.
  • Global Request Policy: Select an optional global request policy to apply to all front-end API invocations. When a global request policy has been selected, it is displayed on the Frontend API > Outbound tab when you click Advanced. The global request policy is executed after inbound authentication, but before any non-global request, routing, or response policies configured for the front-end API.
  • Global Response Policy: Select an optional global response policy to apply to all front-end API invocations. When a global response policy has been selected, it is displayed on the Frontend API > Outbound tab when you click Advanced. The global response policy is executed last after any non-global response policy configured for the front-end API.

For more details, see Enforce API Manager global policies.

Fault handlers

  • Enable API Manager fault handlers: Select whether to enable fault handler policies that are applied to front-end API invocations. When this setting is enabled, an API administrator can select a global fault handler policy for all front-end APIs. API developers can also select fault handler policies for specific front-end APIs and methods. This setting is switched off by default.
  • Global Fault handler Policy: When fault handlers are enabled, you can select a global fault handler to apply to all front-end API invocations. The list of available policies is determined by the fault handler policies that have been configured in Policy Studio. The selected policy will be executed at runtime in the event of an error. This setting defaults to the API Manager Default Fault Handler policy.

For more details, see Add API Manager fault handler policies.

Advisory banner

Enable this setting to display the advisory banner text on the API Manager login screen. This setting is disabled by default.

Alerts

You can use API Manager to enable or disable alert notifications for specific events (for example, when an application request is created, or an organization is created). When an alert is generated by API Manager, you can execute a custom policy to handle the alert (for example, to send an email to an interested party, or to forward the alert to an external notification system).

You can use the alert settings in Policy Studio to select which policies are configured to handle each event. For more details, see Configure API management alerts.

Remote hosts

The remote host settings enable you to dynamically configure connection settings to back-end servers that are invoked by front-end APIs. API Administrators can edit all remote hosts in all organizations.

The remote host settings available in API Manager are a subset of the settings available in Policy Studio.

Required settings

  • Name : Enter the remote host name (for example, www.google.com).
  • Port: Enter the TCP port to connect to on the remote host. Defaults to 80.
  • Host alias: The human readable alias name for the remote host (for example, StockQuote Host).
  • Maximum connections : Enter the maximum number of connections to the remote host. If the maximum number of connections is reached, the underlying API Gateway waits for a connection to drop or become idle before making another request. Defaults to -1, which means there is no limit.
  • Organization: The organization to which the remote host belongs. This is only displayed for API administrators.

Optional settings

  • Allow HTTP 1.1: The API Gateway uses HTTP 1.0 by default to send requests to a remote host. This prevents any anomalies if the destination server does not fully support HTTP 1.1. If the API Gateway is routing on to a remote host that fully supports HTTP 1.1, you can use this setting to enable API Gateway to use HTTP 1.1.
  • Include Content Length in Request: When this option is selected, the API Gateway includes the Content-Length HTTP header in all requests to this remote host. This setting only applies to outgoing remote host connections.
  • Include Content Length in Response: When this option is selected, if the API Gateway sends a response to this remote host that contains a Content-Length HTTP header, it returns this length to the client. This setting only applies to incoming remote host connections.
  • Send Server Name Indication TLS extension to server: Adds a field to outbound TLS/SSL calls that show the name that the client used to connect. This can be useful if the server handles several different domains, and needs to present different certificates depending on the name the client used to connect. For example, this is required by some cloud-based services such as Amazon CloudFront. This setting is not selected by default. To send the SNI extension, you must ensure that the Verify server’s certificate matches the requested hostname setting is also selected. In addition, the Port setting must be the port in which you are connecting the server (for example, 443 is the default port for SSL).
  • Verify server’s certificate matches requested hostname: Ensures that the certificate presented by the server matches the name of the remote host being connected to. This prevents host spoofing and man-in-the-middle attacks. This setting is selected by default

Address and load balancing settings

You can configure the following settings on the Addresses and Load Balancing tab:

Addresses to use instead of DNS lookup: You can add a list of IP addresses that the API Gateway uses instead of attempting a DNS lookup on the host name provided. This is useful in cases where a DNS server is not available or is unreliable. By default, connection attempts are made to the listed IP addresses on a round-robin basis.

For example, if a Static Router filter is configured to route to www.webservice.com, it first checks if any remote hosts have been configured with a Host Name entry matching www.webservice.com. If it finds a Remote Host with matching Host Name , it resolves the host name to the IP addresses listed here. In addition, it uses all the connection-specific settings configured on the Remote Host dialog when routing messages to these IP addresses. If it cannot find a matching host, the Static Router filter uses whatever DNS server has been configured for the network on which the API Gateway is running.

To add a list of IP addresses for a remote host, perform the following steps:

  1. In the Addresses to use instead of DNS lookup box, select a priority group (for example, Highest Priority).
  2. Click Add.
  3. Enter an IP address or server name in the Configure IP Address dialog.
  4. Click OK.
  5. Repeat these steps to add more IP addresses as appropriate.

Load balancing: The Load Balancing Algorithm drop-down box enables you to specify whether load balancing is performed on a simple round-robin basis or weighted by response time. Simple Round Robin is the default algorithm. Connection attempts are made to the listed IP addresses on a round-robin basis in each priority group. The Weighted by response time algorithm compares the request/reply response times for the server address in each priority group. This is the simplest way of estimating the relative load of the address.

This algorithm works as follows:

  1. The address with the least response time is selected to send the next message to.
  2. If the address fails to send the message, it ignores that address for a period of time and selects another address in the same way.
  3. If all addresses in a given group fail to accept a connection, addresses in the next group in ascending order of priority are used in the same way.
  4. Only when all addresses in all priorities have failed to accept connections is delivery of the message abandoned, and an error raised.

The response times used by this algorithm decline over time. You can specify the rate of exponential decline by specifying a Period to wait before response time is halved. The default is 10,000 ms (10 sec). This enables addresses that were heavily loaded for a period of time to eventually resume accepting messages after the load subsides.

For example, server A takes 100 ms to reply, and the other servers in the same priority group reply in 25 ms. A Period to wait before response time is halved of 10,000 ms (10 sec) means that after 20 seconds server A is retried along with the other servers. In this case, the response time has been halved twice (100 ms / 2 / 2 = 25 ms).

Advanced settings

The options available on the Advanced tab are used when creating sockets for connecting to the remote host. Default values are provided for all fields, which should only be modified under advice from the Axway Support.

You can configure the following configuration options on the Advanced tab:

  • Connection Timeout: If a connection to this remote host is not established within the time set in this field, the connection times out and the connection fails. Defaults to 30000 milliseconds (30 seconds).

  • Active Timeout: When API Gateway receives a large HTTP request, it reads the request off the network when it becomes available. If the time between reading successive blocks of data exceeds the Active Timeout, API Gateway closes the connection. This prevents a remote host from closing the connection while sending data. Defaults to 30000 milliseconds (30 seconds). For example, the remote host’s network connection is pulled out of the machine while sending data to API Gateway. When API Gateway has read all the available data off the network, it waits the Active Timeout period before closing the connection. The Active Timeout value is also used as a wait time when the maximum number of connections for a remote host is reached. For example, when a remote host reaches the value of the Maximum connections, API Gateway waits the active timeout period before giving up on trying to make a new connection.

  • Transaction Timeout (ms): A configurable transaction timeout that detects slow HTTP attacks (slow header write, slow body write, slow read) and rejects any transaction that keeps the worker threads occupied for an excessive amount of time. Unlike other timeouts, this is not measured with respect to any network transaction, rather it is measured from the start of the API Gateway transaction until the timeout occurs. A rejected transaction will run to completion, though it will not return any response to the client, therefore, this value should be set longer than any legitimate traffic. The default value is 240,000 milliseconds (4 minutes).

  • Max Received Bytes: The maximum number of bytes received in a transaction. This is a configurable maximum length for the received data on transactions that API Gateway can handle. This setting limits the entire amount of data received over the link, regardless of whether it consists of body, headers, or request line. The default value is 10 MiB (10,485,760 bytes) and the maximum is 16,384 PiB (18,446,744,073,709,551,615 bytes).

  • Max Sent Bytes: The maximum number of bytes sent in a transaction. This is a configurable maximum length for the transmitted data on transactions that API Gateway can handle. This setting limits the entire amount of data sent over the link, regardless of whether it consists of body, headers, or request line. The default value is 10 MiB (10,485,760 bytes) and the maximum is 16,384 PiB (18,446,744,073,709,551,615 bytes).

  • Idle Timeout: The API Gateway supports HTTP 1.1 persistent connections. Idle Timeout is the time that API Gateway waits after sending a message over a persistent connection to the remote host before it closes the connection. Defaults to 15000 milliseconds (15 seconds). Typically, the remote host tells the API Gateway that it wants to use a persistent connection. The API Gateway acknowledges this, and keeps the connection open for a specified period of time after sending the message to the host. If the connection is not reused by within the idle timeout period, the API Gateway closes the connection.

  • Input Buffer Size: The maximum amount of memory allocated to each request. The default value is 8192 bytes.

  • Output Buffer Size: The maximum amount of memory allocated to each response. The default value is 8192 bytes.

  • Cache addresses for (ms): The period of time to cache addressing information after it has been received from the naming service (for example, DNS). The default value is 300000 milliseconds.

  • SSL Session Cache Size: Specifies the size of the SSL session cache for connections to the remote host. This controls the number of idle SSL sessions that can be kept in memory. Defaults to 32. If there are more than 32 simultaneous SSL sessions, this does not prevent another SSL connection from being established, however no more SSL sessions are cached. A cache size of 0 means no cache, and no outbound SSL connections are cached.

    At DEBUG level or higher, the API Gateway outputs trace when an entry goes into the cache, for example:

    DEBUG 09:09:12:953 [0d50] cache SSL session 11AA3894 to support.acme.com:443
    

    If the cache is full, the output is as follows:

    DEBUG 09:09:12:953 [0d50] enough cached SSL sessions 11AA3894 to support.acme.com:443 already
    
  • Output Encodings: Click the Browse button to specify the HTTP content encodings that API Gateway can apply to outgoing messages. The available content encodings include gzip and deflate. By default, the content encodings configured the Default Settings are used. You can override this setting at the remote host and HTTP interface levels. For more details, see Compressed content encoding.

  • Include correlation ID in headers: Specifies whether to insert the correlation ID in outbound messages. This means that an X-CorrelationID header is added to the outbound message. This is a transaction ID that is attached to each message transaction that passes through API Gateway, and which is used for traffic monitoring in the API Gateway Manager web console. You can use the correlation ID to search for messages in the web console, and you can also access its value from a policy using the id message attribute. This setting is selected by default.

Configure an incoming remote host

A remote host is normally used to configure specific connection features for the outward connection, that is, for the connection from API Gateway to the back-end service. However, you can also configure a remote host for an incoming connection, that is, for the connection from the client to API Gateway.

To configure an incoming remote host, configure the following settings on the General tab of the remote host settings:

  1. Enter incoming for the Port.

    For an incoming connection, the port is referring to the remote address of the TCP connection. Incoming connections arrive from effectively arbitrary remote ports, so this acts as a wildcard for all incoming connections.

  2. Enter the IP address of the host for the Host name, rather than the DNS name.

    A CIDR style netmask can be specified (for example, 192.168.0.0/24 matches any address in the 192.168.0.x range). This works on a longest-match basis if more than one network specification matches the client.