PATCH /httppolicyset/{uuid}
/httppolicyset/{uuid}
Request
URI
PATCH
https://{api_host}/api/httppolicyset/{uuid}
COPY
Path Parameters
string
uuid
Required
UUID of the object to fetch
Query Parameters
string
name
Optional
object name
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
HTTPPolicySet object creation
HTTPPolicySet of type(s) application/json
Optional
Show optional properties
{
"name": "string"
}{
"_last_modified": "string",
"cloud_config_cksum": "string",
"configpb_attributes": {
"version": 0
},
"created_by": "string",
"description": "string",
"geo_db_ref": "string",
"http_request_policy": {
"rules": [
{
"all_headers": false,
"enable": false,
"hdr_action": [
{
"action": "string",
"cookie": {
"name": "string",
"value": "string"
},
"hdr": {
"name": "string",
"value": {
"is_sensitive": false,
"val": "string",
"var": "string"
}
},
"hdr_index": 0
}
],
"index": 0,
"log": false,
"match": {
"bot_detection_result": {
"classifications": [
{
"type": "string",
"user_defined_type": "string"
}
],
"match_operation": "string"
},
"client_ip": {
"addrs": [
{
"addr": "string",
"type": "string"
}
],
"group_refs": [
"string"
],
"match_criteria": "string",
"prefixes": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"ranges": [
{
"begin": {
"addr": "string",
"type": "string"
},
"end": {
"addr": "string",
"type": "string"
}
}
]
},
"cookie": {
"match_case": "string",
"match_criteria": "string",
"name": "string",
"value": "string"
},
"geo_matches": [
{
"attribute": "string",
"match_operation": "string",
"values": [
"string"
]
}
],
"hdrs": [
{
"hdr": "string",
"match_case": "string",
"match_criteria": "string",
"value": [
"string"
]
}
],
"host_hdr": {
"match_case": "string",
"match_criteria": "string",
"value": [
"string"
]
},
"ip_reputation_type": {
"match_operation": "string",
"reputation_types": [
"string"
]
},
"method": {
"match_criteria": "string",
"methods": [
"string"
]
},
"path": {
"match_case": "string",
"match_criteria": "string",
"match_decoded_string": false,
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
},
"protocol": {
"match_criteria": "string",
"protocols": "string"
},
"query": {
"match_case": "string",
"match_criteria": "string",
"match_decoded_string": false,
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
},
"source_ip": {
"addrs": [
{
"addr": "string",
"type": "string"
}
],
"group_refs": [
"string"
],
"match_criteria": "string",
"prefixes": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"ranges": [
{
"begin": {
"addr": "string",
"type": "string"
},
"end": {
"addr": "string",
"type": "string"
}
}
]
},
"tls_fingerprint_match": {
"fingerprints": [
"string"
],
"match_operation": "string",
"string_group_refs": [
"string"
]
},
"version": {
"match_criteria": "string",
"versions": [
"string"
]
},
"vs_port": {
"match_criteria": "string",
"ports": [
0
]
}
},
"name": "string",
"redirect_action": {
"add_string": "string",
"host": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"keep_query": false,
"path": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"port": 0,
"protocol": "string",
"status_code": "string"
},
"rewrite_url_action": {
"host_hdr": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"path": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"query": {
"add_string": "string",
"keep_query": false
}
},
"switching_action": {
"action": "string",
"file": {
"content_type": "string",
"file_content": "string",
"file_length": 0
},
"other_status_code": 0,
"pool_group_ref": "string",
"pool_ref": "string",
"server": {
"hostname": "string",
"ip": {
"addr": "string",
"type": "string"
},
"port": 0
},
"status_code": "string"
}
}
]
},
"http_response_policy": {
"rules": [
{
"all_headers": false,
"enable": false,
"hdr_action": [
{
"action": "string",
"cookie": {
"name": "string",
"value": "string"
},
"hdr": {
"name": "string",
"value": {
"is_sensitive": false,
"val": "string",
"var": "string"
}
},
"hdr_index": 0
}
],
"index": 0,
"loc_hdr_action": {
"host": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"keep_query": false,
"path": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"port": 0,
"protocol": "string"
},
"log": false,
"match": {
"client_ip": {
"addrs": [
{
"addr": "string",
"type": "string"
}
],
"group_refs": [
"string"
],
"match_criteria": "string",
"prefixes": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"ranges": [
{
"begin": {
"addr": "string",
"type": "string"
},
"end": {
"addr": "string",
"type": "string"
}
}
]
},
"cookie": {
"match_case": "string",
"match_criteria": "string",
"name": "string",
"value": "string"
},
"hdrs": [
{
"hdr": "string",
"match_case": "string",
"match_criteria": "string",
"value": [
"string"
]
}
],
"host_hdr": {
"match_case": "string",
"match_criteria": "string",
"value": [
"string"
]
},
"loc_hdr": {
"match_case": "string",
"match_criteria": "string",
"value": [
"string"
]
},
"method": {
"match_criteria": "string",
"methods": [
"string"
]
},
"path": {
"match_case": "string",
"match_criteria": "string",
"match_decoded_string": false,
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
},
"protocol": {
"match_criteria": "string",
"protocols": "string"
},
"query": {
"match_case": "string",
"match_criteria": "string",
"match_decoded_string": false,
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
},
"rsp_hdrs": [
{
"hdr": "string",
"match_case": "string",
"match_criteria": "string",
"value": [
"string"
]
}
],
"source_ip": {
"addrs": [
{
"addr": "string",
"type": "string"
}
],
"group_refs": [
"string"
],
"match_criteria": "string",
"prefixes": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"ranges": [
{
"begin": {
"addr": "string",
"type": "string"
},
"end": {
"addr": "string",
"type": "string"
}
}
]
},
"status": {
"match_criteria": "string",
"ranges": [
{
"begin": 0,
"end": 0
}
],
"status_codes": [
0
]
},
"version": {
"match_criteria": "string",
"versions": [
"string"
]
},
"vs_port": {
"match_criteria": "string",
"ports": [
0
]
}
},
"name": "string"
}
]
},
"http_security_policy": {
"rules": [
{
"action": {
"action": "string",
"file": {
"content_type": "string",
"file_content": "string",
"file_length": 0
},
"https_port": 0,
"rate_profile": {
"action": {
"file": {
"content_type": "string",
"file_content": "string",
"file_length": 0
},
"redirect": {
"add_string": "string",
"host": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"keep_query": false,
"path": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"port": 0,
"protocol": "string",
"status_code": "string"
},
"status_code": "string",
"type": "string"
},
"per_client_ip": false,
"per_uri_path": false,
"rate_limiter": {
"burst_sz": 0,
"count": 0,
"name": "string",
"period": 0
}
},
"status_code": "string"
},
"enable": false,
"index": 0,
"log": false,
"match": {
"bot_detection_result": {
"classifications": [
{
"type": "string",
"user_defined_type": "string"
}
],
"match_operation": "string"
},
"client_ip": {
"addrs": [
{
"addr": "string",
"type": "string"
}
],
"group_refs": [
"string"
],
"match_criteria": "string",
"prefixes": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"ranges": [
{
"begin": {
"addr": "string",
"type": "string"
},
"end": {
"addr": "string",
"type": "string"
}
}
]
},
"cookie": {
"match_case": "string",
"match_criteria": "string",
"name": "string",
"value": "string"
},
"geo_matches": [
{
"attribute": "string",
"match_operation": "string",
"values": [
"string"
]
}
],
"hdrs": [
{
"hdr": "string",
"match_case": "string",
"match_criteria": "string",
"value": [
"string"
]
}
],
"host_hdr": {
"match_case": "string",
"match_criteria": "string",
"value": [
"string"
]
},
"ip_reputation_type": {
"match_operation": "string",
"reputation_types": [
"string"
]
},
"method": {
"match_criteria": "string",
"methods": [
"string"
]
},
"path": {
"match_case": "string",
"match_criteria": "string",
"match_decoded_string": false,
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
},
"protocol": {
"match_criteria": "string",
"protocols": "string"
},
"query": {
"match_case": "string",
"match_criteria": "string",
"match_decoded_string": false,
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
},
"source_ip": {
"addrs": [
{
"addr": "string",
"type": "string"
}
],
"group_refs": [
"string"
],
"match_criteria": "string",
"prefixes": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"ranges": [
{
"begin": {
"addr": "string",
"type": "string"
},
"end": {
"addr": "string",
"type": "string"
}
}
]
},
"tls_fingerprint_match": {
"fingerprints": [
"string"
],
"match_operation": "string",
"string_group_refs": [
"string"
]
},
"version": {
"match_criteria": "string",
"versions": [
"string"
]
},
"vs_port": {
"match_criteria": "string",
"ports": [
0
]
}
},
"name": "string"
}
]
},
"ip_reputation_db_ref": "string",
"is_internal_policy": false,
"markers": [
{
"key": "string",
"values": [
"string"
]
}
],
"name": "string",
"tenant_ref": "string",
"url": "string",
"uuid": "string"
}
Responses
200
OK
Returns HTTPPolicySet of type(s) application/json
"HTTPPolicySet Object"string
_last_modified
Optional
UNIX time since epoch in microseconds. Units(MICROSECONDS).
string
cloud_config_cksum
Optional
Checksum of cloud configuration for Pool. Internally set by cloud connector. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
object
configpb_attributes
Optional
configpb_attributes
string
created_by
Optional
Creator name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
string
description
Optional
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
string
geo_db_ref
Optional
Geo database. It is a reference to an object of type GeoDB. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
object
http_request_policy
Optional
http_request_policy
object
http_response_policy
Optional
http_response_policy
object
http_security_policy
Optional
http_security_policy
string
ip_reputation_db_ref
Optional
IP reputation database. It is a reference to an object of type IPReputationDB. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
boolean
is_internal_policy
Optional
Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
array of object
markers
Optional
List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
string
name
Required
Name of the HTTP Policy Set. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
string
tenant_ref
Optional
It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
string
url
Optional
url
string
uuid
Optional
UUID of the HTTP Policy Set. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
401
log in failed
Operation doesn't return any data structure
Code Samples
COPY
curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}'
On This Page
Httppolicy Set Operations
GET
GET /httppolicyset
POST
POST /httppolicyset
GET
GET /httppolicyset/{uuid}
PUT
PUT /httppolicyset/{uuid}
PATCH
PATCH /httppolicyset/{uuid}
DELETE
DELETE /httppolicyset/{uuid}