PUT /securitypolicy/{uuid}

PUT /securitypolicy/{uuid}

/securitypolicy/{uuid}

Request
URI
PUT
https://{api_host}/api/securitypolicy/{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

SecurityPolicy object creation

SecurityPolicy of type(s) application/json
Optional

Show optional properties

{
    "dns_policy_index": 0,
    "name": "string",
    "network_security_policy_index": 0
}
{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "dns_amplification_denyports": {
        "match_criteria": "string",
        "ports": [
            0
        ],
        "ranges": [
            {
                "end": 0,
                "start": 0
            }
        ]
    },
    "dns_attacks": {
        "attacks": [
            {
                "attack_vector": "string",
                "enabled": false,
                "max_mitigation_age": 0,
                "mitigation_action": {
                    "deny": false
                },
                "threshold": 0
            }
        ],
        "oper_mode": "string"
    },
    "dns_policy_index": 0,
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "network_security_policy_index": 0,
    "oper_mode": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

Returns SecurityPolicy of type(s) application/json 
"SecurityPolicy Object"
string
_last_modified
Optional

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

object
configpb_attributes
Optional

configpb_attributes

string
description
Optional

Security policy is used to specify various configuration information used to perform Distributed Denial of Service (DDoS) attacks detection and mitigation. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
dns_amplification_denyports
Optional

dns_amplification_denyports

object
dns_attacks
Optional

dns_attacks

integer As uint32 As uint32
dns_policy_index
Required

Index of the dns policy to use for the mitigation rules applied to the dns attacks. Field introduced in 18.2.1. 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

The name of the security policy. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
network_security_policy_index
Required

Index of the network security policy to use for the mitigation rules applied to the attacks. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
oper_mode
Optional
Constraints: default: DETECTION

Mode of dealing with the attacks - perform detection only, or detect and mitigate the attacks. Enum options - DETECTION, MITIGATION. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

Tenancy of the security policy. It is a reference to an object of type Tenant. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

The UUID of the security policy. Field introduced in 18.2.1. 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 PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"dns_policy_index:"integer","name:"string","network_security_policy_index:"integer"}' https://{api_host}/api/securitypolicy/{uuid}
On This Page
Security Policy Operations
GET
GET /securitypolicy
POST
POST /securitypolicy
GET
GET /securitypolicy/{uuid}
PUT
PUT /securitypolicy/{uuid}
PATCH
PATCH /securitypolicy/{uuid}
DELETE
DELETE /securitypolicy/{uuid}