openapi: 3.2.0 info: title: HAProxy Data Plane HTTP Request Rule API description: 'API for editing and managing haproxy instances. Provides process information, configuration management, haproxy stats and logs.' version: '3.4' contact: name: HAProxy Support url: https://my.haproxy.com/portal/cust/login email: support@haproxy.com servers: - url: /v3 security: - basic_auth: [] tags: - name: HTTPRequestRule paths: /services/haproxy/configuration/backends/{parent_name}/http_request_rules: get: description: Returns all HTTP Request Rules that are configured in specified parent. operationId: getAllHTTPRequestRuleBackend parameters: - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' responses: '200': description: Successful operation headers: Configuration-Version: description: Configuration file version schema: type: string content: application/json: schema: $ref: '#/components/schemas/http_request_rules' default: $ref: '#/components/responses/DefaultError' summary: Return an array of all HTTP Request Rules tags: - HTTPRequestRule put: description: Replaces a whole list of HTTP Request Rules with the list given in parameter operationId: replaceAllHTTPRequestRuleBackend parameters: - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' - $ref: '#/components/parameters/version' - $ref: '#/components/parameters/force_reload' responses: '200': description: All HTTP Request Rule lines replaced content: application/json: schema: $ref: '#/components/schemas/http_request_rules' '202': description: Configuration change accepted and reload requested headers: Reload-ID: description: ID of the requested reload schema: type: string content: application/json: schema: $ref: '#/components/schemas/http_request_rules' '400': $ref: '#/components/responses/BadRequest' default: $ref: '#/components/responses/DefaultError' summary: Replace an HTTP Request Rule list tags: - HTTPRequestRule requestBody: content: application/json: schema: $ref: '#/components/schemas/http_request_rules' required: true /services/haproxy/configuration/frontends/{parent_name}/http_request_rules: get: description: Returns all HTTP Request Rules that are configured in specified parent. operationId: getAllHTTPRequestRuleFrontend parameters: - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' responses: '200': description: Successful operation headers: Configuration-Version: description: Configuration file version schema: type: string content: application/json: schema: $ref: '#/components/schemas/http_request_rules' default: $ref: '#/components/responses/DefaultError' summary: Return an array of all HTTP Request Rules tags: - HTTPRequestRule put: description: Replaces a whole list of HTTP Request Rules with the list given in parameter operationId: replaceAllHTTPRequestRuleFrontend parameters: - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' - $ref: '#/components/parameters/version' - $ref: '#/components/parameters/force_reload' responses: '200': description: All HTTP Request Rule lines replaced content: application/json: schema: $ref: '#/components/schemas/http_request_rules' '202': description: Configuration change accepted and reload requested headers: Reload-ID: description: ID of the requested reload schema: type: string content: application/json: schema: $ref: '#/components/schemas/http_request_rules' '400': $ref: '#/components/responses/BadRequest' default: $ref: '#/components/responses/DefaultError' summary: Replace an HTTP Request Rule list tags: - HTTPRequestRule requestBody: content: application/json: schema: $ref: '#/components/schemas/http_request_rules' required: true /services/haproxy/configuration/defaults/{parent_name}/http_request_rules: get: description: Returns all HTTP Request Rules that are configured in specified parent. operationId: getAllHTTPRequestRuleDefaults parameters: - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' responses: '200': description: Successful operation headers: Configuration-Version: description: Configuration file version schema: type: string content: application/json: schema: $ref: '#/components/schemas/http_request_rules' default: $ref: '#/components/responses/DefaultError' summary: Return an array of all HTTP Request Rules tags: - HTTPRequestRule put: description: Replaces a whole list of HTTP Request Rules with the list given in parameter operationId: replaceAllHTTPRequestRuleDefaults parameters: - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' - $ref: '#/components/parameters/version' - $ref: '#/components/parameters/force_reload' responses: '200': description: All HTTP Request Rule lines replaced content: application/json: schema: $ref: '#/components/schemas/http_request_rules' '202': description: Configuration change accepted and reload requested headers: Reload-ID: description: ID of the requested reload schema: type: string content: application/json: schema: $ref: '#/components/schemas/http_request_rules' '400': $ref: '#/components/responses/BadRequest' default: $ref: '#/components/responses/DefaultError' summary: Replace an HTTP Request Rule list tags: - HTTPRequestRule requestBody: content: application/json: schema: $ref: '#/components/schemas/http_request_rules' required: true /services/haproxy/configuration/backends/{parent_name}/http_request_rules/{index}: delete: description: Deletes a HTTP Request Rule configuration by it's index from the specified parent. operationId: deleteHTTPRequestRuleBackend parameters: - description: HTTP Request Rule Index in: path name: index required: true schema: type: integer - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' - $ref: '#/components/parameters/version' - $ref: '#/components/parameters/force_reload' responses: '202': description: Configuration change accepted and reload requested headers: Reload-ID: description: ID of the requested reload schema: type: string '204': description: HTTP Request Rule deleted '404': $ref: '#/components/responses/NotFound' default: $ref: '#/components/responses/DefaultError' summary: Delete a HTTP Request Rule tags: - HTTPRequestRule get: description: Returns one HTTP Request Rule configuration by it's index in the specified parent. operationId: getHTTPRequestRuleBackend parameters: - description: HTTP Request Rule Index in: path name: index required: true schema: type: integer - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' responses: '200': description: Successful operation headers: Configuration-Version: description: Configuration file version schema: type: string content: application/json: schema: $ref: '#/components/schemas/http_request_rule' '404': $ref: '#/components/responses/NotFound' default: $ref: '#/components/responses/DefaultError' summary: Return one HTTP Request Rule tags: - HTTPRequestRule post: description: Adds a new HTTP Request Rule of the specified type in the specified parent. operationId: createHTTPRequestRuleBackend parameters: - description: HTTP Request Rule Index in: path name: index required: true schema: type: integer - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' - $ref: '#/components/parameters/version' - $ref: '#/components/parameters/force_reload' responses: '201': description: HTTP Request Rule created content: application/json: schema: $ref: '#/components/schemas/http_request_rule' '202': description: Configuration change accepted and reload requested headers: Reload-ID: description: ID of the requested reload schema: type: string content: application/json: schema: $ref: '#/components/schemas/http_request_rule' '400': $ref: '#/components/responses/BadRequest' '409': $ref: '#/components/responses/AlreadyExists' default: $ref: '#/components/responses/DefaultError' summary: Add a new HTTP Request Rule tags: - HTTPRequestRule requestBody: content: application/json: schema: $ref: '#/components/schemas/http_request_rule' required: true put: description: Replaces a HTTP Request Rule configuration by it's index in the specified parent. operationId: replaceHTTPRequestRuleBackend parameters: - description: HTTP Request Rule Index in: path name: index required: true schema: type: integer - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' - $ref: '#/components/parameters/version' - $ref: '#/components/parameters/force_reload' responses: '200': description: HTTP Request Rule replaced content: application/json: schema: $ref: '#/components/schemas/http_request_rule' '202': description: Configuration change accepted and reload requested headers: Reload-ID: description: ID of the requested reload schema: type: string content: application/json: schema: $ref: '#/components/schemas/http_request_rule' '400': $ref: '#/components/responses/BadRequest' '404': $ref: '#/components/responses/NotFound' default: $ref: '#/components/responses/DefaultError' summary: Replace a HTTP Request Rule tags: - HTTPRequestRule requestBody: content: application/json: schema: $ref: '#/components/schemas/http_request_rule' required: true /services/haproxy/configuration/frontends/{parent_name}/http_request_rules/{index}: delete: description: Deletes a HTTP Request Rule configuration by it's index from the specified parent. operationId: deleteHTTPRequestRuleFrontend parameters: - description: HTTP Request Rule Index in: path name: index required: true schema: type: integer - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' - $ref: '#/components/parameters/version' - $ref: '#/components/parameters/force_reload' responses: '202': description: Configuration change accepted and reload requested headers: Reload-ID: description: ID of the requested reload schema: type: string '204': description: HTTP Request Rule deleted '404': $ref: '#/components/responses/NotFound' default: $ref: '#/components/responses/DefaultError' summary: Delete a HTTP Request Rule tags: - HTTPRequestRule get: description: Returns one HTTP Request Rule configuration by it's index in the specified parent. operationId: getHTTPRequestRuleFrontend parameters: - description: HTTP Request Rule Index in: path name: index required: true schema: type: integer - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' responses: '200': description: Successful operation headers: Configuration-Version: description: Configuration file version schema: type: string content: application/json: schema: $ref: '#/components/schemas/http_request_rule' '404': $ref: '#/components/responses/NotFound' default: $ref: '#/components/responses/DefaultError' summary: Return one HTTP Request Rule tags: - HTTPRequestRule post: description: Adds a new HTTP Request Rule of the specified type in the specified parent. operationId: createHTTPRequestRuleFrontend parameters: - description: HTTP Request Rule Index in: path name: index required: true schema: type: integer - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' - $ref: '#/components/parameters/version' - $ref: '#/components/parameters/force_reload' responses: '201': description: HTTP Request Rule created content: application/json: schema: $ref: '#/components/schemas/http_request_rule' '202': description: Configuration change accepted and reload requested headers: Reload-ID: description: ID of the requested reload schema: type: string content: application/json: schema: $ref: '#/components/schemas/http_request_rule' '400': $ref: '#/components/responses/BadRequest' '409': $ref: '#/components/responses/AlreadyExists' default: $ref: '#/components/responses/DefaultError' summary: Add a new HTTP Request Rule tags: - HTTPRequestRule requestBody: content: application/json: schema: $ref: '#/components/schemas/http_request_rule' required: true put: description: Replaces a HTTP Request Rule configuration by it's index in the specified parent. operationId: replaceHTTPRequestRuleFrontend parameters: - description: HTTP Request Rule Index in: path name: index required: true schema: type: integer - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' - $ref: '#/components/parameters/version' - $ref: '#/components/parameters/force_reload' responses: '200': description: HTTP Request Rule replaced content: application/json: schema: $ref: '#/components/schemas/http_request_rule' '202': description: Configuration change accepted and reload requested headers: Reload-ID: description: ID of the requested reload schema: type: string content: application/json: schema: $ref: '#/components/schemas/http_request_rule' '400': $ref: '#/components/responses/BadRequest' '404': $ref: '#/components/responses/NotFound' default: $ref: '#/components/responses/DefaultError' summary: Replace a HTTP Request Rule tags: - HTTPRequestRule requestBody: content: application/json: schema: $ref: '#/components/schemas/http_request_rule' required: true /services/haproxy/configuration/defaults/{parent_name}/http_request_rules/{index}: delete: description: Deletes a HTTP Request Rule configuration by it's index from the specified parent. operationId: deleteHTTPRequestRuleDefaults parameters: - description: HTTP Request Rule Index in: path name: index required: true schema: type: integer - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' - $ref: '#/components/parameters/version' - $ref: '#/components/parameters/force_reload' responses: '202': description: Configuration change accepted and reload requested headers: Reload-ID: description: ID of the requested reload schema: type: string '204': description: HTTP Request Rule deleted '404': $ref: '#/components/responses/NotFound' default: $ref: '#/components/responses/DefaultError' summary: Delete a HTTP Request Rule tags: - HTTPRequestRule get: description: Returns one HTTP Request Rule configuration by it's index in the specified parent. operationId: getHTTPRequestRuleDefaults parameters: - description: HTTP Request Rule Index in: path name: index required: true schema: type: integer - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' responses: '200': description: Successful operation headers: Configuration-Version: description: Configuration file version schema: type: string content: application/json: schema: $ref: '#/components/schemas/http_request_rule' '404': $ref: '#/components/responses/NotFound' default: $ref: '#/components/responses/DefaultError' summary: Return one HTTP Request Rule tags: - HTTPRequestRule post: description: Adds a new HTTP Request Rule of the specified type in the specified parent. operationId: createHTTPRequestRuleDefaults parameters: - description: HTTP Request Rule Index in: path name: index required: true schema: type: integer - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' - $ref: '#/components/parameters/version' - $ref: '#/components/parameters/force_reload' responses: '201': description: HTTP Request Rule created content: application/json: schema: $ref: '#/components/schemas/http_request_rule' '202': description: Configuration change accepted and reload requested headers: Reload-ID: description: ID of the requested reload schema: type: string content: application/json: schema: $ref: '#/components/schemas/http_request_rule' '400': $ref: '#/components/responses/BadRequest' '409': $ref: '#/components/responses/AlreadyExists' default: $ref: '#/components/responses/DefaultError' summary: Add a new HTTP Request Rule tags: - HTTPRequestRule requestBody: content: application/json: schema: $ref: '#/components/schemas/http_request_rule' required: true put: description: Replaces a HTTP Request Rule configuration by it's index in the specified parent. operationId: replaceHTTPRequestRuleDefaults parameters: - description: HTTP Request Rule Index in: path name: index required: true schema: type: integer - $ref: '#/components/parameters/parent_name' - $ref: '#/components/parameters/transaction_id' - $ref: '#/components/parameters/version' - $ref: '#/components/parameters/force_reload' responses: '200': description: HTTP Request Rule replaced content: application/json: schema: $ref: '#/components/schemas/http_request_rule' '202': description: Configuration change accepted and reload requested headers: Reload-ID: description: ID of the requested reload schema: type: string content: application/json: schema: $ref: '#/components/schemas/http_request_rule' '400': $ref: '#/components/responses/BadRequest' '404': $ref: '#/components/responses/NotFound' default: $ref: '#/components/responses/DefaultError' summary: Replace a HTTP Request Rule tags: - HTTPRequestRule requestBody: content: application/json: schema: $ref: '#/components/schemas/http_request_rule' required: true components: parameters: transaction_id: name: transaction_id in: query description: ID of the transaction where we want to add the operation. Cannot be used when version is specified. required: false schema: type: string version: name: version in: query description: Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. required: false schema: type: integer parent_name: name: parent_name in: path description: Parent name required: true schema: type: string pattern: ^[^\r\n<>*;$#&{}"]+$ force_reload: name: force_reload in: query description: If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. required: false schema: type: boolean default: false schemas: error: additionalProperties: type: string description: API Error properties: code: type: - integer - 'null' message: type: - string - 'null' required: - code - message title: Error type: object http_request_rule: additionalProperties: false description: HAProxy HTTP request rule configuration (corresponds to http-request directives) example: cond: unless cond_test: '{ src 192.168.0.0/16 }' hdr_format: '%T' hdr_name: X-Haproxy-Current-Date index: 0 type: add-header properties: acl_file: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: - add-acl - del-acl x-display-name: ACL File acl_keyfmt: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: - add-acl - del-acl x-display-name: ACL Key Format auth_realm: pattern: ^[^\s]+$ type: string x-dependency: type: value: auth x-display-name: Authentication Realm bandwidth_limit_limit: type: string x-dependency: type: value: set-bandwidth-limit x-display-name: Standard HAProxy expression bandwidth_limit_name: type: string x-dependency: type: value: set-bandwidth-limit x-display-name: Bandwidth limit name bandwidth_limit_period: type: string x-dependency: type: value: set-bandwidth-limit x-display-name: Standard HAProxy expression cache_name: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: cache-use x-display-name: Cache Name capture_id: type: - integer - 'null' x-dependency: type: value: capture x-display-name: Capture SlotID capture_len: type: integer x-dependency: type: required: true value: capture x-display-name: Capture Len capture_sample: pattern: ^(?:[A-Za-z]+\("([A-Za-z\s]+)"\)|[A-Za-z]+) type: string x-dependency: type: value: capture x-display-name: Capture Sample cond: enum: - if - unless type: string x-display-name: Condition cond_test: type: string x-dependency: cond: required: true x-display-name: Condition Test x-dynamic-enum: freeFormat: true operation: getACLs property: acl_name deny_status: maximum: 599 minimum: 200 type: - integer - 'null' x-dependency: type: value: - deny - tarpit expr: type: string x-dependency: type: required: true value: - do-resolve - pause - set-bc-mark - set-bc-tos - set-dst - set-dst-port - set-fc-mark - set-fc-tos - set-priority-class - set-priority-offset - set-src - set-src-port - set-retries x-display-name: Standard HAProxy expression hdr_expr: type: string x-dependency: type: required: true value: - add-headers-bin - del-headers-bin - set-headers-bin x-display-name: Binary Headers Expression hdr_format: type: string x-dependency: type: required: true value: - replace-header - replace-value - set-header - add-header x-display-name: Header Format hdr_match: type: string x-dependency: type: required: true value: - replace-header - replace-value x-display-name: Header Match hdr_method: type: string x-dependency: type: value: - del-header - del-headers-bin x-display-name: Header Match Method hdr_name: type: string x-dependency: type: required: true value: - add-header - replace-header - del-header - set-header - replace-value x-display-name: Header Name hdr_prefix: type: string x-dependency: type: value: - add-headers-bin - set-headers-bin x-display-name: Binary Headers Prefix hint_format: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: early-hint x-display-name: Hint Format hint_name: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: early-hint x-display-name: Hint Name log_level: enum: - emerg - alert - crit - err - warning - notice - info - debug - silent type: string x-dependency: type: required: true value: set-log-level log_profile: type: string x-dependency: type: value: do-log x-display-name: Log Profile lua_action: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: lua lua_params: type: string x-dependency: type: value: lua map_file: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: - set-map - del-map map_keyfmt: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: - set-map - del-map x-display-name: Map Key Format map_valuefmt: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: set-map x-display-name: Map Value Format mark_value: pattern: ^(0x[0-9A-Fa-f]+|[0-9]+)$ type: string x-dependency: type: required: true value: set-mark x-display-name: Mark Value metadata: additionalProperties: type: object method_fmt: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: set-method nice_value: maximum: 1024 minimum: -1024 type: integer x-dependency: type: required: true value: set-nice x-display-name: Nice Value normalizer: enum: - fragment-encode - fragment-strip - path-merge-slashes - path-strip-dot - path-strip-dotdot - percent-decode-unreserved - percent-to-uppercase - query-sort-by-name type: string x-dependency: type: required: true value: normalize-uri normalizer_full: type: boolean x-dependency: normalizer: value: path-strip-dotdot type: value: normalize-uri normalizer_strict: type: boolean x-dependency: normalizer: value: - percent-decode-unreserved - percent-to-uppercase type: value: normalize-uri path_fmt: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: - set-path - set-pathq - replace-path - replace-pathq path_match: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: - set-path - set-pathq - replace-path - replace-pathq protocol: enum: - ipv4 - ipv6 type: string x-dependency: type: required: false value: do-resolve x-display-name: Protocol query-fmt: type: string x-dependency: type: required: true value: set-query redir_code: enum: - 301 - 302 - 303 - 307 - 308 type: - integer - 'null' x-dependency: type: value: redirect x-display-name: Redirect Code redir_option: type: string x-dependency: type: value: redirect x-display-name: Redirect Option redir_type: enum: - location - prefix - scheme type: string x-dependency: type: required: true value: redirect x-display-name: Redirect Type redir_value: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: redirect x-display-name: Redirect Value resolvers: type: string x-dependency: type: required: true value: do-resolve x-display-name: Resolvers return_content: type: string x-dependency: return_content_format: required: true value: - errofile - errorfiles - file - lf-file - string - lf-string return_content_format: enum: - default-errorfiles - errorfile - errorfiles - file - lf-file - string - lf-string type: string x-dependency: type: value: - deny - tarpit - return return_content_type: type: - string - 'null' x-dependency: type: value: - deny - tarpit - return x-display-name: Return content type return_hdrs: items: $ref: '#/components/schemas/return_header' type: array x-dependency: return_content_format: value: - file - lf-file - string - lf-string x-go-name: ReturnHeaders x-omitempty: true return_status_code: maximum: 599 minimum: 200 type: - integer - 'null' x-dependency: type: value: return x-display-name: Return Error Code rst_ttl: type: integer x-dependency: type: required: true value: - silent-drop x-display-name: RST TTL sc_expr: type: string x-dependency: type: required: true value: - sc-add-gpc - sc-set-gpt0 x-display-name: ScSet Expression Value sc_id: type: integer x-dependency: type: required: true value: - sc-add-gpc - sc-inc-gpc - sc-inc-gpc0 - sc-inc-gpc1 - sc-set-gpt - sc-set-gpt0 sc_idx: type: integer x-dependency: type: required: true value: - sc-add-gpc - sc-inc-gpc - sc-set-gpt sc_int: type: - integer - 'null' x-dependency: type: required: true value: - sc-add-gpc - sc-set-gpt0 x-display-name: ScSet Integer Value service_name: type: string x-dependency: type: required: true value: use-service spoe_engine: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: send-spoe-group x-display-name: SPOE Engine spoe_group: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: send-spoe-group x-display-name: SPOE Group strict_mode: enum: - 'on' - 'off' type: string x-dependency: type: required: true value: strict-mode timeout: type: string x-dependency: type: required: true value: set-timeout timeout_type: enum: - client - connect - queue - server - tarpit - tunnel type: string x-dependency: type: required: true value: set-timeout tos_value: pattern: ^(0x[0-9A-Fa-f]+|[0-9]+)$ type: string x-dependency: type: required: true value: set-tos x-display-name: Tos Value track_sc_key: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: track-sc x-display-name: track-sc Key track_sc_stick_counter: type: - integer - 'null' x-dependency: type: value: track-sc x-display-name: track-sc StickCounter track_sc_table: pattern: ^[^\s]+$ type: string x-dependency: type: value: track-sc x-display-name: track-sc Table type: enum: - add-acl - add-header - add-headers-bin - allow - auth - cache-use - capture - del-acl - del-header - del-headers-bin - del-map - deny - disable-l7-retry - do-resolve - early-hint - lua - normalize-uri - pause - redirect - reject - replace-header - replace-path - replace-pathq - replace-uri - replace-value - return - sc-add-gpc - sc-inc-gpc - sc-inc-gpc0 - sc-inc-gpc1 - sc-set-gpt - sc-set-gpt0 - send-spoe-group - set-bc-mark - set-bc-tos - set-dst - set-dst-port - set-fc-mark - set-fc-tos - set-header - set-headers-bin - set-log-level - set-map - set-mark - set-method - set-nice - set-path - set-pathq - set-priority-class - set-priority-offset - set-query - set-src - set-src-port - set-timeout - set-tos - set-uri - set-var - set-var-fmt - silent-drop - strict-mode - tarpit - track-sc - unset-var - use-service - wait-for-body - wait-for-handshake - set-bandwidth-limit - set-retries - do-log type: string uri-fmt: type: string x-dependency: type: required: true value: - set-uri - replace-uri uri-match: type: string x-dependency: type: required: true value: replace-uri var_expr: type: string x-dependency: type: required: true value: set-var x-display-name: Var Expression var_format: type: string x-dependency: type: required: true value: set-var-fmt x-display-name: Var Format var_name: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: - set-var - set-var-fmt - do-resolve - unset-var var_scope: pattern: ^[^\s]+$ type: string x-dependency: type: required: true value: - set-var - set-var-fmt - unset-var wait_at_least: type: - integer - 'null' x-dependency: type: value: wait-for-body x-size: true wait_time: minimum: 0 type: - integer - 'null' x-default-unit: ms x-dependency: type: required: true value: wait-for-body x-duration: true required: - type title: HTTP Request Rule type: object http_request_rules: title: HTTP Request Rules Array description: HAProxy HTTP request rules array (corresponds to http-request directives) type: array items: $ref: '#/components/schemas/http_request_rule' return_header: properties: fmt: type: string name: type: string required: - name - fmt type: object x-go-name: ReturnHeader responses: DefaultError: description: General Error headers: Configuration-Version: description: Configuration file version schema: type: string content: application/json: schema: $ref: '#/components/schemas/error' NotFound: description: The specified resource was not found headers: Configuration-Version: description: Configuration file version schema: type: string content: application/json: schema: $ref: '#/components/schemas/error' BadRequest: description: Bad request headers: Configuration-Version: description: Configuration file version schema: type: string content: application/json: schema: $ref: '#/components/schemas/error' AlreadyExists: description: The specified resource already exists headers: Configuration-Version: description: Configuration file version schema: type: string content: application/json: schema: $ref: '#/components/schemas/error' securitySchemes: basic_auth: type: http scheme: basic externalDocs: url: https://docs.haproxy.org/ description: HAProxy Documentation