GET /albservicesconfig/{uuid}

GET /albservicesconfig/{uuid}

/albservicesconfig/{uuid}

Request
URI
GET
https://api_host/api/albservicesconfig/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

string
fields
Optional

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

boolean
include_name
Optional

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.

boolean
skip_default
Optional

Default values are not set.

string
join_subresources
Optional

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

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.


Responses
200

OK

Returns ALBServicesConfig of type(s) application/json
{
    "_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
    }
}
string
_last_modified
Optional

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

app_signature_config
Required

app_signature_config

asset_contact
Optional

asset_contact

case_config
Required

case_config

configpb_attributes
Optional

configpb_attributes

feature_opt_in_status
Required

feature_opt_in_status

inventory_config
Required

inventory_config

ip_reputation_config
Required

ip_reputation_config

string
mode
Optional

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

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.

saas_licensing_config
Required

saas_licensing_config

session_config
Optional

session_config

split_proxy_configuration
Optional

split_proxy_configuration

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

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.

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.

waf_config
Required

waf_config


401

log in failed

Operation doesn't return any data structure