POST /wafcrs

• Waf Crs

/wafcrs

Request

URI

POST

https://api_host/api/wafcrs

COPY

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

WafCRS of type(s) application/json

Optional

{
    "_last_modified": "string",
    "allowed_request_content_type_charsets": [
        "string"
    ],
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "files": [
        {
            "data": "string",
            "name": "string",
            "type": "string"
        }
    ],
    "groups": [
        {
            "enable": false,
            "exclude_list": [
                {
                    "client_subnet": {
                        "ip_addr": {
                            "addr": "string",
                            "type": "string"
                        },
                        "mask": 0
                    },
                    "description": "string",
                    "match_element": "string",
                    "match_element_criteria": {
                        "match_case": "string",
                        "match_op": "string"
                    },
                    "uri_match_criteria": {
                        "match_case": "string",
                        "match_op": "string"
                    },
                    "uri_path": "string"
                }
            ],
            "index": 0,
            "name": "string",
            "rules": [
                {
                    "enable": false,
                    "exclude_list": [
                        {
                            "client_subnet": {
                                "ip_addr": {
                                    "addr": "string",
                                    "type": "string"
                                },
                                "mask": 0
                            },
                            "description": "string",
                            "match_element": "string",
                            "match_element_criteria": {
                                "match_case": "string",
                                "match_op": "string"
                            },
                            "uri_match_criteria": {
                                "match_case": "string",
                                "match_op": "string"
                            },
                            "uri_path": "string"
                        }
                    ],
                    "index": 0,
                    "is_sensitive": false,
                    "mode": "string",
                    "name": "string",
                    "paranoia_level": "string",
                    "phase": "string",
                    "rule": "string",
                    "rule_id": "string",
                    "tags": [
                        "string"
                    ]
                }
            ]
        }
    ],
    "integrity": "string",
    "integrity_values": [
        "string"
    ],
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "release_date": "string",
    "restricted_extensions": [
        "string"
    ],
    "restricted_headers": [
        "string"
    ],
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string",
    "version": "string"
}

string

_last_modified

Optional

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

array of string

allowed_request_content_type_charsets

Optional

Allowed request content type character sets in WAF. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ConfigPbAttributes

configpb_attributes

Optional

configpb_attributes

string

description

Required

A short description of this ruleset. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of WafDataFile

files

Optional

List of Data Files used for WAF Rules. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of WafRuleGroup

groups

Optional

WAF Rules are sorted in groups based on their characterization. Field introduced in 18.1.1. Maximum of 64 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

integrity

Required

Integrity protection value. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string

integrity_values

Optional

Integrity protection values for CRS. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of RoleFilterMatchLabel

markers

Optional

List of labels to be used for granular RBAC. Field introduced in 20.1.6. 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 this ruleset object. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

release_date

Required

The release date of this version in RFC 3339 / ISO 8601 format. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string

restricted_extensions

Optional

WAF Restricted File Extensions. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of string

restricted_headers

Optional

WAF Restricted HTTP Headers. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

tenant_ref

Optional

Tenant that this object belongs to. 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

Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

version

Required

The version of this ruleset object. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Responses

200

Hide Details

OK

Returns WafCRS of type(s) application/json

{
    "_last_modified": "string",
    "allowed_request_content_type_charsets": [
        "string"
    ],
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "files": [
        {
            "data": "string",
            "name": "string",
            "type": "string"
        }
    ],
    "groups": [
        {
            "enable": false,
            "exclude_list": [
                {
                    "client_subnet": {
                        "ip_addr": {
                            "addr": "string",
                            "type": "string"
                        },
                        "mask": 0
                    },
                    "description": "string",
                    "match_element": "string",
                    "match_element_criteria": {
                        "match_case": "string",
                        "match_op": "string"
                    },
                    "uri_match_criteria": {
                        "match_case": "string",
                        "match_op": "string"
                    },
                    "uri_path": "string"
                }
            ],
            "index": 0,
            "name": "string",
            "rules": [
                {
                    "enable": false,
                    "exclude_list": [
                        {
                            "client_subnet": {
                                "ip_addr": {
                                    "addr": "string",
                                    "type": "string"
                                },
                                "mask": 0
                            },
                            "description": "string",
                            "match_element": "string",
                            "match_element_criteria": {
                                "match_case": "string",
                                "match_op": "string"
                            },
                            "uri_match_criteria": {
                                "match_case": "string",
                                "match_op": "string"
                            },
                            "uri_path": "string"
                        }
                    ],
                    "index": 0,
                    "is_sensitive": false,
                    "mode": "string",
                    "name": "string",
                    "paranoia_level": "string",
                    "phase": "string",
                    "rule": "string",
                    "rule_id": "string",
                    "tags": [
                        "string"
                    ]
                }
            ]
        }
    ],
    "integrity": "string",
    "integrity_values": [
        "string"
    ],
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "release_date": "string",
    "restricted_extensions": [
        "string"
    ],
    "restricted_headers": [
        "string"
    ],
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string",
    "version": "string"
}

string

_last_modified

Optional

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

array of string

allowed_request_content_type_charsets

Optional

Allowed request content type character sets in WAF. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ConfigPbAttributes

configpb_attributes

Optional

configpb_attributes

string

description

Required

A short description of this ruleset. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of WafDataFile

files

Optional

List of Data Files used for WAF Rules. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of WafRuleGroup

groups

Optional

WAF Rules are sorted in groups based on their characterization. Field introduced in 18.1.1. Maximum of 64 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

integrity

Required

Integrity protection value. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string

integrity_values

Optional

Integrity protection values for CRS. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of RoleFilterMatchLabel

markers

Optional

List of labels to be used for granular RBAC. Field introduced in 20.1.6. 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 this ruleset object. Field introduced in 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

release_date

Required

The release date of this version in RFC 3339 / ISO 8601 format. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string

restricted_extensions

Optional

WAF Restricted File Extensions. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of string

restricted_headers

Optional

WAF Restricted HTTP Headers. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

tenant_ref

Optional

Tenant that this object belongs to. 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

Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

version

Required

The version of this ruleset object. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

401

Hide Details

log in failed

Operation doesn't return any data structure

On This Page

Description

Request

Header Parameters

Request Body

Response

200 Response Body

Errors

Waf Crs Operations

DELETE

DELETE /wafcrs/{uuid}

GET

GET /wafcrs

GET

GET /wafcrs/{uuid}

PATCH

PATCH /wafcrs/{uuid}

POST

POST /wafcrs

PUT

PUT /wafcrs/{uuid}