HAProxy Data Plane API (2.0)

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

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:

Responses

200

Success

default

General Error

get/
/v2/

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Return cluster data

Returns cluster data

Authorizations:

Responses

200

Success

default

General Error

get/cluster
/v2/cluster

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "bootstrap_key": "string",
  • "cluster":
    {
    },
  • "mode": "single",
  • "status": "active"
}

Return list of service endpoints

Returns a list of API managed services endpoints.

Authorizations:

Responses

200

Success

default

General Error

get/services
/v2/services

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Return list of HAProxy related endpoints

Returns a list of HAProxy related endpoints.

Authorizations:

Responses

200

Success

default

General Error

get/services/haproxy
/v2/services/haproxy

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Return list of HAProxy stats endpoints

Returns a list of HAProxy stats endpoints.

Authorizations:

Responses

200

Success

default

General Error

get/services/haproxy/stats
/v2/services/haproxy/stats

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

Return list of HAProxy advanced configuration endpoints

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

Authorizations:

Responses

200

Success

default

General Error

get/services/haproxy/configuration
/v2/services/haproxy/configuration

Response samples

Content type
application/json
Copy