POST /albservicesconfig

POST /albservicesconfig

/albservicesconfig

Request
URI
POST
https://{api_host}/api/albservicesconfig
COPY
Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.


Request Body

ALBServicesConfig object creation

ALBServicesConfig of type(s) application/json
Optional

Show optional properties

{
    "app_signature_config": {},
    "case_config": {},
    "feature_opt_in_status": {},
    "inventory_config": {},
    "ip_reputation_config": {},
    "portal_url": "string",
    "saas_licensing_config": {},
    "user_agent_db_config": {},
    "waf_config": {}
}
{
    "_last_modified": "string",
    "app_signature_config": {
        "app_signature_sync_interval": 0
    },
    "asset_contact": {
        "account_id": "string",
        "account_name": "string",
        "email": "string",
        "managed_accounts": [
            {
                "id": "string",
                "name": "string",
                "users": [
                    {
                        "email": "string",
                        "name": "string",
                        "phone": "string"
                    }
                ]
            }
        ],
        "name": "string",
        "phone": "string"
    },
    "case_config": {
        "additional_emails": [
            "string"
        ],
        "enable_auto_case_creation_on_controller_failure": false,
        "enable_auto_case_creation_on_se_failure": false,
        "enable_cleanup_of_attached_files": false
    },
    "configpb_attributes": {
        "version": 0
    },
    "feature_opt_in_status": {
        "enable_appsignature_sync": false,
        "enable_ip_reputation": false,
        "enable_pulse_case_management": false,
        "enable_pulse_inventory": false,
        "enable_pulse_waf_management": false,
        "enable_user_agent_db_sync": false
    },
    "inventory_config": {
        "enable_search_info": false
    },
    "ip_reputation_config": {
        "ip_reputation_file_object_expiry_duration": 0,
        "ip_reputation_sync_interval": 0
    },
    "mode": "string",
    "name": "string",
    "polling_interval": 0,
    "portal_url": "string",
    "saas_licensing_config": {
        "max_service_units": "number",
        "reserve_service_units": "number"
    },
    "session_config": {
        "session_headers": [
            {
                "name": "string",
                "value": "string"
            }
        ]
    },
    "split_proxy_configuration": {
        "host": "string",
        "password": "string",
        "port": 0,
        "username": "string"
    },
    "tenant_config": {
        "heartbeat_interval": 0,
        "license_escrow_interval": 0,
        "license_expiry_interval": 0,
        "license_reconcile_interval": 0,
        "license_refresh_interval": 0,
        "license_renewal_interval": 0,
        "token_refresh_interval": 0
    },
    "tenant_ref": "string",
    "url": "string",
    "use_split_proxy": false,
    "use_tls": false,
    "user_agent_db_config": {
        "allowed_batch_size": 0
    },
    "uuid": "string",
    "waf_config": {
        "enable_auto_download_waf_signatures": false,
        "enable_waf_signatures_notifications": false
    }
}
Responses
200

OK

Returns ALBServicesConfig of type(s) application/json
"ALBServicesConfig Object"
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

object
app_signature_config
Required

app_signature_config

object
asset_contact
Optional

asset_contact

object
case_config
Required

case_config

object
configpb_attributes
Optional

configpb_attributes

object
feature_opt_in_status
Required

feature_opt_in_status

object
inventory_config
Required

inventory_config

object
ip_reputation_config
Required

ip_reputation_config

string
mode
Optional
Constraints: default: MYVMWARE

Mode helps log collection and upload. Enum options - MODE_UNKNOWN, SALESFORCE, SYSTEST, MYVMWARE, BROADCOM. Field introduced in 20.1.2. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- SALESFORCE,MYVMWARE,SYSTEST), Basic edition(Allowed values- SALESFORCE,MYVMWARE,SYSTEST), Enterprise with Cloud Services edition.

string
name
Optional

Name of the ALBServicesConfig object. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

integer As uint32 As uint32
polling_interval
Optional
Constraints: default: 10

Time interval in minutes. Allowed values are 5-60. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
portal_url
Required

The FQDN or IP address of the Pulse Cloud Services. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
saas_licensing_config
Required

saas_licensing_config

object
session_config
Optional

session_config

object
split_proxy_configuration
Optional

split_proxy_configuration

object
tenant_config
Optional

tenant_config

string
tenant_ref
Optional

Tenant UUID associated with the Object. It is a reference to an object of type Tenant. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

string
url
Optional

url

boolean
use_split_proxy
Optional

By default, Pulse Cloud Services uses proxy added in system configuration. If it should use a separate proxy, set this flag to true and configure split proxy configuration. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
use_tls
Optional
Constraints: default: true

Secure the controller to Pulse Cloud Services communication over TLS. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

object
user_agent_db_config
Required

user_agent_db_config

string
uuid
Optional

Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
waf_config
Required

waf_config


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"app_signature_config:"object","case_config:"object","feature_opt_in_status:"object","inventory_config:"object","ip_reputation_config:"object","portal_url:"string","saas_licensing_config:"object","user_agent_db_config:"object","waf_config:"object"}' https://{api_host}/api/albservicesconfig