Documentation Powered by ReDoc

AS3 (3.36.0)

Download OpenAPI specification:Download

This reference describes the AS3 API and available endpoints. For more details, see https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/refguide/as3-api.html

Configuration

POST - Apply AS3 configuration

Use POST to deploy a configuration to a target ADC, or for certain other actions, including retrieve. You must supply a request document with each POST. The request document may be a proper request or a ADC-only declaration

query Parameters
show
string

show=: base means system returns the declaration as originally deployed (but with secrets like passphrases encrypted), full returns the declaration with all default schema properties populated, expanded includes all URLs, base64s, and other references expanded to their final static values. Default is base

async
boolean

async=: true causes AS3 to respond with a 202 status and a request ID which you can later use in a GET request to a new /task endpoint to get the results. Default is false.

showHash
boolean

AS3 3.14.0+: If you set showHash=true, the results include an optimisticLockKey for each tenant. Attempts to change/update any of the tenants without the correct optimisticLockKey will fail. The default is false.

controls.dryRun
boolean

AS3 3.30+: Using controls.dryRun=true sends the declaration through all validation checks but does not attempt to deploy the configuration on the target device. This can be useful for testing and debugging declarations. Using this query parameter overwrites any Controls in the ADC class you specified in the declaration. The default is false.

controls.logLevel
string

AS3 3.30+: Determines the level of detail in logs using RFC 5424 severity levels. Using this query parameter overwrites any Controls in the ADC class you specified in the declaration. The default is error.

controls.trace
boolean

AS3 3.30+: If true, AS3 creates a detailed trace of the configuration process for subsequent analysis (default false). Warning: Trace files may contain sensitive configuration data. Using this query parameter overwrites any Controls in the ADC class you specified in the declaration. The default is false.

controls.traceResponse
boolean

AS3 3.30+: If true, the response will contain the trace files. Using this query parameter overwrites any Controls in the ADC class you specified in the declaration. The default is false.

controls.userAgent
string

AS3 3.30+: User Agent information to include in TEEM report. Using this query parameter overwrites any Controls in the ADC class you specified in the declaration.

Request Body schema: application/json
body
object (declaration)

See Composing a Declaration and the API details page for information on the the AS3 Request body.

Responses

Request samples

Content type
application/json
{
  • "class": "ADC",
  • "schemaVersion": "3.0.0",
  • "tenant": {
    }
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "declaration": {
    }
}

Read current AS3 configuration

Retrieve a declaration (with all or just some Tenants) or an index of stored declarations.

query Parameters
show
string

base means system returns the declaration as originally deployed (but with secrets like passphrases encrypted), full returns the declaration with all default schema properties populated, expanded includes all URLs, base64s, and other references expanded to their final static values. The default is base.

age
integer|string

?age=0-15 asks for a declaration of the given age (0 means most-recently deployed), and "list" asks for a list of available declarations with their ages. By default, list only shows 4 declarations, this is configurable using historyLimit in the AS3 class. The default is 0.

filterClass
string

You can use filterClass to retrieve results for only a specific AS3 class. For example ?filterClass=HTTP_Profile only returns the HTTP Profile portions of the declaration. You can only use filterClass once in a single GET request.

Responses

Response samples

Content type
application/json
{
  • "class": "ADC",
  • "schemaVersion": "3.0.0",
  • "tenant": {
    }
}

Update current AS3 configuration

Version Notice: PATCH is available in AS3 v3.1.0 and later

query Parameters
show
string

base means system returns the declaration as originally deployed (but with secrets like passphrases encrypted), full returns the declaration with all default schema properties populated, expanded includes all URLs, base64s, and other references expanded to their final static values. The default is base.

async
boolean

AS3 3.5.0+: Setting async to true causes AS3 to respond with a 202 status and a request ID which you can later use in a GET request to a new /task endpoint to get the results.

Responses

Response samples

Content type
application/json
{}

Remove current AS3 configuration

Use DELETE to remove configurations for one or more declared Tenants from the target ADC.

query Parameters
show
string

base means system returns the declaration as originally deployed (but with secrets like passphrases encrypted), full returns the declaration with all default schema properties populated, expanded includes all URLs, base64s, and other references expanded to their final static values. The default is base.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "declaration": {
    }
}

Information

/mgmt/shared/appsvcs/info

This returns version and release information for the instance of AS3 you are using. It also shows current and minimum required versions of the AS3 schema.

Responses

Response samples

Content type
application/json
{
  • "version": "3.20.0",
  • "release": 2,
  • "schemaCurrent": "3.20.0",
  • "schemaMinimum": "3.0.0"
}

Task

A collection of asynchronous tasks

If you used the ?async=true query parameter to send a large declaration, you can use a GET request to the /task endpoint with the recordId returned by the POST to see the status of the processing (and the results if it is finished). Old task records are removed if the record is older than one week or more than 25 records exist.

Responses

Response samples

Content type
application/json
Example
task results from a POST request
task results from a POST request
task results from a GET request
task results from an invalid POST request
{
  • "id": "d1d2137e-d6e6-4ee6-b20f-e9a738d3ce1c",
  • "results": [
    ],
  • "declaration": {
    }
}

Settings

Update AS3 settings

Use POST to deploy simple settings changes in AS3. You must supply a schema appropriate JSON object as the body of the request.

Request Body schema: application/json
object (AS3 Settings Declaration)

A declarative configuration for AS3

Responses

Request samples

Content type
application/json
{
  • "burstHandlingEnabled": false
}

Response samples

Content type
application/json
{
  • "burstHandlingEnabled": false
}

Get current AS3 settings

Returns the current configuration of AS3.

Responses

Response samples

Content type
application/json
{
  • "burstHandlingEnabled": false
}