The BackendSwitchingRule API from HAProxy — 2 operation(s) for backendswitchingrule.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/haproxy-backendswitchingrule-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: HAProxy Data Plane Backend Switching 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: BackendSwitchingRule
paths:
/services/haproxy/configuration/frontends/{parent_name}/backend_switching_rules:
get:
description: Returns all Backend Switching Rules that are configured in specified frontend.
operationId: getBackendSwitchingRules
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/backend_switching_rules'
default:
$ref: '#/components/responses/DefaultError'
summary: Return an array of all Backend Switching Rules
tags:
- BackendSwitchingRule
put:
description: Replaces a whole list of Backend Switching Rules with the list given in parameter
operationId: replaceBackendSwitchingRules
parameters:
- $ref: '#/components/parameters/parent_name'
- $ref: '#/components/parameters/transaction_id'
- $ref: '#/components/parameters/version'
- $ref: '#/components/parameters/force_reload'
responses:
'200':
description: All Backend Switching Rule lines replaced
content:
application/json:
schema:
$ref: '#/components/schemas/backend_switching_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/backend_switching_rules'
'400':
$ref: '#/components/responses/BadRequest'
default:
$ref: '#/components/responses/DefaultError'
summary: Replace an Backend Switching Rule list
tags:
- BackendSwitchingRule
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/backend_switching_rules'
required: true
/services/haproxy/configuration/frontends/{parent_name}/backend_switching_rules/{index}:
delete:
description: Deletes a Backend Switching Rule configuration by it's index from the specified frontend.
operationId: deleteBackendSwitchingRule
parameters:
- description: Switching 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: Backend Switching Rule deleted
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/DefaultError'
summary: Delete a Backend Switching Rule
tags:
- BackendSwitchingRule
get:
description: Returns one Backend Switching Rule configuration by it's index in the specified frontend.
operationId: getBackendSwitchingRule
parameters:
- description: Switching 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/backend_switching_rule'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/DefaultError'
summary: Return one Backend Switching Rule
tags:
- BackendSwitchingRule
post:
description: Adds a new Backend Switching Rule of the specified type in the specified frontend.
operationId: createBackendSwitchingRule
parameters:
- description: Switching 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: Backend Switching Rule created
content:
application/json:
schema:
$ref: '#/components/schemas/backend_switching_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/backend_switching_rule'
'400':
$ref: '#/components/responses/BadRequest'
'409':
$ref: '#/components/responses/AlreadyExists'
default:
$ref: '#/components/responses/DefaultError'
summary: Add a new Backend Switching Rule
tags:
- BackendSwitchingRule
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/backend_switching_rule'
required: true
put:
description: Replaces a Backend Switching Rule configuration by it's index in the specified frontend.
operationId: replaceBackendSwitchingRule
parameters:
- description: Switching 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: Backend Switching Rule replaced
content:
application/json:
schema:
$ref: '#/components/schemas/backend_switching_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/backend_switching_rule'
'400':
$ref: '#/components/responses/BadRequest'
'404':
$ref: '#/components/responses/NotFound'
default:
$ref: '#/components/responses/DefaultError'
summary: Replace a Backend Switching Rule
tags:
- BackendSwitchingRule
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/backend_switching_rule'
required: true
components:
schemas:
backend_switching_rules:
title: Backend Switching Rules Array
description: HAProxy backend switching rules array (corresponds to use_backend directives)
type: array
items:
$ref: '#/components/schemas/backend_switching_rule'
error:
additionalProperties:
type: string
description: API Error
properties:
code:
type:
- integer
- 'null'
message:
type:
- string
- 'null'
required:
- code
- message
title: Error
type: object
backend_switching_rule:
additionalProperties: false
description: HAProxy backend switching rule configuration (corresponds to use_backend directive)
example:
cond: if
cond_test: '{ req.ssl_sni -i www.example.com }'
index: 0
name: test_backend
properties:
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
metadata:
additionalProperties:
type: object
name:
pattern: ^[^\s]+$
type: string
x-display-name: Backend Name
x-dynamic-enum:
operation: getBackends
property: name
required:
- name
title: Backend Switching Rule
type: object
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
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