Settings EndpointΒΆ

With the /settings endpoint, certain BIG-IP AS3 system-wide settings are saved in persistent storage on the BIG-IP device. This means the settings apply to all future declarations, unless the settings are modified again. The /settings endpoint enables the configuration of these system-wide settings, such as enabling or disabling Service Discovery.

To use the /settings endpoint, you can send a POST or GET request to HTTPS://<BIG-IP IP address>/mgmt/shared/appsvcs/settings.

  • Check current settings
    Using a GET request returns the current configuration settings and their values.
    To check the current setting status, send a GET request to HTTPS://<BIG-IP IP address>/mgmt/shared/appsvcs/settings. When the request is successful, you will receive a response like:

    {
       "asyncTaskStorage": "data-group",
       "burstHandlingEnabled": false,
       "performanceTracingEnabled": false,
       "performanceTracingEndpoint": "",
       "serviceDiscoveryEnabled": true
    }
    
  • Change current settings
    Using a POST request allows you to change the current settings by sending a declaration with updated settings in the request body.
    To change a current setting, send a POST request to HTTPS://<BIG-IP IP address>/mgmt/shared/appsvcs/settings. For example, to enable burst handling, POST the following declaration body:

    {
        "burstHandlingEnabled": true
    }
    

BIG-IP AS3 should now be running with the burst handling feature enabled.

The /settings endpoint supports the following (see Settings in the API Reference for more information (click to expand body on that page)):

  • asyncTaskStorage
    Controls where asynchronous tasks are stored. Existing tasks are not transferred when the storage type is changed. Storing tasks in a data group persists the data between restarts, but puts more pressure on the control plane. Options are data-group (default) and memory.
  • burstHandlingEnabled
    A boolean that controls if BIG-IP AS3 on this BIG-IP system uses the Burst Handling feature (the default is false). See Burst Handling for more information.
  • performanceTracingEnabled
    A boolean that controls if BIG-IP AS3 records performance information (the default is false). Jaeger client must be installed to enable this property.
  • performanceTracingEndpoint
    Remote endpoint to which performance tracing will send data.
  • serviceDiscoveryEnabled
    A boolean that controls if Service Discovery features are enabled (the default is false). See Service Discovery examples.
  • webhook
    Requires BIG-IP AS3 3.45 or later. URL to post results to.