Avi HTTPPolicySet Object API

CLI ``` - configure httppolicyset - show httppolicyset ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 20.1.9
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 /httppolicyset
  2. post /httppolicyset
  3. delete /httppolicyset/{uuid}
  4. get /httppolicyset/{uuid}
  5. patch /httppolicyset/{uuid}
  6. put /httppolicyset/{uuid}
Up 
get /httppolicyset
(httppolicysetGet)

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.

Return type

HTTPPolicySetApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "http_security_policy" : {
      "rules" : [ {
        "log" : true,
        "enable" : true,
        "match" : "",
        "name" : "aeiou",
        "action" : {
          "https_port" : 123,
          "rate_profile" : {
            "rate_limiter" : "",
            "per_uri_path" : true,
            "action" : "",
            "per_client_ip" : true
          },
          "file" : "",
          "rate_limit" : {
            "rate_limiter" : {
              "period" : 123,
              "count" : 123,
              "name" : "aeiou",
              "burst_sz" : 123
            },
            "period" : 123,
            "count" : 123,
            "action" : {
              "redirect" : "",
              "file" : "",
              "status_code" : "aeiou",
              "type" : "aeiou"
            },
            "burst_sz" : 123,
            "explicit_tracking" : true,
            "fine_grain" : true,
            "http_cookie" : "aeiou",
            "http_header" : "aeiou"
          },
          "status_code" : "aeiou",
          "action" : "aeiou"
        },
        "index" : 123
      } ]
    },
    "is_internal_policy" : true,
    "description" : "aeiou",
    "created_by" : "aeiou",
    "http_response_policy" : {
      "rules" : [ {
        "all_headers" : true,
        "log" : true,
        "enable" : true,
        "loc_hdr_action" : {
          "keep_query" : true,
          "path" : "",
          "protocol" : "aeiou",
          "port" : 123,
          "host" : ""
        },
        "match" : {
          "cookie" : "",
          "method" : "",
          "host_hdr" : "",
          "query" : "",
          "vs_port" : "",
          "hdrs" : [ "" ],
          "version" : "",
          "path" : "",
          "rsp_hdrs" : [ "" ],
          "protocol" : "",
          "client_ip" : "",
          "loc_hdr" : {
            "match_criteria" : "aeiou",
            "value" : [ "aeiou" ],
            "match_case" : "aeiou"
          },
          "status" : {
            "match_criteria" : "aeiou",
            "ranges" : [ {
              "end" : 123,
              "begin" : 123
            } ],
            "status_codes" : [ "" ]
          }
        },
        "name" : "aeiou",
        "hdr_action" : [ "" ],
        "index" : 123
      } ]
    },
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "labels" : [ {
      "value" : "aeiou",
      "key" : "aeiou"
    } ],
    "http_request_policy" : {
      "rules" : [ {
        "all_headers" : true,
        "switching_action" : {
          "pool_ref" : "aeiou",
          "server" : {
            "hostname" : "aeiou",
            "port" : 123,
            "ip" : ""
          },
          "file" : {
            "file_content" : "aeiou",
            "content_type" : "aeiou"
          },
          "status_code" : "aeiou",
          "action" : "aeiou",
          "pool_group_ref" : "aeiou"
        },
        "log" : true,
        "enable" : true,
        "match" : {
          "path" : {
            "match_criteria" : "aeiou",
            "string_group_refs" : [ "aeiou" ],
            "match_str" : [ "aeiou" ],
            "match_case" : "aeiou"
          },
          "protocol" : {
            "match_criteria" : "aeiou",
            "protocols" : "aeiou"
          },
          "cookie" : {
            "match_criteria" : "aeiou",
            "name" : "aeiou",
            "value" : "aeiou",
            "match_case" : "aeiou"
          },
          "method" : {
            "match_criteria" : "aeiou",
            "methods" : [ "aeiou" ]
          },
          "host_hdr" : {
            "match_criteria" : "aeiou",
            "value" : [ "aeiou" ],
            "match_case" : "aeiou"
          },
          "ip_reputation_type" : {
            "reputation_types" : [ "aeiou" ],
            "match_operation" : "aeiou"
          },
          "query" : {
            "match_criteria" : "aeiou",
            "string_group_refs" : [ "aeiou" ],
            "match_str" : [ "aeiou" ],
            "match_case" : "aeiou"
          },
          "vs_port" : {
            "match_criteria" : "aeiou",
            "ports" : [ "" ]
          },
          "client_ip" : {
            "group_refs" : [ "aeiou" ],
            "match_criteria" : "aeiou",
            "prefixes" : [ {
              "ip_addr" : "",
              "mask" : 123
            } ],
            "ranges" : [ {
              "end" : "",
              "begin" : ""
            } ],
            "addrs" : [ {
              "addr" : "aeiou",
              "type" : "aeiou"
            } ]
          },
          "hdrs" : [ {
            "match_criteria" : "aeiou",
            "hdr" : "aeiou",
            "value" : [ "aeiou" ],
            "match_case" : "aeiou"
          } ],
          "version" : {
            "match_criteria" : "aeiou",
            "versions" : [ "aeiou" ]
          }
        },
        "name" : "aeiou",
        "redirect_action" : {
          "keep_query" : true,
          "path" : "",
          "protocol" : "aeiou",
          "status_code" : "aeiou",
          "port" : 123,
          "host" : {
            "tokens" : [ {
              "start_index" : 123,
              "str_value" : "aeiou",
              "end_index" : 123,
              "type" : "aeiou"
            } ],
            "type" : "aeiou"
          }
        },
        "hdr_action" : [ {
          "cookie" : {
            "name" : "aeiou",
            "value" : "aeiou"
          },
          "hdr" : {
            "name" : "aeiou",
            "value" : {
              "val" : "aeiou",
              "var" : "aeiou"
            }
          },
          "action" : "aeiou"
        } ],
        "index" : 123,
        "rewrite_url_action" : {
          "path" : "",
          "host_hdr" : "",
          "query" : {
            "keep_query" : true,
            "add_string" : "aeiou"
          }
        }
      } ]
    },
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "cloud_config_cksum" : "aeiou",
    "markers" : [ {
      "values" : [ "aeiou" ],
      "key" : "aeiou"
    } ],
    "ip_reputation_db_ref" : "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

200

OK HTTPPolicySetApiResponse

401

log in failed
Up 
post /httppolicyset
(httppolicysetPost)

Consumes

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

Request body

body (required)
Body Parameter — HTTPPolicySet object creation

Return type

HTTPPolicySet

Example data

Content-Type: application/json
{
  "http_security_policy" : {
    "rules" : [ {
      "log" : true,
      "enable" : true,
      "match" : "",
      "name" : "aeiou",
      "action" : {
        "https_port" : 123,
        "rate_profile" : {
          "rate_limiter" : "",
          "per_uri_path" : true,
          "action" : "",
          "per_client_ip" : true
        },
        "file" : "",
        "rate_limit" : {
          "rate_limiter" : {
            "period" : 123,
            "count" : 123,
            "name" : "aeiou",
            "burst_sz" : 123
          },
          "period" : 123,
          "count" : 123,
          "action" : {
            "redirect" : "",
            "file" : "",
            "status_code" : "aeiou",
            "type" : "aeiou"
          },
          "burst_sz" : 123,
          "explicit_tracking" : true,
          "fine_grain" : true,
          "http_cookie" : "aeiou",
          "http_header" : "aeiou"
        },
        "status_code" : "aeiou",
        "action" : "aeiou"
      },
      "index" : 123
    } ]
  },
  "is_internal_policy" : true,
  "description" : "aeiou",
  "created_by" : "aeiou",
  "http_response_policy" : {
    "rules" : [ {
      "all_headers" : true,
      "log" : true,
      "enable" : true,
      "loc_hdr_action" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "port" : 123,
        "host" : ""
      },
      "match" : {
        "cookie" : "",
        "method" : "",
        "host_hdr" : "",
        "query" : "",
        "vs_port" : "",
        "hdrs" : [ "" ],
        "version" : "",
        "path" : "",
        "rsp_hdrs" : [ "" ],
        "protocol" : "",
        "client_ip" : "",
        "loc_hdr" : {
          "match_criteria" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "status" : {
          "match_criteria" : "aeiou",
          "ranges" : [ {
            "end" : 123,
            "begin" : 123
          } ],
          "status_codes" : [ "" ]
        }
      },
      "name" : "aeiou",
      "hdr_action" : [ "" ],
      "index" : 123
    } ]
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "http_request_policy" : {
    "rules" : [ {
      "all_headers" : true,
      "switching_action" : {
        "pool_ref" : "aeiou",
        "server" : {
          "hostname" : "aeiou",
          "port" : 123,
          "ip" : ""
        },
        "file" : {
          "file_content" : "aeiou",
          "content_type" : "aeiou"
        },
        "status_code" : "aeiou",
        "action" : "aeiou",
        "pool_group_ref" : "aeiou"
      },
      "log" : true,
      "enable" : true,
      "match" : {
        "path" : {
          "match_criteria" : "aeiou",
          "string_group_refs" : [ "aeiou" ],
          "match_str" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "protocol" : {
          "match_criteria" : "aeiou",
          "protocols" : "aeiou"
        },
        "cookie" : {
          "match_criteria" : "aeiou",
          "name" : "aeiou",
          "value" : "aeiou",
          "match_case" : "aeiou"
        },
        "method" : {
          "match_criteria" : "aeiou",
          "methods" : [ "aeiou" ]
        },
        "host_hdr" : {
          "match_criteria" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "ip_reputation_type" : {
          "reputation_types" : [ "aeiou" ],
          "match_operation" : "aeiou"
        },
        "query" : {
          "match_criteria" : "aeiou",
          "string_group_refs" : [ "aeiou" ],
          "match_str" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "vs_port" : {
          "match_criteria" : "aeiou",
          "ports" : [ "" ]
        },
        "client_ip" : {
          "group_refs" : [ "aeiou" ],
          "match_criteria" : "aeiou",
          "prefixes" : [ {
            "ip_addr" : "",
            "mask" : 123
          } ],
          "ranges" : [ {
            "end" : "",
            "begin" : ""
          } ],
          "addrs" : [ {
            "addr" : "aeiou",
            "type" : "aeiou"
          } ]
        },
        "hdrs" : [ {
          "match_criteria" : "aeiou",
          "hdr" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        } ],
        "version" : {
          "match_criteria" : "aeiou",
          "versions" : [ "aeiou" ]
        }
      },
      "name" : "aeiou",
      "redirect_action" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "status_code" : "aeiou",
        "port" : 123,
        "host" : {
          "tokens" : [ {
            "start_index" : 123,
            "str_value" : "aeiou",
            "end_index" : 123,
            "type" : "aeiou"
          } ],
          "type" : "aeiou"
        }
      },
      "hdr_action" : [ {
        "cookie" : {
          "name" : "aeiou",
          "value" : "aeiou"
        },
        "hdr" : {
          "name" : "aeiou",
          "value" : {
            "val" : "aeiou",
            "var" : "aeiou"
          }
        },
        "action" : "aeiou"
      } ],
      "index" : 123,
      "rewrite_url_action" : {
        "path" : "",
        "host_hdr" : "",
        "query" : {
          "keep_query" : true,
          "add_string" : "aeiou"
        }
      }
    } ]
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "cloud_config_cksum" : "aeiou",
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "ip_reputation_db_ref" : "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

200

OK HTTPPolicySet

401

log in failed
Up 
delete /httppolicyset/{uuid}
(httppolicysetUuidDelete)

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 /httppolicyset/{uuid}
(httppolicysetUuidGet)

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

HTTPPolicySet

Example data

Content-Type: application/json
{
  "http_security_policy" : {
    "rules" : [ {
      "log" : true,
      "enable" : true,
      "match" : "",
      "name" : "aeiou",
      "action" : {
        "https_port" : 123,
        "rate_profile" : {
          "rate_limiter" : "",
          "per_uri_path" : true,
          "action" : "",
          "per_client_ip" : true
        },
        "file" : "",
        "rate_limit" : {
          "rate_limiter" : {
            "period" : 123,
            "count" : 123,
            "name" : "aeiou",
            "burst_sz" : 123
          },
          "period" : 123,
          "count" : 123,
          "action" : {
            "redirect" : "",
            "file" : "",
            "status_code" : "aeiou",
            "type" : "aeiou"
          },
          "burst_sz" : 123,
          "explicit_tracking" : true,
          "fine_grain" : true,
          "http_cookie" : "aeiou",
          "http_header" : "aeiou"
        },
        "status_code" : "aeiou",
        "action" : "aeiou"
      },
      "index" : 123
    } ]
  },
  "is_internal_policy" : true,
  "description" : "aeiou",
  "created_by" : "aeiou",
  "http_response_policy" : {
    "rules" : [ {
      "all_headers" : true,
      "log" : true,
      "enable" : true,
      "loc_hdr_action" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "port" : 123,
        "host" : ""
      },
      "match" : {
        "cookie" : "",
        "method" : "",
        "host_hdr" : "",
        "query" : "",
        "vs_port" : "",
        "hdrs" : [ "" ],
        "version" : "",
        "path" : "",
        "rsp_hdrs" : [ "" ],
        "protocol" : "",
        "client_ip" : "",
        "loc_hdr" : {
          "match_criteria" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "status" : {
          "match_criteria" : "aeiou",
          "ranges" : [ {
            "end" : 123,
            "begin" : 123
          } ],
          "status_codes" : [ "" ]
        }
      },
      "name" : "aeiou",
      "hdr_action" : [ "" ],
      "index" : 123
    } ]
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "http_request_policy" : {
    "rules" : [ {
      "all_headers" : true,
      "switching_action" : {
        "pool_ref" : "aeiou",
        "server" : {
          "hostname" : "aeiou",
          "port" : 123,
          "ip" : ""
        },
        "file" : {
          "file_content" : "aeiou",
          "content_type" : "aeiou"
        },
        "status_code" : "aeiou",
        "action" : "aeiou",
        "pool_group_ref" : "aeiou"
      },
      "log" : true,
      "enable" : true,
      "match" : {
        "path" : {
          "match_criteria" : "aeiou",
          "string_group_refs" : [ "aeiou" ],
          "match_str" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "protocol" : {
          "match_criteria" : "aeiou",
          "protocols" : "aeiou"
        },
        "cookie" : {
          "match_criteria" : "aeiou",
          "name" : "aeiou",
          "value" : "aeiou",
          "match_case" : "aeiou"
        },
        "method" : {
          "match_criteria" : "aeiou",
          "methods" : [ "aeiou" ]
        },
        "host_hdr" : {
          "match_criteria" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "ip_reputation_type" : {
          "reputation_types" : [ "aeiou" ],
          "match_operation" : "aeiou"
        },
        "query" : {
          "match_criteria" : "aeiou",
          "string_group_refs" : [ "aeiou" ],
          "match_str" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "vs_port" : {
          "match_criteria" : "aeiou",
          "ports" : [ "" ]
        },
        "client_ip" : {
          "group_refs" : [ "aeiou" ],
          "match_criteria" : "aeiou",
          "prefixes" : [ {
            "ip_addr" : "",
            "mask" : 123
          } ],
          "ranges" : [ {
            "end" : "",
            "begin" : ""
          } ],
          "addrs" : [ {
            "addr" : "aeiou",
            "type" : "aeiou"
          } ]
        },
        "hdrs" : [ {
          "match_criteria" : "aeiou",
          "hdr" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        } ],
        "version" : {
          "match_criteria" : "aeiou",
          "versions" : [ "aeiou" ]
        }
      },
      "name" : "aeiou",
      "redirect_action" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "status_code" : "aeiou",
        "port" : 123,
        "host" : {
          "tokens" : [ {
            "start_index" : 123,
            "str_value" : "aeiou",
            "end_index" : 123,
            "type" : "aeiou"
          } ],
          "type" : "aeiou"
        }
      },
      "hdr_action" : [ {
        "cookie" : {
          "name" : "aeiou",
          "value" : "aeiou"
        },
        "hdr" : {
          "name" : "aeiou",
          "value" : {
            "val" : "aeiou",
            "var" : "aeiou"
          }
        },
        "action" : "aeiou"
      } ],
      "index" : 123,
      "rewrite_url_action" : {
        "path" : "",
        "host_hdr" : "",
        "query" : {
          "keep_query" : true,
          "add_string" : "aeiou"
        }
      }
    } ]
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "cloud_config_cksum" : "aeiou",
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "ip_reputation_db_ref" : "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

200

OK HTTPPolicySet

401

log in failed
Up 
patch /httppolicyset/{uuid}
(httppolicysetUuidPatch)

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 — HTTPPolicySet object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

HTTPPolicySet

Example data

Content-Type: application/json
{
  "http_security_policy" : {
    "rules" : [ {
      "log" : true,
      "enable" : true,
      "match" : "",
      "name" : "aeiou",
      "action" : {
        "https_port" : 123,
        "rate_profile" : {
          "rate_limiter" : "",
          "per_uri_path" : true,
          "action" : "",
          "per_client_ip" : true
        },
        "file" : "",
        "rate_limit" : {
          "rate_limiter" : {
            "period" : 123,
            "count" : 123,
            "name" : "aeiou",
            "burst_sz" : 123
          },
          "period" : 123,
          "count" : 123,
          "action" : {
            "redirect" : "",
            "file" : "",
            "status_code" : "aeiou",
            "type" : "aeiou"
          },
          "burst_sz" : 123,
          "explicit_tracking" : true,
          "fine_grain" : true,
          "http_cookie" : "aeiou",
          "http_header" : "aeiou"
        },
        "status_code" : "aeiou",
        "action" : "aeiou"
      },
      "index" : 123
    } ]
  },
  "is_internal_policy" : true,
  "description" : "aeiou",
  "created_by" : "aeiou",
  "http_response_policy" : {
    "rules" : [ {
      "all_headers" : true,
      "log" : true,
      "enable" : true,
      "loc_hdr_action" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "port" : 123,
        "host" : ""
      },
      "match" : {
        "cookie" : "",
        "method" : "",
        "host_hdr" : "",
        "query" : "",
        "vs_port" : "",
        "hdrs" : [ "" ],
        "version" : "",
        "path" : "",
        "rsp_hdrs" : [ "" ],
        "protocol" : "",
        "client_ip" : "",
        "loc_hdr" : {
          "match_criteria" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "status" : {
          "match_criteria" : "aeiou",
          "ranges" : [ {
            "end" : 123,
            "begin" : 123
          } ],
          "status_codes" : [ "" ]
        }
      },
      "name" : "aeiou",
      "hdr_action" : [ "" ],
      "index" : 123
    } ]
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "http_request_policy" : {
    "rules" : [ {
      "all_headers" : true,
      "switching_action" : {
        "pool_ref" : "aeiou",
        "server" : {
          "hostname" : "aeiou",
          "port" : 123,
          "ip" : ""
        },
        "file" : {
          "file_content" : "aeiou",
          "content_type" : "aeiou"
        },
        "status_code" : "aeiou",
        "action" : "aeiou",
        "pool_group_ref" : "aeiou"
      },
      "log" : true,
      "enable" : true,
      "match" : {
        "path" : {
          "match_criteria" : "aeiou",
          "string_group_refs" : [ "aeiou" ],
          "match_str" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "protocol" : {
          "match_criteria" : "aeiou",
          "protocols" : "aeiou"
        },
        "cookie" : {
          "match_criteria" : "aeiou",
          "name" : "aeiou",
          "value" : "aeiou",
          "match_case" : "aeiou"
        },
        "method" : {
          "match_criteria" : "aeiou",
          "methods" : [ "aeiou" ]
        },
        "host_hdr" : {
          "match_criteria" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "ip_reputation_type" : {
          "reputation_types" : [ "aeiou" ],
          "match_operation" : "aeiou"
        },
        "query" : {
          "match_criteria" : "aeiou",
          "string_group_refs" : [ "aeiou" ],
          "match_str" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "vs_port" : {
          "match_criteria" : "aeiou",
          "ports" : [ "" ]
        },
        "client_ip" : {
          "group_refs" : [ "aeiou" ],
          "match_criteria" : "aeiou",
          "prefixes" : [ {
            "ip_addr" : "",
            "mask" : 123
          } ],
          "ranges" : [ {
            "end" : "",
            "begin" : ""
          } ],
          "addrs" : [ {
            "addr" : "aeiou",
            "type" : "aeiou"
          } ]
        },
        "hdrs" : [ {
          "match_criteria" : "aeiou",
          "hdr" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        } ],
        "version" : {
          "match_criteria" : "aeiou",
          "versions" : [ "aeiou" ]
        }
      },
      "name" : "aeiou",
      "redirect_action" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "status_code" : "aeiou",
        "port" : 123,
        "host" : {
          "tokens" : [ {
            "start_index" : 123,
            "str_value" : "aeiou",
            "end_index" : 123,
            "type" : "aeiou"
          } ],
          "type" : "aeiou"
        }
      },
      "hdr_action" : [ {
        "cookie" : {
          "name" : "aeiou",
          "value" : "aeiou"
        },
        "hdr" : {
          "name" : "aeiou",
          "value" : {
            "val" : "aeiou",
            "var" : "aeiou"
          }
        },
        "action" : "aeiou"
      } ],
      "index" : 123,
      "rewrite_url_action" : {
        "path" : "",
        "host_hdr" : "",
        "query" : {
          "keep_query" : true,
          "add_string" : "aeiou"
        }
      }
    } ]
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "cloud_config_cksum" : "aeiou",
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "ip_reputation_db_ref" : "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

200

OK HTTPPolicySet

401

log in failed
Up 
put /httppolicyset/{uuid}
(httppolicysetUuidPut)

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 — HTTPPolicySet object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

HTTPPolicySet

Example data

Content-Type: application/json
{
  "http_security_policy" : {
    "rules" : [ {
      "log" : true,
      "enable" : true,
      "match" : "",
      "name" : "aeiou",
      "action" : {
        "https_port" : 123,
        "rate_profile" : {
          "rate_limiter" : "",
          "per_uri_path" : true,
          "action" : "",
          "per_client_ip" : true
        },
        "file" : "",
        "rate_limit" : {
          "rate_limiter" : {
            "period" : 123,
            "count" : 123,
            "name" : "aeiou",
            "burst_sz" : 123
          },
          "period" : 123,
          "count" : 123,
          "action" : {
            "redirect" : "",
            "file" : "",
            "status_code" : "aeiou",
            "type" : "aeiou"
          },
          "burst_sz" : 123,
          "explicit_tracking" : true,
          "fine_grain" : true,
          "http_cookie" : "aeiou",
          "http_header" : "aeiou"
        },
        "status_code" : "aeiou",
        "action" : "aeiou"
      },
      "index" : 123
    } ]
  },
  "is_internal_policy" : true,
  "description" : "aeiou",
  "created_by" : "aeiou",
  "http_response_policy" : {
    "rules" : [ {
      "all_headers" : true,
      "log" : true,
      "enable" : true,
      "loc_hdr_action" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "port" : 123,
        "host" : ""
      },
      "match" : {
        "cookie" : "",
        "method" : "",
        "host_hdr" : "",
        "query" : "",
        "vs_port" : "",
        "hdrs" : [ "" ],
        "version" : "",
        "path" : "",
        "rsp_hdrs" : [ "" ],
        "protocol" : "",
        "client_ip" : "",
        "loc_hdr" : {
          "match_criteria" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "status" : {
          "match_criteria" : "aeiou",
          "ranges" : [ {
            "end" : 123,
            "begin" : 123
          } ],
          "status_codes" : [ "" ]
        }
      },
      "name" : "aeiou",
      "hdr_action" : [ "" ],
      "index" : 123
    } ]
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "http_request_policy" : {
    "rules" : [ {
      "all_headers" : true,
      "switching_action" : {
        "pool_ref" : "aeiou",
        "server" : {
          "hostname" : "aeiou",
          "port" : 123,
          "ip" : ""
        },
        "file" : {
          "file_content" : "aeiou",
          "content_type" : "aeiou"
        },
        "status_code" : "aeiou",
        "action" : "aeiou",
        "pool_group_ref" : "aeiou"
      },
      "log" : true,
      "enable" : true,
      "match" : {
        "path" : {
          "match_criteria" : "aeiou",
          "string_group_refs" : [ "aeiou" ],
          "match_str" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "protocol" : {
          "match_criteria" : "aeiou",
          "protocols" : "aeiou"
        },
        "cookie" : {
          "match_criteria" : "aeiou",
          "name" : "aeiou",
          "value" : "aeiou",
          "match_case" : "aeiou"
        },
        "method" : {
          "match_criteria" : "aeiou",
          "methods" : [ "aeiou" ]
        },
        "host_hdr" : {
          "match_criteria" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "ip_reputation_type" : {
          "reputation_types" : [ "aeiou" ],
          "match_operation" : "aeiou"
        },
        "query" : {
          "match_criteria" : "aeiou",
          "string_group_refs" : [ "aeiou" ],
          "match_str" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "vs_port" : {
          "match_criteria" : "aeiou",
          "ports" : [ "" ]
        },
        "client_ip" : {
          "group_refs" : [ "aeiou" ],
          "match_criteria" : "aeiou",
          "prefixes" : [ {
            "ip_addr" : "",
            "mask" : 123
          } ],
          "ranges" : [ {
            "end" : "",
            "begin" : ""
          } ],
          "addrs" : [ {
            "addr" : "aeiou",
            "type" : "aeiou"
          } ]
        },
        "hdrs" : [ {
          "match_criteria" : "aeiou",
          "hdr" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        } ],
        "version" : {
          "match_criteria" : "aeiou",
          "versions" : [ "aeiou" ]
        }
      },
      "name" : "aeiou",
      "redirect_action" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "status_code" : "aeiou",
        "port" : 123,
        "host" : {
          "tokens" : [ {
            "start_index" : 123,
            "str_value" : "aeiou",
            "end_index" : 123,
            "type" : "aeiou"
          } ],
          "type" : "aeiou"
        }
      },
      "hdr_action" : [ {
        "cookie" : {
          "name" : "aeiou",
          "value" : "aeiou"
        },
        "hdr" : {
          "name" : "aeiou",
          "value" : {
            "val" : "aeiou",
            "var" : "aeiou"
          }
        },
        "action" : "aeiou"
      } ],
      "index" : 123,
      "rewrite_url_action" : {
        "path" : "",
        "host_hdr" : "",
        "query" : {
          "keep_query" : true,
          "add_string" : "aeiou"
        }
      }
    } ]
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "cloud_config_cksum" : "aeiou",
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "ip_reputation_db_ref" : "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

200

OK HTTPPolicySet

401

log in failed
Up

Models

[ Jump to Methods ]

Table of Contents

  1. CookieMatch
  2. HTTPCookieData
  3. HTTPHdrAction
  4. HTTPHdrData
  5. HTTPHdrValue
  6. HTTPLocalFile
  7. HTTPPolicySet
  8. HTTPPolicySetApiResponse
  9. HTTPRedirectAction
  10. HTTPRequestPolicy
  11. HTTPRequestRule
  12. HTTPResponsePolicy
  13. HTTPResponseRule
  14. HTTPRewriteLocHdrAction
  15. HTTPRewriteURLAction
  16. HTTPSecurityAction
  17. HTTPSecurityActionRateProfile
  18. HTTPSecurityPolicy
  19. HTTPSecurityRule
  20. HTTPStatusMatch
  21. HTTPStatusRange
  22. HTTPSwitchingAction
  23. HTTPVersionMatch
  24. HdrMatch
  25. HostHdrMatch
  26. IPReputationTypeMatch
  27. IpAddr
  28. IpAddrMatch
  29. IpAddrPrefix
  30. IpAddrRange
  31. KeyValue
  32. LocationHdrMatch
  33. MatchTarget
  34. MethodMatch
  35. PathMatch
  36. PoolServer
  37. PortMatch
  38. ProtocolMatch
  39. QueryMatch
  40. RateLimiter
  41. RateLimiterAction
  42. RateProfile
  43. ResponseMatchTarget
  44. RoleFilterMatchLabel
  45. URIParam
  46. URIParamQuery
  47. URIParamToken

CookieMatch Up

match_case (optional)
String Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE.
match_criteria
String Criterion to use for matching the cookie in the HTTP request. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL.
name
String Name of the cookie.
value (optional)
String String value in the cookie.

HTTPCookieData Up

name (optional)
String Cookie name.
value (optional)
String Cookie value.

HTTPHdrAction Up

action
String ADD A new header with the new value is added irrespective of the existence of an HTTP header of the given name. REPLACE A new header with the new value is added if no header of the given name exists, else existing headers with the given name are removed and a new header with the new value is added. REMOVE All the headers of the given name are removed. Enum options - HTTP_ADD_HDR, HTTP_REMOVE_HDR, HTTP_REPLACE_HDR. Allowed in Basic(Allowed values- HTTP_REMOVE_HDR,HTTP_REPLACE_HDR) edition, Essentials(Allowed values- HTTP_REMOVE_HDR,HTTP_REPLACE_HDR) edition, Enterprise edition.
cookie (optional)
HTTPCookieData Cookie information.
hdr (optional)
HTTPHdrData HTTP header information.

HTTPHdrData Up

name (optional)
String HTTP header name.
value (optional)
HTTPHdrValue HTTP header value.

HTTPHdrValue Up

val (optional)
String HTTP header value or variable representing an HTTP header.
var (optional)
String Variable. Enum options - HTTP_POLICY_VAR_CLIENT_IP, HTTP_POLICY_VAR_VS_PORT, HTTP_POLICY_VAR_VS_IP, HTTP_POLICY_VAR_HTTP_HDR, HTTP_POLICY_VAR_SSL_CLIENT_FINGERPRINT, HTTP_POLICY_VAR_SSL_CLIENT_SERIAL, HTTP_POLICY_VAR_SSL_CLIENT_ISSUER, HTTP_POLICY_VAR_SSL_CLIENT_SUBJECT, HTTP_POLICY_VAR_SSL_CLIENT_RAW, HTTP_POLICY_VAR_SSL_PROTOCOL, HTTP_POLICY_VAR_SSL_SERVER_NAME, HTTP_POLICY_VAR_USER_NAME, HTTP_POLICY_VAR_SSL_CIPHER, HTTP_POLICY_VAR_REQUEST_ID, HTTP_POLICY_VAR_SSL_CLIENT_VERSION, HTTP_POLICY_VAR_SSL_CLIENT_SIGALG, HTTP_POLICY_VAR_SSL_CLIENT_NOTVALIDBEFORE, HTTP_POLICY_VAR_SSL_CLIENT_NOTVALIDAFTER.

HTTPLocalFile Up

content_type
String Mime-type of the content in the file.
file_content
String File content to used in the local HTTP response body.

HTTPPolicySet Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
cloud_config_cksum (optional)
String Checksum of cloud configuration for Pool. Internally set by cloud connector.
created_by (optional)
String Creator name.
description (optional)
String User defined description for the object.
http_request_policy (optional)
HTTPRequestPolicy HTTP request policy for the virtual service.
http_response_policy (optional)
HTTPResponsePolicy HTTP response policy for the virtual service.
http_security_policy (optional)
HTTPSecurityPolicy HTTP security policy for the virtual service.
ip_reputation_db_ref (optional)
String IP reputation database. It is a reference to an object of type IPReputationDB. Field introduced in 20.1.3.
is_internal_policy (optional)
Boolean Placeholder for description of property is_internal_policy of obj type HTTPPolicySet field type str type boolean
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field deprecated in 20.1.5. Field introduced in 20.1.2. Maximum of 4 items allowed.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Basic edition, Essentials edition, Enterprise edition.
name
String Name of the HTTP Policy Set.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String UUID of the HTTP Policy Set.

HTTPPolicySetApiResponse Up

count
Integer format: int32
results
array[HTTPPolicySet]
next (optional)
String

HTTPRedirectAction Up

host (optional)
URIParam Host config.
keep_query (optional)
Boolean Keep or drop the query of the incoming request URI in the redirected URI.
path (optional)
URIParam Path config.
port (optional)
Integer Port to which redirect the request. Allowed values are 1-65535. format: int32
protocol
String Protocol type. Enum options - HTTP, HTTPS.
status_code (optional)
String HTTP redirect status code. Enum options - HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_307.

HTTPRequestPolicy Up

rules (optional)
array[HTTPRequestRule] Add rules to the HTTP request policy.

HTTPRequestRule Up

all_headers (optional)
Boolean Log all HTTP headers upon rule match.
enable
Boolean Enable or disable the rule.
hdr_action (optional)
array[HTTPHdrAction] HTTP header rewrite action.
index
Integer Index of the rule. format: int32
log (optional)
Boolean Log HTTP request upon rule match.
match (optional)
MatchTarget Add match criteria to the rule.
name
String Name of the rule.
redirect_action (optional)
HTTPRedirectAction HTTP redirect action.
rewrite_url_action (optional)
HTTPRewriteURLAction HTTP request URL rewrite action.
switching_action (optional)
HTTPSwitchingAction Content switching action.

HTTPResponsePolicy Up

rules (optional)
array[HTTPResponseRule] Add rules to the HTTP response policy.

HTTPResponseRule Up

all_headers (optional)
Boolean Log all HTTP headers upon rule match.
enable
Boolean Enable or disable the rule.
hdr_action (optional)
array[HTTPHdrAction] HTTP header rewrite action.
index
Integer Index of the rule. format: int32
loc_hdr_action (optional)
HTTPRewriteLocHdrAction Location header rewrite action.
log (optional)
Boolean Log HTTP request upon rule match.
match (optional)
ResponseMatchTarget Add match criteria to the rule.
name
String Name of the rule.

HTTPRewriteLocHdrAction Up

host (optional)
URIParam Host config.
keep_query (optional)
Boolean Keep or drop the query from the server side redirect URI.
path (optional)
URIParam Path config.
port (optional)
Integer Port to use in the redirected URI. Allowed values are 1-65535. format: int32
protocol
String HTTP protocol type. Enum options - HTTP, HTTPS.

HTTPRewriteURLAction Up

host_hdr (optional)
URIParam Host config.
path (optional)
URIParam Path config.
query (optional)
URIParamQuery Query config.

HTTPSecurityAction Up

action
String Type of the security action to perform. Enum options - HTTP_SECURITY_ACTION_CLOSE_CONN, HTTP_SECURITY_ACTION_SEND_RESPONSE, HTTP_SECURITY_ACTION_ALLOW, HTTP_SECURITY_ACTION_REDIRECT_TO_HTTPS, HTTP_SECURITY_ACTION_RATE_LIMIT, HTTP_SECURITY_ACTION_REQUEST_CHECK_ICAP. Allowed in Basic(Allowed values- HTTP_SECURITY_ACTION_CLOSE_CONN,HTTP_SECURITY_ACTION_SEND_RESPONSE,HTTP_SECURITY_ACTION_REDIRECT_TO_HTTPS) edition, Essentials(Allowed values- HTTP_SECURITY_ACTION_CLOSE_CONN,HTTP_SECURITY_ACTION_SEND_RESPONSE,HTTP_SECURITY_ACTION_REDIRECT_TO_HTTPS) edition, Enterprise edition.
file (optional)
HTTPLocalFile File to be used for generating HTTP local response.
https_port (optional)
Integer Secure SSL/TLS port to redirect the HTTP request to. Allowed values are 1-65535. format: int32
rate_limit (optional)
RateProfile Rate Limit profile to be used to rate-limit the flow. (deprecated). Field deprecated in 18.2.9.
rate_profile (optional)
HTTPSecurityActionRateProfile Rate limiting configuration for this action. Field introduced in 18.2.9. Allowed in Basic edition, Essentials edition, Enterprise edition.
status_code (optional)
String HTTP status code to use for local response. Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501.

HTTPSecurityActionRateProfile Up

action
RateLimiterAction The action to take when the rate limit has been reached. Field introduced in 18.2.9.
per_client_ip (optional)
Boolean Rate limiting should be done on a per client ip basis. Field introduced in 18.2.9.
per_uri_path (optional)
Boolean Rate limiting should be done on a per request uri path basis. Field introduced in 18.2.9.
rate_limiter
RateLimiter The rate limiter used when this action is triggered. Field introduced in 18.2.9.

HTTPSecurityPolicy Up

rules (optional)
array[HTTPSecurityRule] Add rules to the HTTP security policy.

HTTPSecurityRule Up

action (optional)
HTTPSecurityAction Action to be performed upon successful matching.
enable
Boolean Enable or disable the rule.
index
Integer Index of the rule. format: int32
log (optional)
Boolean Log HTTP request upon rule match.
match (optional)
MatchTarget Add match criteria to the rule.
name
String Name of the rule.

HTTPStatusMatch Up

match_criteria
String Criterion to use for matching the HTTP response status code(s). Enum options - IS_IN, IS_NOT_IN.
ranges (optional)
array[HTTPStatusRange] HTTP response status code range(s).
status_codes (optional)
array[Integer] HTTP response status code(s).

HTTPStatusRange Up

begin
Integer Starting HTTP response status code. format: int32
end
Integer Ending HTTP response status code. format: int32

HTTPSwitchingAction Up

action
String Content switching action type. Enum options - HTTP_SWITCHING_SELECT_POOL, HTTP_SWITCHING_SELECT_LOCAL, HTTP_SWITCHING_SELECT_POOLGROUP. Allowed in Essentials(Allowed values- HTTP_SWITCHING_SELECT_POOL,HTTP_SWITCHING_SELECT_LOCAL) edition, Enterprise edition.
file (optional)
HTTPLocalFile File from which to serve local response to the request.
pool_group_ref (optional)
String UUID of the pool group to serve the request. It is a reference to an object of type PoolGroup.
pool_ref (optional)
String UUID of the pool of servers to serve the request. It is a reference to an object of type Pool.
server (optional)
PoolServer Specific pool server to select.
status_code (optional)
String HTTP status code to use when serving local response. Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501.

HTTPVersionMatch Up

match_criteria
String Criterion to use for HTTP version matching the version used in the HTTP request. Enum options - IS_IN, IS_NOT_IN.
versions (optional)
array[String] HTTP protocol version. Enum options - ZERO_NINE, ONE_ZERO, ONE_ONE, TWO_ZERO. Minimum of 1 items required. Maximum of 8 items allowed. Allowed in Basic(Allowed values- ONE_ZERO,ONE_ONE) edition, Essentials(Allowed values- ONE_ZERO,ONE_ONE) edition, Enterprise edition.

HdrMatch Up

hdr
String Name of the HTTP header whose value is to be matched.
match_case (optional)
String Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE.
match_criteria
String Criterion to use for matching headers in the HTTP request. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL.
value (optional)
array[String] String values to match in the HTTP header.

HostHdrMatch Up

match_case (optional)
String Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE.
match_criteria
String Criterion to use for the host header value match. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL.
value (optional)
array[String] String value(s) in the host header.

IPReputationTypeMatch Up

match_operation
String Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 20.1.1.
reputation_types (optional)
array[String] IP reputation type. Enum options - IP_REPUTATION_TYPE_SPAM_SOURCE, IP_REPUTATION_TYPE_WINDOWS_EXPLOITS, IP_REPUTATION_TYPE_WEB_ATTACKS, IP_REPUTATION_TYPE_BOTNETS, IP_REPUTATION_TYPE_SCANNERS, IP_REPUTATION_TYPE_DOS, IP_REPUTATION_TYPE_REPUTATION, IP_REPUTATION_TYPE_PHISHING, IP_REPUTATION_TYPE_PROXY, IP_REPUTATION_TYPE_NETWORK, IP_REPUTATION_TYPE_CLOUD, IP_REPUTATION_TYPE_MOBILE_THREATS, IP_REPUTATION_TYPE_TOR, IP_REPUTATION_TYPE_ALL. Field introduced in 20.1.1. Minimum of 1 items required.

IpAddr Up

addr
String IP address.
type
String Enum options - V4, DNS, V6.

IpAddrMatch Up

addrs (optional)
array[IpAddr] IP address(es).
group_refs (optional)
array[String] UUID of IP address group(s). It is a reference to an object of type IpAddrGroup.
match_criteria
String Criterion to use for IP address matching the HTTP request. Enum options - IS_IN, IS_NOT_IN.
prefixes (optional)
array[IpAddrPrefix] IP address prefix(es).
ranges (optional)
array[IpAddrRange] IP address range(s).

IpAddrPrefix Up

ip_addr
IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object
mask
Integer Number of mask. format: int32

IpAddrRange Up

begin
IpAddr Starting IP address of the range.
end
IpAddr Ending IP address of the range.

KeyValue Up

key
String Key.
value (optional)
String Value.

LocationHdrMatch Up

match_case (optional)
String Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE.
match_criteria
String Criterion to use for matching location header value in the HTTP response. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL.
value (optional)
array[String] String value(s) in the location header.

MatchTarget Up

client_ip (optional)
IpAddrMatch Configure client ip addresses.
cookie (optional)
CookieMatch Configure HTTP cookie(s).
hdrs (optional)
array[HdrMatch] Configure HTTP header(s).
host_hdr (optional)
HostHdrMatch Configure the host header.
ip_reputation_type (optional)
IPReputationTypeMatch Configure IP reputation. Field introduced in 20.1.3.
method (optional)
MethodMatch Configure HTTP methods.
path (optional)
PathMatch Configure request paths.
protocol (optional)
ProtocolMatch Configure the type of HTTP protocol.
query (optional)
QueryMatch Configure request query.
version (optional)
HTTPVersionMatch Configure versions of the HTTP protocol.
vs_port (optional)
PortMatch Configure virtual service ports.

MethodMatch Up

match_criteria
String Criterion to use for HTTP method matching the method in the HTTP request. Enum options - IS_IN, IS_NOT_IN.
methods (optional)
array[String] Configure HTTP method(s). Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Minimum of 1 items required. Maximum of 16 items allowed. Allowed in Basic(Allowed values- HTTP_METHOD_GET,HTTP_METHOD_PUT,HTTP_METHOD_POST,HTTP_METHOD_HEAD,HTTP_METHOD_OPTIONS) edition, Essentials(Allowed values- HTTP_METHOD_GET,HTTP_METHOD_PUT,HTTP_METHOD_POST,HTTP_METHOD_HEAD,HTTP_METHOD_OPTIONS) edition, Enterprise edition.

PathMatch Up

match_case (optional)
String Case sensitivity to use for the matching. Enum options - SENSITIVE, INSENSITIVE.
match_criteria
String Criterion to use for matching the path in the HTTP request URI. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH. Allowed in Basic(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Essentials(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL) edition, Enterprise edition.
match_str (optional)
array[String] String values.
string_group_refs (optional)
array[String] UUID of the string group(s). It is a reference to an object of type StringGroup.

PoolServer Up

hostname (optional)
String DNS resolvable name of the server. May be used in place of the IP address.
ip
IpAddr IP address of the server in the poool.
port (optional)
Integer Port of the pool server listening for HTTP/HTTPS. Default value is the default port in the pool. Allowed values are 1-65535. format: int32

PortMatch Up

match_criteria
String Criterion to use for port matching the HTTP request. Enum options - IS_IN, IS_NOT_IN.
ports (optional)
array[Integer] Listening TCP port(s). Allowed values are 1-65535. Minimum of 1 items required.

ProtocolMatch Up

match_criteria
String Criterion to use for protocol matching the HTTP request. Enum options - IS_IN, IS_NOT_IN.
protocols
String HTTP or HTTPS protocol. Enum options - HTTP, HTTPS.

QueryMatch Up

match_case (optional)
String Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE.
match_criteria
String Criterion to use for matching the query in HTTP request URI. Enum options - QUERY_MATCH_CONTAINS.
match_str (optional)
array[String] String value(s).
string_group_refs (optional)
array[String] UUID of the string group(s). It is a reference to an object of type StringGroup.

RateLimiter Up

burst_sz (optional)
Integer Maximum number of connections, requests or packets to be let through instantaneously. If this is less than count, it will have no effect. Allowed values are 0-1000000000. Field introduced in 18.2.9. format: int32
count
Integer Maximum number of connections, requests or packets permitted each period. Allowed values are 1-1000000000. Field introduced in 18.2.9. format: int32
name (optional)
String Identifier for Rate Limit. Constructed according to context. Field introduced in 18.2.9.
period
Integer Time value in seconds to enforce rate count. Allowed values are 1-1000000000. Field introduced in 18.2.9. Unit is SEC. format: int32

RateLimiterAction Up

file (optional)
HTTPLocalFile File to be used for HTTP Local response rate limit action.
redirect (optional)
HTTPRedirectAction Parameters for HTTP Redirect rate limit action.
status_code (optional)
String HTTP status code for Local Response rate limit action. Enum options - HTTP_LOCAL_RESPONSE_STATUS_CODE_200, HTTP_LOCAL_RESPONSE_STATUS_CODE_204, HTTP_LOCAL_RESPONSE_STATUS_CODE_403, HTTP_LOCAL_RESPONSE_STATUS_CODE_404, HTTP_LOCAL_RESPONSE_STATUS_CODE_429, HTTP_LOCAL_RESPONSE_STATUS_CODE_501.
type (optional)
String Type of action to be enforced upon hitting the rate limit. Enum options - RL_ACTION_NONE, RL_ACTION_DROP_CONN, RL_ACTION_RESET_CONN, RL_ACTION_CLOSE_CONN, RL_ACTION_LOCAL_RSP, RL_ACTION_REDIRECT.

RateProfile Up

action
RateLimiterAction Action to perform upon rate limiting.
burst_sz (optional)
Integer Maximum number of connections or requests or packets to be let through instantaneously. Allowed values are 10-2500. Special values are 0- 'automatic'. Field deprecated in 18.2.9. format: int32
count (optional)
Integer Maximum number of connections or requests or packets. Allowed values are 1-1000000000. Special values are 0- 'unlimited'. Field deprecated in 18.2.9. format: int32
explicit_tracking (optional)
Boolean Explicitly tracks an attacker across rate periods.
fine_grain (optional)
Boolean Enable fine granularity.
http_cookie (optional)
String HTTP cookie name. Field introduced in 17.1.1.
http_header (optional)
String HTTP header name. Field introduced in 17.1.1.
period (optional)
Integer Time value in seconds to enforce rate count. Allowed values are 1-300. Field deprecated in 18.2.9. Unit is SEC. format: int32
rate_limiter (optional)
RateLimiter The rate limiter configuration for this rate profile. Field introduced in 18.2.9.

ResponseMatchTarget Up

client_ip (optional)
IpAddrMatch Configure client ip addresses.
cookie (optional)
CookieMatch Configure HTTP cookie(s).
hdrs (optional)
array[HdrMatch] Configure HTTP headers.
host_hdr (optional)
HostHdrMatch Configure the host header.
loc_hdr (optional)
LocationHdrMatch Configure the location header.
method (optional)
MethodMatch Configure HTTP methods.
path (optional)
PathMatch Configure request paths.
protocol (optional)
ProtocolMatch Configure the type of HTTP protocol.
query (optional)
QueryMatch Configure request query.
rsp_hdrs (optional)
array[HdrMatch] Configure the HTTP headers in response.
status (optional)
HTTPStatusMatch Configure the HTTP status code(s).
version (optional)
HTTPVersionMatch Configure versions of the HTTP protocol.
vs_port (optional)
PortMatch Configure virtual service ports.

RoleFilterMatchLabel Up

key
String Key for filter match. Field introduced in 20.1.3.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3.

URIParam Up

tokens (optional)
array[URIParamToken] Token config either for the URI components or a constant string. Minimum of 1 items required.
type
String URI param type. Enum options - URI_PARAM_TYPE_TOKENIZED.

URIParamQuery Up

add_string (optional)
String Concatenate a string to the query of the incoming request URI and then use it in the request URI going to the backend server.
keep_query (optional)
Boolean Use or drop the query of the incoming request URI in the request URI to the backend server.

URIParamToken Up

end_index (optional)
Integer Index of the ending token in the incoming URI. Allowed values are 0-65534. Special values are 65535 - 'end of string'. format: int32
start_index (optional)
Integer Index of the starting token in the incoming URI. format: int32
str_value (optional)
String Constant string to use as a token.
type
String Token type for constructing the URI. Enum options - URI_TOKEN_TYPE_HOST, URI_TOKEN_TYPE_PATH, URI_TOKEN_TYPE_STRING, URI_TOKEN_TYPE_STRING_GROUP, URI_TOKEN_TYPE_REGEX.