HAProxy Data Plane API (2.0)

HAProxy Support: support@haproxy.com URL: https://my.haproxy.com/portal/cust/login

API for editing and managing haproxy instances. Provides process information, configuration management, haproxy stats and logs.

HAProxy Documentation

Authentication

basic_auth

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

Discovery

API autodiscover endpoints

Return list of root endpoints

Returns a list of root endpoints.

Authorizations:

basic_auth

Responses

200

Success

default

General Error

get/

/v2/

Response samples

200
default

Content type

application/json

Copy

Expand all Collapse all


[
{"description": "string",
"title": "string",
"url": "string"
}
]

Return cluster data

Returns cluster data

Authorizations:

basic_auth

Responses

200

Success

default

General Error

get/cluster

/v2/cluster

Response samples

200
default

Content type

application/json

Copy

Expand all Collapse all


{"bootstrap_key": "string",
"cluster": 
{"address": "string",
"api_base_path": "string",
"description": "string",
"name": "string",
"port": 1
},
"mode": "single",
"status": "active"
}

Return list of service endpoints

Returns a list of API managed services endpoints.

Authorizations:

basic_auth

Responses

200

Success

default

General Error

get/services

/v2/services

Response samples

200
default

Content type

application/json

Copy

Expand all Collapse all


[
{"description": "string",
"title": "string",
"url": "string"
}
]

Return list of HAProxy related endpoints

Returns a list of HAProxy related endpoints.

Authorizations:

basic_auth

Responses

200

Success

default

General Error

get/services/haproxy

/v2/services/haproxy

Response samples

200
default

Content type

application/json

Copy

Expand all Collapse all


[
{"description": "string",
"title": "string",
"url": "string"
}
]

Return list of HAProxy stats endpoints

Returns a list of HAProxy stats endpoints.

Authorizations:

basic_auth

Responses

200

Success

default

General Error

get/services/haproxy/stats

/v2/services/haproxy/stats

Response samples

200
default

Content type

application/json

Copy

Expand all Collapse all


[
{"description": "string",
"title": "string",
"url": "string"
}
]

Return list of HAProxy advanced configuration endpoints

Returns a list of endpoints to be used for advanced configuration of HAProxy objects.

Authorizations:

basic_auth

Responses

200

Success

default

General Error

get/services/haproxy/configuration

/v2/services/haproxy/configuration

Response samples

200
default

Content type

application/json