Avi ALBServicesConfig Object API

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

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

Contact Info: support@avinetworks.com

Version: 20.1.9

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"
        } ]
      } ]
    },
    "split_proxy_configuration" : {
      "password" : "aeiou",
      "port" : 123,
      "host" : "aeiou",
      "username" : "aeiou"
    },
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_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_auto_case_creation_on_system_failure" : true,
      "enable_auto_case_creation_on_se_failure" : true,
      "enable_auto_download_waf_signatures" : true,
      "enable_ip_reputation" : true,
      "enable_waf_signatures_notifications" : true
    },
    "ip_reputation_config" : {
      "ip_reputation_sync_interval" : 123,
      "ip_reputation_file_object_expiry_duration" : 123
    },
    "portal_url" : "aeiou",
    "polling_interval" : 123,
    "proactive_support_defaults" : {
      "attach_tech_support" : true,
      "attach_core_dump" : true,
      "case_severity" : "aeiou"
    },
    "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"
      } ]
    } ]
  },
  "split_proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_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_auto_case_creation_on_system_failure" : true,
    "enable_auto_case_creation_on_se_failure" : true,
    "enable_auto_download_waf_signatures" : true,
    "enable_ip_reputation" : true,
    "enable_waf_signatures_notifications" : true
  },
  "ip_reputation_config" : {
    "ip_reputation_sync_interval" : 123,
    "ip_reputation_file_object_expiry_duration" : 123
  },
  "portal_url" : "aeiou",
  "polling_interval" : 123,
  "proactive_support_defaults" : {
    "attach_tech_support" : true,
    "attach_core_dump" : true,
    "case_severity" : "aeiou"
  },
  "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"
      } ]
    } ]
  },
  "split_proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_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_auto_case_creation_on_system_failure" : true,
    "enable_auto_case_creation_on_se_failure" : true,
    "enable_auto_download_waf_signatures" : true,
    "enable_ip_reputation" : true,
    "enable_waf_signatures_notifications" : true
  },
  "ip_reputation_config" : {
    "ip_reputation_sync_interval" : 123,
    "ip_reputation_file_object_expiry_duration" : 123
  },
  "portal_url" : "aeiou",
  "polling_interval" : 123,
  "proactive_support_defaults" : {
    "attach_tech_support" : true,
    "attach_core_dump" : true,
    "case_severity" : "aeiou"
  },
  "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"
      } ]
    } ]
  },
  "split_proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_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_auto_case_creation_on_system_failure" : true,
    "enable_auto_case_creation_on_se_failure" : true,
    "enable_auto_download_waf_signatures" : true,
    "enable_ip_reputation" : true,
    "enable_waf_signatures_notifications" : true
  },
  "ip_reputation_config" : {
    "ip_reputation_sync_interval" : 123,
    "ip_reputation_file_object_expiry_duration" : 123
  },
  "portal_url" : "aeiou",
  "polling_interval" : 123,
  "proactive_support_defaults" : {
    "attach_tech_support" : true,
    "attach_core_dump" : true,
    "case_severity" : "aeiou"
  },
  "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"
      } ]
    } ]
  },
  "split_proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_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_auto_case_creation_on_system_failure" : true,
    "enable_auto_case_creation_on_se_failure" : true,
    "enable_auto_download_waf_signatures" : true,
    "enable_ip_reputation" : true,
    "enable_waf_signatures_notifications" : true
  },
  "ip_reputation_config" : {
    "ip_reputation_sync_interval" : 123,
    "ip_reputation_file_object_expiry_duration" : 123
  },
  "portal_url" : "aeiou",
  "polling_interval" : 123,
  "proactive_support_defaults" : {
    "attach_tech_support" : true,
    "attach_core_dump" : true,
    "case_severity" : "aeiou"
  },
  "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
IpReputationConfig
PortalFeatureOptIn
ProactiveSupportDefaults
ProxyConfiguration

ALBServicesAccount Up

id (optional)

String ID of an Account in the customer portal. Field introduced in 20.1.1.

name (optional)

String Account to which the customer portal user belongs. Field introduced in 20.1.1.

users (optional)

array[ALBServicesAccountUser] Information about users within the account in the customer portal. Field introduced in 20.1.1.

ALBServicesAccountUser Up

String Field introduced in 20.1.1.

name

String Field introduced in 20.1.1.

phone

String Field introduced in 20.1.1.

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 Basic edition, Essentials edition, Enterprise edition.

asset_contact (optional)

ALBServicesUser Information about the default contact for this controller cluster. Field introduced in 20.1.1.

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.

mode (optional)

String Mode helps log collection and upload. Enum options - SALESFORCE, SYSTEST, MYVMWARE. Field introduced in 20.1.2. Allowed in Basic(Allowed values- SALESFORCE,MYVMWARE,SYSTEST) edition, Essentials(Allowed values- SALESFORCE,MYVMWARE,SYSTEST) edition, Enterprise edition.

polling_interval (optional)

Integer Time interval in minutes. Allowed values are 5-60. Field introduced in 18.2.6. format: int32

portal_url

String The FQDN or IP address of the customer portal. Field introduced in 18.2.6.

proactive_support_defaults

ProactiveSupportDefaults Default values to be used during proactive case creation and techsupport attachment. Field introduced in 20.1.1.

split_proxy_configuration

ProxyConfiguration Split proxy configuration to connect external pulse services. Field introduced in 20.1.1.

url (optional)

String url

use_split_proxy (optional)

Boolean By default, use system proxy configuration.If true, use split proxy configuration. Field introduced in 20.1.1.

use_tls (optional)

Boolean Secure the controller to PULSE communication over TLS. Field introduced in 20.1.3.

uuid (optional)

String Field introduced in 18.2.6.

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.

account_name (optional)

String Name of primary account of the portal user. Field introduced in 20.1.1.

String Email ID of the portal user. Field introduced in 20.1.1.

managed_accounts (optional)

array[ALBServicesAccount] Information about all the accounts managed by user in the customer portal. Field introduced in 20.1.1.

name (optional)

String Name of the portal user. Field introduced in 20.1.1.

phone (optional)

String Phone number of the user. Field introduced in 20.1.1.

AppSignatureConfig Up

app_signature_sync_interval (optional)

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

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

ip_reputation_sync_interval (optional)

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

PortalFeatureOptIn Up

enable_appsignature_sync (optional)

Boolean Enable to subscribe to automated Application Signature Rulesets updates. Field introduced in 20.1.4. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise 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 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.

enable_auto_case_creation_on_system_failure (optional)

Boolean Enable to allow pro-active support case creation when a system failure occurs. Manual download will still be available in the customer portal. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.

enable_auto_download_waf_signatures (optional)

Boolean Enable to automatically download new CRS version to the Controller. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.

enable_ip_reputation (optional)

Boolean Enable to subscribe to IP reputation updates. This is a requirement for using IP reputation in the product. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.

enable_waf_signatures_notifications (optional)

Boolean Enable event notifications when new CRS versions are available. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials edition is false, Enterprise is True.

ProactiveSupportDefaults Up

attach_core_dump (optional)

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

attach_tech_support (optional)

Boolean Opt-in to attach tech support with support case. Field introduced in 20.1.1. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Special default for Basic edition is false, Essentials 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.

ProxyConfiguration Up

host

String Proxy hostname or IP address.

password (optional)

String Password for proxy.

port

Integer Proxy port. format: int32

username (optional)

String Username for proxy.

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