Avi IcapProfile Object API

CLI ``` - configure icapprofile - show icapprofile ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 20.1.2
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /icapprofile
  2. post /icapprofile
  3. delete /icapprofile/{uuid}
  4. get /icapprofile/{uuid}
  5. patch /icapprofile/{uuid}
  6. put /icapprofile/{uuid}
Up
get /icapprofile
(icapprofileGet)

Consumes

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

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.
cloud_uuid (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.
cloud_ref.name (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud usings its name. This uses cloud name rather than uuid. Eg. cloud_ref.name=Default-Cloud.

Return type

IcapProfileApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "response_timeout" : 123,
    "buffer_size" : 123,
    "description" : "aeiou",
    "pool_group_ref" : "aeiou",
    "slow_response_warning_threshold" : 123,
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "enable_preview" : true,
    "buffer_size_exceed_action" : "aeiou",
    "fail_action" : "aeiou",
    "service_uri" : "aeiou",
    "vendor" : "aeiou",
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "preview_size" : 123
  } ]
}

Produces

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

Responses

200

OK IcapProfileApiResponse

401

log in failed

Up
post /icapprofile
(icapprofilePost)

Consumes

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

Request body

body (required)
Body Parameter — IcapProfile object creation

Return type

IcapProfile

Example data

Content-Type: application/json
{
  "response_timeout" : 123,
  "buffer_size" : 123,
  "description" : "aeiou",
  "pool_group_ref" : "aeiou",
  "slow_response_warning_threshold" : 123,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "enable_preview" : true,
  "buffer_size_exceed_action" : "aeiou",
  "fail_action" : "aeiou",
  "service_uri" : "aeiou",
  "vendor" : "aeiou",
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "preview_size" : 123
}

Produces

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

Responses

200

OK IcapProfile

401

log in failed

Up
delete /icapprofile/{uuid}
(icapprofileUuidDelete)

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:

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /icapprofile/{uuid}
(icapprofileUuidGet)

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:

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

IcapProfile

Example data

Content-Type: application/json
{
  "response_timeout" : 123,
  "buffer_size" : 123,
  "description" : "aeiou",
  "pool_group_ref" : "aeiou",
  "slow_response_warning_threshold" : 123,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "enable_preview" : true,
  "buffer_size_exceed_action" : "aeiou",
  "fail_action" : "aeiou",
  "service_uri" : "aeiou",
  "vendor" : "aeiou",
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "preview_size" : 123
}

Produces

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

Responses

200

OK IcapProfile

401

log in failed

Up
patch /icapprofile/{uuid}
(icapprofileUuidPatch)

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:

Request body

body (required)
Body Parameter — IcapProfile object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

IcapProfile

Example data

Content-Type: application/json
{
  "response_timeout" : 123,
  "buffer_size" : 123,
  "description" : "aeiou",
  "pool_group_ref" : "aeiou",
  "slow_response_warning_threshold" : 123,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "enable_preview" : true,
  "buffer_size_exceed_action" : "aeiou",
  "fail_action" : "aeiou",
  "service_uri" : "aeiou",
  "vendor" : "aeiou",
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "preview_size" : 123
}

Produces

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

Responses

200

OK IcapProfile

401

log in failed

Up
put /icapprofile/{uuid}
(icapprofileUuidPut)

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:

Request body

body (required)
Body Parameter — IcapProfile object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

IcapProfile

Example data

Content-Type: application/json
{
  "response_timeout" : 123,
  "buffer_size" : 123,
  "description" : "aeiou",
  "pool_group_ref" : "aeiou",
  "slow_response_warning_threshold" : 123,
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "enable_preview" : true,
  "buffer_size_exceed_action" : "aeiou",
  "fail_action" : "aeiou",
  "service_uri" : "aeiou",
  "vendor" : "aeiou",
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "preview_size" : 123
}

Produces

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

Responses

200

OK IcapProfile

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. IcapProfile
  2. IcapProfileApiResponse

IcapProfile Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
buffer_size (optional)
Integer The maximum buffer size for the HTTP request body. If the request body exceeds this size, the request will not be checked by the ICAP server. In this case, the configured action will be executed and a significant log entry will be generated. Allowed values are 1-51200. Field introduced in 20.1.1. Unit is KB. format: int32
buffer_size_exceed_action (optional)
String Decide what should happen if the request body size exceeds the configured buffer size. If this is set to Fail Open, the request will not be checked by the ICAP server. If this is set to Fail Closed, the request will be rejected with 413 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1.
cloud_ref (optional)
String The cloud where this object belongs to. This must match the cloud referenced in the pool group below. It is a reference to an object of type Cloud. Field introduced in 20.1.1.
description (optional)
String A description for this ICAP profile. Field introduced in 20.1.1.
enable_preview (optional)
Boolean Use the ICAP preview feature as described in RFC 3507 section 4.5. Field introduced in 20.1.1.
fail_action (optional)
String Decide what should happen if there is a problem with the ICAP server like communication timeout, protocol error, pool error, etc. If this is set to Fail Open, the request will continue, but will create a significant log entry. If this is set to Fail Closed, the request will be rejected with a 503 status code. Enum options - ICAP_FAIL_OPEN, ICAP_FAIL_CLOSED. Field introduced in 20.1.1.
name
String Name of the ICAP profile. Field introduced in 20.1.1.
pool_group_ref
String The pool group which is used to connect to ICAP servers. It is a reference to an object of type PoolGroup. Field introduced in 20.1.1.
preview_size (optional)
Integer The ICAP preview size as described in RFC 3507 section 4.5. This should not exceed the size supported by the ICAP server. If this is set to 0, only the HTTP header will be sent to the ICAP server as a preview. To disable preview completely, set the enable-preview option to false. Allowed values are 0-5000. Field introduced in 20.1.1. Unit is BYTES. format: int32
response_timeout (optional)
Integer How long do we wait for a request to the ICAP server to finish. If this timeout is exceeded, the request to the ICAP server will be aborted and the configured fail action is executed. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is MILLISECONDS. format: int32
service_uri
String The path and query component of the ICAP URL. Host name and port will be taken from the pool. Field introduced in 20.1.1.
slow_response_warning_threshold (optional)
Integer If the ICAP request takes longer than this value, this request will generate a significant log entry. Allowed values are 50-3600000. Field introduced in 20.1.1. Unit is MILLISECONDS. format: int32
tenant_ref (optional)
String Tenant which this object belongs to. It is a reference to an object of type Tenant. Field introduced in 20.1.1.
url (optional)
String url
uuid (optional)
String UUID of the ICAP profile. Field introduced in 20.1.1.
vendor (optional)
String The vendor of the ICAP server. Enum options - ICAP_VENDOR_GENERIC, ICAP_VENDOR_OPSWAT. Field introduced in 20.1.1.

IcapProfileApiResponse Up

count
Integer format: int32
results
next (optional)