Avi HTTPPolicySet Object API

CLI ``` - configure httppolicyset - show httppolicyset ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 21.1.6
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" : "",
          "source_ip" : "",
          "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",
            "file_length" : 123
          },
          "status_code" : "aeiou",
          "action" : "aeiou",
          "pool_group_ref" : "aeiou"
        },
        "log" : true,
        "enable" : true,
        "match" : {
          "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" : [ "" ]
          },
          "hdrs" : [ {
            "match_criteria" : "aeiou",
            "hdr" : "aeiou",
            "value" : [ "aeiou" ],
            "match_case" : "aeiou"
          } ],
          "version" : {
            "match_criteria" : "aeiou",
            "versions" : [ "aeiou" ]
          },
          "source_ip" : "",
          "path" : {
            "match_criteria" : "aeiou",
            "string_group_refs" : [ "aeiou" ],
            "match_str" : [ "aeiou" ],
            "match_case" : "aeiou"
          },
          "geo_matches" : [ {
            "match_operation" : "aeiou",
            "values" : [ "aeiou" ],
            "attribute" : "aeiou"
          } ],
          "protocol" : {
            "match_criteria" : "aeiou",
            "protocols" : "aeiou"
          },
          "client_ip" : {
            "group_refs" : [ "aeiou" ],
            "match_criteria" : "aeiou",
            "prefixes" : [ {
              "ip_addr" : "",
              "mask" : 123
            } ],
            "ranges" : [ {
              "end" : "",
              "begin" : ""
            } ],
            "addrs" : [ {
              "addr" : "aeiou",
              "type" : "aeiou"
            } ]
          },
          "bot_detection_result" : {
            "classifications" : [ {
              "user_defined_type" : "aeiou",
              "type" : "aeiou"
            } ],
            "match_operation" : "aeiou"
          }
        },
        "name" : "aeiou",
        "redirect_action" : {
          "keep_query" : true,
          "path" : "",
          "protocol" : "aeiou",
          "status_code" : "aeiou",
          "add_string" : "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"
          }
        }
      } ]
    },
    "geo_db_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "configpb_attributes" : {
      "version" : 123
    },
    "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" : "",
        "source_ip" : "",
        "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",
          "file_length" : 123
        },
        "status_code" : "aeiou",
        "action" : "aeiou",
        "pool_group_ref" : "aeiou"
      },
      "log" : true,
      "enable" : true,
      "match" : {
        "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" : [ "" ]
        },
        "hdrs" : [ {
          "match_criteria" : "aeiou",
          "hdr" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        } ],
        "version" : {
          "match_criteria" : "aeiou",
          "versions" : [ "aeiou" ]
        },
        "source_ip" : "",
        "path" : {
          "match_criteria" : "aeiou",
          "string_group_refs" : [ "aeiou" ],
          "match_str" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "geo_matches" : [ {
          "match_operation" : "aeiou",
          "values" : [ "aeiou" ],
          "attribute" : "aeiou"
        } ],
        "protocol" : {
          "match_criteria" : "aeiou",
          "protocols" : "aeiou"
        },
        "client_ip" : {
          "group_refs" : [ "aeiou" ],
          "match_criteria" : "aeiou",
          "prefixes" : [ {
            "ip_addr" : "",
            "mask" : 123
          } ],
          "ranges" : [ {
            "end" : "",
            "begin" : ""
          } ],
          "addrs" : [ {
            "addr" : "aeiou",
            "type" : "aeiou"
          } ]
        },
        "bot_detection_result" : {
          "classifications" : [ {
            "user_defined_type" : "aeiou",
            "type" : "aeiou"
          } ],
          "match_operation" : "aeiou"
        }
      },
      "name" : "aeiou",
      "redirect_action" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "status_code" : "aeiou",
        "add_string" : "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"
        }
      }
    } ]
  },
  "geo_db_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "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" : "",
        "source_ip" : "",
        "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",
          "file_length" : 123
        },
        "status_code" : "aeiou",
        "action" : "aeiou",
        "pool_group_ref" : "aeiou"
      },
      "log" : true,
      "enable" : true,
      "match" : {
        "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" : [ "" ]
        },
        "hdrs" : [ {
          "match_criteria" : "aeiou",
          "hdr" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        } ],
        "version" : {
          "match_criteria" : "aeiou",
          "versions" : [ "aeiou" ]
        },
        "source_ip" : "",
        "path" : {
          "match_criteria" : "aeiou",
          "string_group_refs" : [ "aeiou" ],
          "match_str" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "geo_matches" : [ {
          "match_operation" : "aeiou",
          "values" : [ "aeiou" ],
          "attribute" : "aeiou"
        } ],
        "protocol" : {
          "match_criteria" : "aeiou",
          "protocols" : "aeiou"
        },
        "client_ip" : {
          "group_refs" : [ "aeiou" ],
          "match_criteria" : "aeiou",
          "prefixes" : [ {
            "ip_addr" : "",
            "mask" : 123
          } ],
          "ranges" : [ {
            "end" : "",
            "begin" : ""
          } ],
          "addrs" : [ {
            "addr" : "aeiou",
            "type" : "aeiou"
          } ]
        },
        "bot_detection_result" : {
          "classifications" : [ {
            "user_defined_type" : "aeiou",
            "type" : "aeiou"
          } ],
          "match_operation" : "aeiou"
        }
      },
      "name" : "aeiou",
      "redirect_action" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "status_code" : "aeiou",
        "add_string" : "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"
        }
      }
    } ]
  },
  "geo_db_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "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" : "",
        "source_ip" : "",
        "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",
          "file_length" : 123
        },
        "status_code" : "aeiou",
        "action" : "aeiou",
        "pool_group_ref" : "aeiou"
      },
      "log" : true,
      "enable" : true,
      "match" : {
        "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" : [ "" ]
        },
        "hdrs" : [ {
          "match_criteria" : "aeiou",
          "hdr" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        } ],
        "version" : {
          "match_criteria" : "aeiou",
          "versions" : [ "aeiou" ]
        },
        "source_ip" : "",
        "path" : {
          "match_criteria" : "aeiou",
          "string_group_refs" : [ "aeiou" ],
          "match_str" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "geo_matches" : [ {
          "match_operation" : "aeiou",
          "values" : [ "aeiou" ],
          "attribute" : "aeiou"
        } ],
        "protocol" : {
          "match_criteria" : "aeiou",
          "protocols" : "aeiou"
        },
        "client_ip" : {
          "group_refs" : [ "aeiou" ],
          "match_criteria" : "aeiou",
          "prefixes" : [ {
            "ip_addr" : "",
            "mask" : 123
          } ],
          "ranges" : [ {
            "end" : "",
            "begin" : ""
          } ],
          "addrs" : [ {
            "addr" : "aeiou",
            "type" : "aeiou"
          } ]
        },
        "bot_detection_result" : {
          "classifications" : [ {
            "user_defined_type" : "aeiou",
            "type" : "aeiou"
          } ],
          "match_operation" : "aeiou"
        }
      },
      "name" : "aeiou",
      "redirect_action" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "status_code" : "aeiou",
        "add_string" : "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"
        }
      }
    } ]
  },
  "geo_db_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "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" : "",
        "source_ip" : "",
        "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",
          "file_length" : 123
        },
        "status_code" : "aeiou",
        "action" : "aeiou",
        "pool_group_ref" : "aeiou"
      },
      "log" : true,
      "enable" : true,
      "match" : {
        "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" : [ "" ]
        },
        "hdrs" : [ {
          "match_criteria" : "aeiou",
          "hdr" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        } ],
        "version" : {
          "match_criteria" : "aeiou",
          "versions" : [ "aeiou" ]
        },
        "source_ip" : "",
        "path" : {
          "match_criteria" : "aeiou",
          "string_group_refs" : [ "aeiou" ],
          "match_str" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "geo_matches" : [ {
          "match_operation" : "aeiou",
          "values" : [ "aeiou" ],
          "attribute" : "aeiou"
        } ],
        "protocol" : {
          "match_criteria" : "aeiou",
          "protocols" : "aeiou"
        },
        "client_ip" : {
          "group_refs" : [ "aeiou" ],
          "match_criteria" : "aeiou",
          "prefixes" : [ {
            "ip_addr" : "",
            "mask" : 123
          } ],
          "ranges" : [ {
            "end" : "",
            "begin" : ""
          } ],
          "addrs" : [ {
            "addr" : "aeiou",
            "type" : "aeiou"
          } ]
        },
        "bot_detection_result" : {
          "classifications" : [ {
            "user_defined_type" : "aeiou",
            "type" : "aeiou"
          } ],
          "match_operation" : "aeiou"
        }
      },
      "name" : "aeiou",
      "redirect_action" : {
        "keep_query" : true,
        "path" : "",
        "protocol" : "aeiou",
        "status_code" : "aeiou",
        "add_string" : "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"
        }
      }
    } ]
  },
  "geo_db_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "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. BotClassification
  2. BotDetectionMatch
  3. ConfigPbAttributes
  4. CookieMatch
  5. GeoMatch
  6. HTTPCookieData
  7. HTTPHdrAction
  8. HTTPHdrData
  9. HTTPHdrValue
  10. HTTPLocalFile
  11. HTTPPolicySet
  12. HTTPPolicySetApiResponse
  13. HTTPRedirectAction
  14. HTTPRequestPolicy
  15. HTTPRequestRule
  16. HTTPResponsePolicy
  17. HTTPResponseRule
  18. HTTPRewriteLocHdrAction
  19. HTTPRewriteURLAction
  20. HTTPSecurityAction
  21. HTTPSecurityActionRateProfile
  22. HTTPSecurityPolicy
  23. HTTPSecurityRule
  24. HTTPStatusMatch
  25. HTTPStatusRange
  26. HTTPSwitchingAction
  27. HTTPVersionMatch
  28. HdrMatch
  29. HostHdrMatch
  30. IPReputationTypeMatch
  31. IpAddr
  32. IpAddrMatch
  33. IpAddrPrefix
  34. IpAddrRange
  35. KeyValue
  36. LocationHdrMatch
  37. MatchTarget
  38. MethodMatch
  39. PathMatch
  40. PoolServer
  41. PortMatch
  42. ProtocolMatch
  43. QueryMatch
  44. RateLimiter
  45. RateLimiterAction
  46. RateProfile
  47. ResponseMatchTarget
  48. RoleFilterMatchLabel
  49. URIParam
  50. URIParamQuery
  51. URIParamToken

BotClassification Up

type
String One of the system-defined Bot classification types. Enum options - HUMAN, GOOD_BOT, BAD_BOT, DANGEROUS_BOT, USER_DEFINED_BOT, UNKNOWN_CLIENT. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
user_defined_type (optional)
String If 'type' has BotClassificationTypes value 'USER_DEFINED', this is the user-defined value. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

BotDetectionMatch Up

classifications (optional)
array[BotClassification] Bot classification types. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
match_operation
String Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ConfigPbAttributes Up

version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32

CookieMatch Up

match_case (optional)
String Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String Name of the cookie. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String String value in the cookie. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

GeoMatch Up

attribute
String The Geo data type to match on. Enum options - ATTRIBUTE_IP_PREFIX, ATTRIBUTE_COUNTRY_CODE, ATTRIBUTE_COUNTRY_NAME, ATTRIBUTE_CONTINENT_CODE, ATTRIBUTE_CONTINENT_NAME, ATTRIBUTE_REGION_NAME, ATTRIBUTE_CITY_NAME, ATTRIBUTE_ISP_NAME, ATTRIBUTE_ORGANIZATION_NAME, ATTRIBUTE_AS_NUMBER, ATTRIBUTE_AS_NAME, ATTRIBUTE_LONGITUDE, ATTRIBUTE_LATITUDE, ATTRIBUTE_CUSTOM_1, ATTRIBUTE_CUSTOM_2, ATTRIBUTE_CUSTOM_3, ATTRIBUTE_CUSTOM_4, ATTRIBUTE_CUSTOM_5, ATTRIBUTE_CUSTOM_6, ATTRIBUTE_CUSTOM_7, ATTRIBUTE_CUSTOM_8, ATTRIBUTE_CUSTOM_9, ATTRIBUTE_USER_DEFINED_MAPPING. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
match_operation
String Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
values
array[String] The values to match. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

HTTPCookieData Up

name (optional)
String Cookie name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String Cookie value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

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 Enterprise edition with any value, Essentials edition(Allowed values- HTTP_REMOVE_HDR,HTTP_REPLACE_HDR), Basic edition(Allowed values- HTTP_REMOVE_HDR,HTTP_REPLACE_HDR), Enterprise with Cloud Services edition.
cookie (optional)
HTTPCookieData Cookie information. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hdr (optional)
HTTPHdrData HTTP header information. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTPHdrData Up

name (optional)
String HTTP header name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
HTTPHdrValue HTTP header value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTPHdrValue Up

val (optional)
String HTTP header value or variable representing an HTTP header. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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, HTTP_POLICY_VAR_SSL_CLIENT_ESCAPED, HTTP_POLICY_VAR_SOURCE_IP. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTPLocalFile Up

content_type
String Mime-type of the content in the file. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
file_content
String File content to used in the local HTTP response body. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
file_length (optional)
Integer File content length. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32

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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
created_by (optional)
String Creator name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
description (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
geo_db_ref (optional)
String 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.
http_request_policy (optional)
HTTPRequestPolicy HTTP request policy for the virtual service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
http_response_policy (optional)
HTTPResponsePolicy HTTP response policy for the virtual service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
http_security_policy (optional)
HTTPSecurityPolicy HTTP security policy for the virtual service. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
is_internal_policy (optional)
Boolean Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
markers (optional)
array[RoleFilterMatchLabel] 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.
name
String Name of the HTTP Policy Set. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
String url
uuid (optional)
String UUID of the HTTP Policy Set. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTPPolicySetApiResponse Up

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

HTTPRedirectAction Up

add_string (optional)
String Add a query string to the redirect URI. If keep_query is set, concatenates the add_string to the query of the incoming request. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
host (optional)
URIParam Host config. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
keep_query (optional)
Boolean Keep or drop the query of the incoming request URI in the redirected URI. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
path (optional)
URIParam Path config. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
port (optional)
Integer Port to which redirect the request. Allowed values are 1-65535. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
protocol
String Protocol type. Enum options - HTTP, HTTPS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTPRequestPolicy Up

rules (optional)
array[HTTPRequestRule] Add rules to the HTTP request policy. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTPRequestRule Up

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

HTTPResponsePolicy Up

rules (optional)
array[HTTPResponseRule] Add rules to the HTTP response policy. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTPResponseRule Up

all_headers (optional)
Boolean Log all HTTP headers upon rule match. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
enable
Boolean Enable or disable the rule. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hdr_action (optional)
array[HTTPHdrAction] HTTP header rewrite action. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
index
Integer Index of the rule. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
loc_hdr_action (optional)
HTTPRewriteLocHdrAction Location header rewrite action. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
log (optional)
Boolean Log HTTP request upon rule match. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
match (optional)
ResponseMatchTarget Add match criteria to the rule. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String Name of the rule. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTPRewriteLocHdrAction Up

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

HTTPRewriteURLAction Up

host_hdr (optional)
URIParam Host config. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
path (optional)
URIParam Path config. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
query (optional)
URIParamQuery Query config. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

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 Enterprise edition with any value, Essentials edition(Allowed values- HTTP_SECURITY_ACTION_CLOSE_CONN,HTTP_SECURITY_ACTION_SEND_RESPONSE,HTTP_SECURITY_ACTION_REDIRECT_TO_HTTPS), Basic edition(Allowed values- HTTP_SECURITY_ACTION_CLOSE_CONN,HTTP_SECURITY_ACTION_SEND_RESPONSE,HTTP_SECURITY_ACTION_REDIRECT_TO_HTTPS), Enterprise with Cloud Services edition.
file (optional)
HTTPLocalFile File to be used for generating HTTP local response. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
https_port (optional)
Integer Secure SSL/TLS port to redirect the HTTP request to. Allowed values are 1-65535. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
rate_limit (optional)
RateProfile Rate Limit profile to be used to rate-limit the flow. (deprecated). Field deprecated in 18.2.9. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
rate_profile (optional)
HTTPSecurityActionRateProfile Rate limiting configuration for this action. Field introduced in 18.2.9. Allowed in Enterprise edition with any value, Enterprise with Cloud Services 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTPSecurityActionRateProfile Up

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

HTTPSecurityPolicy Up

rules (optional)
array[HTTPSecurityRule] Add rules to the HTTP security policy. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTPSecurityRule Up

action (optional)
HTTPSecurityAction Action to be performed upon successful matching. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
enable
Boolean Enable or disable the rule. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
index
Integer Index of the rule. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
log (optional)
Boolean Log HTTP request upon rule match. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
match (optional)
MatchTarget Add match criteria to the rule. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String Name of the rule. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTPStatusMatch Up

match_criteria
String Criterion to use for matching the HTTP response status code(s). Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ranges (optional)
array[HTTPStatusRange] HTTP response status code range(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
status_codes (optional)
array[Integer] HTTP response status code(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HTTPStatusRange Up

begin
Integer Starting HTTP response status code. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
end
Integer Ending HTTP response status code. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. 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 Enterprise edition with any value, Essentials edition(Allowed values- HTTP_SWITCHING_SELECT_POOL,HTTP_SWITCHING_SELECT_LOCAL), Basic, Enterprise with Cloud Services edition.
file (optional)
HTTPLocalFile File from which to serve local response to the request. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_group_ref (optional)
String UUID of the pool group to serve the request. It is a reference to an object of type PoolGroup. Allowed in Enterprise edition with any value, Basic, Enterprise with Cloud Services edition.
pool_ref (optional)
String UUID of the pool of servers to serve the request. It is a reference to an object of type Pool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
server (optional)
PoolServer Specific pool server to select. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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 Enterprise edition with any value, Essentials edition(Allowed values- ONE_ZERO,ONE_ONE), Basic edition(Allowed values- ONE_ZERO,ONE_ONE), Enterprise with Cloud Services edition.

HdrMatch Up

hdr
String Name of the HTTP header whose value is to be matched. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
match_case (optional)
String Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
array[String] String values to match in the HTTP header. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

HostHdrMatch Up

match_case (optional)
String Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
array[String] String value(s) in the host header. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IPReputationTypeMatch Up

match_operation
String Match criteria. Enum options - IS_IN, IS_NOT_IN. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IpAddr Up

addr
String IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IpAddrMatch Up

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

IpAddrPrefix Up

ip_addr
IpAddr Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
mask
Integer Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

IpAddrRange Up

begin
IpAddr Starting IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
end
IpAddr Ending IP address of the range. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

KeyValue Up

key
String Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String Value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

LocationHdrMatch Up

match_case (optional)
String Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
array[String] String value(s) in the location header. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

MatchTarget Up

bot_detection_result (optional)
BotDetectionMatch Configure the bot classification result. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
client_ip (optional)
IpAddrMatch Configure client ip addresses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cookie (optional)
CookieMatch Configure HTTP cookie(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
geo_matches (optional)
array[GeoMatch] Configure the geo information. Field introduced in 21.1.1. Maximum of 1 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
hdrs (optional)
array[HdrMatch] Configure HTTP header(s). All configured headers must match. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
host_hdr (optional)
HostHdrMatch Configure the host header. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_reputation_type (optional)
IPReputationTypeMatch Configure IP reputation. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
method (optional)
MethodMatch Configure HTTP methods. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
path (optional)
PathMatch Configure request paths. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
protocol (optional)
ProtocolMatch Configure the type of HTTP protocol. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
query (optional)
QueryMatch Configure request query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
source_ip (optional)
IpAddrMatch Configure source ip addresses. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
version (optional)
HTTPVersionMatch Configure versions of the HTTP protocol. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vs_port (optional)
PortMatch Configure virtual service ports. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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 Enterprise edition with any value, Essentials edition(Allowed values- HTTP_METHOD_GET,HTTP_METHOD_PUT,HTTP_METHOD_POST,HTTP_METHOD_HEAD,HTTP_METHOD_OPTIONS), Basic edition(Allowed values- HTTP_METHOD_GET,HTTP_METHOD_PUT,HTTP_METHOD_POST,HTTP_METHOD_HEAD,HTTP_METHOD_OPTIONS), Enterprise with Cloud Services edition.

PathMatch Up

match_case (optional)
String Case sensitivity to use for the matching. Enum options - SENSITIVE, INSENSITIVE. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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 Enterprise edition with any value, Essentials edition(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL), Basic edition(Allowed values- BEGINS_WITH,DOES_NOT_BEGIN_WITH,CONTAINS,DOES_NOT_CONTAIN,ENDS_WITH,DOES_NOT_END_WITH,EQUALS,DOES_NOT_EQUAL), Enterprise with Cloud Services edition.
match_str (optional)
array[String] String values. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
string_group_refs (optional)
array[String] UUID of the string group(s). It is a reference to an object of type StringGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

PoolServer Up

hostname (optional)
String DNS resolvable name of the server. May be used in place of the IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip
IpAddr IP address of the server in the poool. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

PortMatch Up

match_criteria
String Criterion to use for port matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ports (optional)
array[Integer] Listening TCP port(s). Allowed values are 1-65535. Minimum of 1 items required. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ProtocolMatch Up

match_criteria
String Criterion to use for protocol matching the HTTP request. Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
protocols
String HTTP or HTTPS protocol. Enum options - HTTP, HTTPS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

QueryMatch Up

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

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. Allowed in Enterprise edition with any value, Basic edition(Allowed values- 0), Essentials, Enterprise with Cloud Services edition. 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
name (optional)
String Identifier for Rate Limit. Constructed according to context. Field introduced in 18.2.9. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
period
Integer Time value in seconds to enforce rate count. Allowed values are 1-1000000000. Field introduced in 18.2.9. Unit is SEC. Allowed in Enterprise edition with any value, Basic edition(Allowed values- 1), Essentials, Enterprise with Cloud Services edition. format: int32

RateLimiterAction Up

file (optional)
HTTPLocalFile File to be used for HTTP Local response rate limit action. Allowed in Enterprise edition with any value, Essentials, Enterprise with Cloud Services edition.
redirect (optional)
HTTPRedirectAction Parameters for HTTP Redirect rate limit action. Allowed in Enterprise edition with any value, Essentials, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Basic edition(Allowed values- HTTP_LOCAL_RESPONSE_STATUS_CODE_429), Essentials, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Basic edition(Allowed values- RL_ACTION_NONE,RL_ACTION_DROP_CONN), Essentials, Enterprise with Cloud Services edition.

RateProfile Up

action
RateLimiterAction Action to perform upon rate limiting. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. 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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
explicit_tracking (optional)
Boolean Explicitly tracks an attacker across rate periods. Allowed in Enterprise edition with any value, Basic edition(Allowed values- false), Essentials, Enterprise with Cloud Services edition.
fine_grain (optional)
Boolean Enable fine granularity. Allowed in Enterprise edition with any value, Basic edition(Allowed values- false), Essentials, Enterprise with Cloud Services edition.
http_cookie (optional)
String HTTP cookie name. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Enterprise with Cloud Services edition.
http_header (optional)
String HTTP header name. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
rate_limiter (optional)
RateLimiter The rate limiter configuration for this rate profile. Field introduced in 18.2.9. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ResponseMatchTarget Up

client_ip (optional)
IpAddrMatch Configure client ip addresses. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cookie (optional)
CookieMatch Configure HTTP cookie(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
hdrs (optional)
array[HdrMatch] Configure HTTP headers. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
host_hdr (optional)
HostHdrMatch Configure the host header. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
loc_hdr (optional)
LocationHdrMatch Configure the location header. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
method (optional)
MethodMatch Configure HTTP methods. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
path (optional)
PathMatch Configure request paths. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
protocol (optional)
ProtocolMatch Configure the type of HTTP protocol. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
query (optional)
QueryMatch Configure request query. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
rsp_hdrs (optional)
array[HdrMatch] Configure the HTTP headers in response. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
source_ip (optional)
IpAddrMatch Configure source ip addresses. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
status (optional)
HTTPStatusMatch Configure the HTTP status code(s). Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
version (optional)
HTTPVersionMatch Configure versions of the HTTP protocol. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vs_port (optional)
PortMatch Configure virtual service ports. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

RoleFilterMatchLabel Up

key
String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

URIParam Up

tokens (optional)
array[URIParamToken] Token config either for the URI components or a constant string. Minimum of 1 items required. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String URI param type. Enum options - URI_PARAM_TYPE_TOKENIZED. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
keep_query (optional)
Boolean Use or drop the query of the incoming request URI in the request URI to the backend server. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
start_index (optional)
Integer Index of the starting token in the incoming URI. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
str_value (optional)
String Constant string to use as a token. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.