v1
latestOpenAPI 3.0.02026-07-1713333.3 KBApply BIG-IP AS3 configuration for a specific tenant or tenants
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
Path parameters
Only use the specified tenants. Other tenants in the declaration will be ignored. May be a comma separated list.
Query parameters
async=: true causes BIG-IP 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.
BIG-IP 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.
BIG-IP 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.
BIG-IP AS3 3.30+: If true, BIG-IP 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.
BIG-IP 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.
BIG-IP 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.
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
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.
Request body
Response
Successful response