Avi ALBServicesConfig Object API

CLI ``` - show albservicesconfig - configure albservicesconfig ```

More information: https://avinetworks.com/contact-us

Contact Info: support@avinetworks.com

Version: 22.1.5

BasePath:/api

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /albservicesconfig
post /albservicesconfig
delete /albservicesconfig/{uuid}
get /albservicesconfig/{uuid}
patch /albservicesconfig/{uuid}
put /albservicesconfig/{uuid}

get /albservicesconfig

(albservicesconfigGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

refers_to (optional)

Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid

referred_by (optional)

Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

ALBServicesConfigApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "asset_contact" : {
      "account_id" : "aeiou",
      "phone" : "aeiou",
      "account_name" : "aeiou",
      "name" : "aeiou",
      "email" : "aeiou",
      "managed_accounts" : [ {
        "name" : "aeiou",
        "id" : "aeiou",
        "users" : [ {
          "phone" : "aeiou",
          "name" : "aeiou",
          "email" : "aeiou"
        } ]
      } ]
    },
    "operations_config" : {
      "inventory_config" : {
        "enable" : true
      }
    },
    "split_proxy_configuration" : {
      "password" : "aeiou",
      "port" : 123,
      "host" : "aeiou",
      "username" : "aeiou"
    },
    "saas_licensing_config" : {
      "max_service_units" : 1.3579000000000001069366817318950779736042022705078125,
      "reserve_service_units" : 1.3579000000000001069366817318950779736042022705078125
    },
    "uuid" : "aeiou",
    "url" : "aeiou",
    "user_agent_db_config" : {
      "allowed_batch_size" : 123
    },
    "_last_modified" : "aeiou",
    "app_signature_config" : {
      "app_signature_sync_interval" : 123
    },
    "mode" : "aeiou",
    "use_tls" : true,
    "feature_opt_in_status" : {
      "enable_appsignature_sync" : true,
      "enable_pulse_waf_management" : true,
      "enable_pulse_case_management" : true,
      "enable_user_agent_db_sync" : true,
      "enable_ip_reputation" : true
    },
    "ip_reputation_config" : {
      "ip_reputation_sync_interval" : 123,
      "ip_reputation_file_object_expiry_duration" : 123
    },
    "portal_url" : "aeiou",
    "case_config" : {
      "enable_cleanup_of_attached_files" : true,
      "enable_auto_case_creation_on_controller_failure" : true,
      "enable_auto_case_creation_on_se_failure" : true
    },
    "configpb_attributes" : {
      "version" : 123
    },
    "waf_config" : {
      "enable_auto_download_waf_signatures" : true,
      "enable_waf_signatures_notifications" : true
    },
    "polling_interval" : 123,
    "use_split_proxy" : true
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK ALBServicesConfigApiResponse

401

post /albservicesconfig

(albservicesconfigPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — ALBServicesConfig object creation

Return type

ALBServicesConfig

Example data

Content-Type: application/json

{
  "asset_contact" : {
    "account_id" : "aeiou",
    "phone" : "aeiou",
    "account_name" : "aeiou",
    "name" : "aeiou",
    "email" : "aeiou",
    "managed_accounts" : [ {
      "name" : "aeiou",
      "id" : "aeiou",
      "users" : [ {
        "phone" : "aeiou",
        "name" : "aeiou",
        "email" : "aeiou"
      } ]
    } ]
  },
  "operations_config" : {
    "inventory_config" : {
      "enable" : true
    }
  },
  "split_proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "saas_licensing_config" : {
    "max_service_units" : 1.3579000000000001069366817318950779736042022705078125,
    "reserve_service_units" : 1.3579000000000001069366817318950779736042022705078125
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "user_agent_db_config" : {
    "allowed_batch_size" : 123
  },
  "_last_modified" : "aeiou",
  "app_signature_config" : {
    "app_signature_sync_interval" : 123
  },
  "mode" : "aeiou",
  "use_tls" : true,
  "feature_opt_in_status" : {
    "enable_appsignature_sync" : true,
    "enable_pulse_waf_management" : true,
    "enable_pulse_case_management" : true,
    "enable_user_agent_db_sync" : true,
    "enable_ip_reputation" : true
  },
  "ip_reputation_config" : {
    "ip_reputation_sync_interval" : 123,
    "ip_reputation_file_object_expiry_duration" : 123
  },
  "portal_url" : "aeiou",
  "case_config" : {
    "enable_cleanup_of_attached_files" : true,
    "enable_auto_case_creation_on_controller_failure" : true,
    "enable_auto_case_creation_on_se_failure" : true
  },
  "configpb_attributes" : {
    "version" : 123
  },
  "waf_config" : {
    "enable_auto_download_waf_signatures" : true,
    "enable_waf_signatures_notifications" : true
  },
  "polling_interval" : 123,
  "use_split_proxy" : true
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK ALBServicesConfig

401

delete /albservicesconfig/{uuid}

(albservicesconfigUuidDelete)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

Return type

String

Example data

Content-Type: application/json

"aeiou"

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204

object deleted String

404

not found

get /albservicesconfig/{uuid}

(albservicesconfigUuidGet)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

ALBServicesConfig

Example data

Content-Type: application/json

{
  "asset_contact" : {
    "account_id" : "aeiou",
    "phone" : "aeiou",
    "account_name" : "aeiou",
    "name" : "aeiou",
    "email" : "aeiou",
    "managed_accounts" : [ {
      "name" : "aeiou",
      "id" : "aeiou",
      "users" : [ {
        "phone" : "aeiou",
        "name" : "aeiou",
        "email" : "aeiou"
      } ]
    } ]
  },
  "operations_config" : {
    "inventory_config" : {
      "enable" : true
    }
  },
  "split_proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "saas_licensing_config" : {
    "max_service_units" : 1.3579000000000001069366817318950779736042022705078125,
    "reserve_service_units" : 1.3579000000000001069366817318950779736042022705078125
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "user_agent_db_config" : {
    "allowed_batch_size" : 123
  },
  "_last_modified" : "aeiou",
  "app_signature_config" : {
    "app_signature_sync_interval" : 123
  },
  "mode" : "aeiou",
  "use_tls" : true,
  "feature_opt_in_status" : {
    "enable_appsignature_sync" : true,
    "enable_pulse_waf_management" : true,
    "enable_pulse_case_management" : true,
    "enable_user_agent_db_sync" : true,
    "enable_ip_reputation" : true
  },
  "ip_reputation_config" : {
    "ip_reputation_sync_interval" : 123,
    "ip_reputation_file_object_expiry_duration" : 123
  },
  "portal_url" : "aeiou",
  "case_config" : {
    "enable_cleanup_of_attached_files" : true,
    "enable_auto_case_creation_on_controller_failure" : true,
    "enable_auto_case_creation_on_se_failure" : true
  },
  "configpb_attributes" : {
    "version" : 123
  },
  "waf_config" : {
    "enable_auto_download_waf_signatures" : true,
    "enable_waf_signatures_notifications" : true
  },
  "polling_interval" : 123,
  "use_split_proxy" : true
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK ALBServicesConfig

401

patch /albservicesconfig/{uuid}

(albservicesconfigUuidPatch)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — ALBServicesConfig object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

ALBServicesConfig

Example data

Content-Type: application/json

{
  "asset_contact" : {
    "account_id" : "aeiou",
    "phone" : "aeiou",
    "account_name" : "aeiou",
    "name" : "aeiou",
    "email" : "aeiou",
    "managed_accounts" : [ {
      "name" : "aeiou",
      "id" : "aeiou",
      "users" : [ {
        "phone" : "aeiou",
        "name" : "aeiou",
        "email" : "aeiou"
      } ]
    } ]
  },
  "operations_config" : {
    "inventory_config" : {
      "enable" : true
    }
  },
  "split_proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "saas_licensing_config" : {
    "max_service_units" : 1.3579000000000001069366817318950779736042022705078125,
    "reserve_service_units" : 1.3579000000000001069366817318950779736042022705078125
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "user_agent_db_config" : {
    "allowed_batch_size" : 123
  },
  "_last_modified" : "aeiou",
  "app_signature_config" : {
    "app_signature_sync_interval" : 123
  },
  "mode" : "aeiou",
  "use_tls" : true,
  "feature_opt_in_status" : {
    "enable_appsignature_sync" : true,
    "enable_pulse_waf_management" : true,
    "enable_pulse_case_management" : true,
    "enable_user_agent_db_sync" : true,
    "enable_ip_reputation" : true
  },
  "ip_reputation_config" : {
    "ip_reputation_sync_interval" : 123,
    "ip_reputation_file_object_expiry_duration" : 123
  },
  "portal_url" : "aeiou",
  "case_config" : {
    "enable_cleanup_of_attached_files" : true,
    "enable_auto_case_creation_on_controller_failure" : true,
    "enable_auto_case_creation_on_se_failure" : true
  },
  "configpb_attributes" : {
    "version" : 123
  },
  "waf_config" : {
    "enable_auto_download_waf_signatures" : true,
    "enable_waf_signatures_notifications" : true
  },
  "polling_interval" : 123,
  "use_split_proxy" : true
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK ALBServicesConfig

401

put /albservicesconfig/{uuid}

(albservicesconfigUuidPut)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — ALBServicesConfig object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

ALBServicesConfig

Example data

Content-Type: application/json

{
  "asset_contact" : {
    "account_id" : "aeiou",
    "phone" : "aeiou",
    "account_name" : "aeiou",
    "name" : "aeiou",
    "email" : "aeiou",
    "managed_accounts" : [ {
      "name" : "aeiou",
      "id" : "aeiou",
      "users" : [ {
        "phone" : "aeiou",
        "name" : "aeiou",
        "email" : "aeiou"
      } ]
    } ]
  },
  "operations_config" : {
    "inventory_config" : {
      "enable" : true
    }
  },
  "split_proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "saas_licensing_config" : {
    "max_service_units" : 1.3579000000000001069366817318950779736042022705078125,
    "reserve_service_units" : 1.3579000000000001069366817318950779736042022705078125
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "user_agent_db_config" : {
    "allowed_batch_size" : 123
  },
  "_last_modified" : "aeiou",
  "app_signature_config" : {
    "app_signature_sync_interval" : 123
  },
  "mode" : "aeiou",
  "use_tls" : true,
  "feature_opt_in_status" : {
    "enable_appsignature_sync" : true,
    "enable_pulse_waf_management" : true,
    "enable_pulse_case_management" : true,
    "enable_user_agent_db_sync" : true,
    "enable_ip_reputation" : true
  },
  "ip_reputation_config" : {
    "ip_reputation_sync_interval" : 123,
    "ip_reputation_file_object_expiry_duration" : 123
  },
  "portal_url" : "aeiou",
  "case_config" : {
    "enable_cleanup_of_attached_files" : true,
    "enable_auto_case_creation_on_controller_failure" : true,
    "enable_auto_case_creation_on_se_failure" : true
  },
  "configpb_attributes" : {
    "version" : 123
  },
  "waf_config" : {
    "enable_auto_download_waf_signatures" : true,
    "enable_waf_signatures_notifications" : true
  },
  "polling_interval" : 123,
  "use_split_proxy" : true
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK ALBServicesConfig

401

Models

[ Jump to Methods ]

ALBServicesAccount
ALBServicesAccountUser
ALBServicesConfig
ALBServicesConfigApiResponse
ALBServicesUser
AppSignatureConfig
CaseConfig
ConfigPbAttributes
InventoryConfig
IpReputationConfig
OperationsConfig
PortalFeatureOptIn
ProactiveSupportDefaults
ProxyConfiguration
SaasLicensingInfo
UserAgentDBConfig
WafCrsConfig

ALBServicesAccount Up

id (optional)

String ID of an Account in the customer portal. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

name (optional)

String Account to which the customer portal user belongs. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

users (optional)

array[ALBServicesAccountUser] Information about users within the account in the customer portal. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ALBServicesAccountUser Up

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

name

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

phone

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

ALBServicesConfig Up

_last_modified (optional)

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

app_signature_config

AppSignatureConfig Default values to be used for Application Signature sync. Field introduced in 20.1.4. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

asset_contact (optional)

ALBServicesUser Information about the default contact for this controller cluster. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

case_config

CaseConfig Default values to be used for pulse case management. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

configpb_attributes (optional)

ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

feature_opt_in_status

PortalFeatureOptIn Information about the portal features opted in for controller. Field introduced in 20.1.1.

ip_reputation_config

IpReputationConfig Default values to be used for IP Reputation sync. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

mode (optional)

String Mode helps log collection and upload. Enum options - MODE_UNKNOWN, SALESFORCE, SYSTEST, MYVMWARE. 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.

operations_config

OperationsConfig Operations configuration. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

polling_interval (optional)

Integer 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. format: int32

portal_url

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

saas_licensing_config

SaasLicensingInfo Saas licensing configuration. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

split_proxy_configuration

ProxyConfiguration Split proxy configuration to connect external pulse services. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

url (optional)

String url

use_split_proxy (optional)

Boolean By default, pulse uses proxy added in system configuration. If pulse needs to use a seperate 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.

use_tls (optional)

Boolean Secure the controller to PULSE 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.

user_agent_db_config

UserAgentDBConfig Default values to be used for user agent DB Service. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

uuid (optional)

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

waf_config

WafCrsConfig Default values to be used for pulse waf management. Field introduced in 21.1.1. Allowed in Essentials edition with any value, Basic edition with any value, Enterprise, Enterprise with Cloud Services edition.

ALBServicesConfigApiResponse Up

count

Integer format: int32

results

array[ALBServicesConfig]

next (optional)

String

ALBServicesUser Up

account_id (optional)

String ID of primary account of the portal user. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

account_name (optional)

String Name of primary account of the portal user. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

String Email ID of the portal user. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

managed_accounts (optional)

array[ALBServicesAccount] Information about all the accounts managed by user in the customer portal. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

name (optional)

String Name of the portal user. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

phone (optional)

String Phone number of the user. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

AppSignatureConfig Up

app_signature_sync_interval (optional)

Integer Application Signature db sync interval in minutes. Allowed values are 1440-10080. Field introduced in 20.1.4. Unit is MIN. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. Special default for Essentials edition is 1440, Basic edition is 1440, Enterprise is 1440. format: int32

CaseConfig Up

enable_auto_case_creation_on_controller_failure (optional)

Boolean Enable pro-active support case creation when a controller failure occurs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

enable_auto_case_creation_on_se_failure (optional)

Boolean Enable pro-active support case creation when a service engine failure occurs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

enable_cleanup_of_attached_files (optional)

Boolean Enable cleanup of successfully attached files to support case. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition. Special default for Essentials edition is false, Basic edition is false, Enterprise is True.

ConfigPbAttributes Up

version (optional)

Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32

InventoryConfig Up

enable (optional)

Boolean Allow inventory stats to be regularly sent to pulse portal. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

IpReputationConfig Up

ip_reputation_file_object_expiry_duration (optional)

Integer IP reputation db file object expiry duration in days. Allowed values are 1-7. Field introduced in 20.1.1. Unit is DAYS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

ip_reputation_sync_interval (optional)

Integer IP reputation db sync interval in minutes. Allowed values are 30-1440. Field introduced in 20.1.1. Unit is MIN. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 60), Basic edition(Allowed values- 60), Enterprise with Cloud Services edition. format: int32

OperationsConfig Up

inventory_config (optional)

InventoryConfig Inventory op config. Field introduced in 22.1.3. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

PortalFeatureOptIn Up

enable_appsignature_sync (optional)

Boolean Enable to receive Application specific signature updates. Field introduced in 20.1.4. Allowed in Enterprise edition only with addon license, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

enable_ip_reputation (optional)

Boolean Enable to receive IP reputation updates. Field introduced in 20.1.1. Allowed in Enterprise edition only with addon license, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

enable_pulse_case_management (optional)

Boolean Enable Pulse Case Management. Field introduced in 21.1.1. Allowed in Enterprise edition only with addon license, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition. Special default for Enterprise edition is false, Essentials edition is false, Basic edition is false, Enterprise is True.

enable_pulse_waf_management (optional)

Boolean Enable to receive WAF CRS updates. Field introduced in 21.1.1. Allowed in Enterprise edition only with addon license, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition. Special default for Enterprise edition is false, Essentials edition is false, Basic edition is false, Enterprise is True.

enable_user_agent_db_sync (optional)

Boolean Enable to receive Bot Management updates. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

ProactiveSupportDefaults Up

attach_core_dump (optional)

Boolean Opt-in to attach core dump with support case. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

attach_tech_support (optional)

Boolean Opt-in to attach tech support with support case. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition. Special default for Essentials edition is false, Basic edition is false, Enterprise is True.

case_severity (optional)

String Case severity to be used for proactive support case creation. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ProxyConfiguration Up

host

String Proxy hostname or IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

password (optional)

String Password for proxy. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

port

Integer Proxy port. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

username (optional)

String Username for proxy. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SaasLicensingInfo Up

max_service_units (optional)

Double Maximum service units limit for controller. Allowed values are 0-1000. Special values are 0 - infinite. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: double

reserve_service_units (optional)

Double Minimum service units that always remain reserved on controller. Allowed values are 0-1000. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: double

UserAgentDBConfig Up

allowed_batch_size (optional)

Integer Batch query limit. Allowed values are 1-500. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 500), Basic edition(Allowed values- 500), Enterprise with Cloud Services edition. format: int32

WafCrsConfig Up

enable_auto_download_waf_signatures (optional)

Boolean Enable to automatically download new WAF signatures/CRS version to the Controller. Field introduced in 21.1.1. Allowed in Enterprise edition only with addon license, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition.

enable_waf_signatures_notifications (optional)

Boolean Enable event notifications when new WAF signatures/CRS versions are available. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition. Special default for Essentials edition is false, Basic edition is false, Enterprise is True.

Avi ALBServicesConfig Object API

Access

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

204

404

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Table of Contents