HAProxy Data Plane API

https://www.haproxy.com/documentation/dataplaneapi
Admin
HAProxy Data Plane API is a RESTful API for managing and configuring HAProxy instances, providing...
Tokens:2,270
Snippets:17
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /services/haproxy/waf/rulesets

Source: https://www.haproxy.com/documentation/dataplaneapi/enterprise

Retrieves a list of WAF rulesets.

```APIDOC
## GET /services/haproxy/waf/rulesets

### Description
Retrieves a list of WAF rulesets.

### Method
GET

### Endpoint
/services/haproxy/waf/rulesets

### Parameters
#### Query Parameters
- **name** (string) - Optional - Filter rulesets by name.

### Response
#### Success Response (200)
- **data** (array) - List of WAF rulesets.

#### Response Example
{
  "data": []
}
```

--------------------------------

### GET /services/haproxy/waf/rulesets/{ruleset_name}/files

Source: https://www.haproxy.com/documentation/dataplaneapi/enterprise

Retrieves a list of files in a WAF ruleset.

```APIDOC
## GET /services/haproxy/waf/rulesets/{ruleset_name}/files

### Description
Retrieves a list of files in a WAF ruleset.

### Method
GET

### Endpoint
/services/haproxy/waf/rulesets/{ruleset_name}/files

### Parameters
#### Path Parameters
- **ruleset_name** (string) - Required - Name of the ruleset.

### Response
#### Success Response (200)
- **data** (array) - List of files.

#### Response Example
{
  "data": []
}
```

--------------------------------

### GET /ping

Source: https://www.haproxy.com/documentation/dataplaneapi/enterprise

Checks the API server availability.

```APIDOC
## GET /ping

### Description
Checks the API server availability.

### Method
GET

### Endpoint
/ping

### Response
#### Success Response (200)
- **message** (string) - Pong message.

#### Response Example
{
  "message": "pong"
}
```

--------------------------------

### GET /services/haproxy/waf/rulesets/{ruleset_name}/files/{name}

Source: https://www.haproxy.com/documentation/dataplaneapi/enterprise

Retrieves a specific file from a WAF ruleset.

```APIDOC
## GET /services/haproxy/waf/rulesets/{ruleset_name}/files/{name}

### Description
Retrieves a specific file from a WAF ruleset.

### Method
GET

### Endpoint
/services/haproxy/waf/rulesets/{ruleset_name}/files/{name}

### Parameters
#### Path Parameters
- **ruleset_name** (string) - Required - Name of the ruleset.
- **name** (string) - Required - Name of the file.

### Response
#### Success Response (200)
- **data** (object) - The requested file.

#### Response Example
{
  "data": {}
}
```

--------------------------------

### GET /services/haproxy/waf/rulesets/{name}

Source: https://www.haproxy.com/documentation/dataplaneapi/enterprise

Retrieves a specific WAF ruleset by name.

```APIDOC
## GET /services/haproxy/waf/rulesets/{name}

### Description
Retrieves a specific WAF ruleset by name.

### Method
GET

### Endpoint
/services/haproxy/waf/rulesets/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - Name of the ruleset.

### Response
#### Success Response (200)
- **data** (object) - The requested ruleset.

#### Response Example
{
  "data": {}
}
```

--------------------------------

### GET /services/haproxy/configuration/backends/{parent_name}/acls

Source: https://www.haproxy.com/documentation/dataplaneapi/community

Returns all ACL lines that are configured in the specified parent backend. This endpoint requires authentication and supports query parameters for filtering by ACL name and transaction ID.

```APIDOC
## GET /services/haproxy/configuration/backends/{parent_name}/acls

### Description
Returns all ACL lines that are configured in specified parent.

### Method
GET

### Endpoint
/services/haproxy/configuration/backends/{parent_name}/acls

### Parameters
#### Path Parameters
- **parent_name** (string) - Required - Parent name. Pattern: ^[^\r\n<>*;$#&{}"]+$

#### Query Parameters
- **acl_name** (string) - Optional - ACL name
- **transaction_id** (string) - Optional - ID of the transaction where we want to add the operation. Cannot be used when version is specified.

### Request Example

curl 'http://[address]:[port]/services/haproxy/configuration/backends/{parent_name}/acls?acl_name=&transaction_id=' \
  --header 'Authorization: Basic username:password'


### Response
#### Success Response (200)
- **acl_name** (string) - ACL name
- **criterion** (string) - Criterion
- **metadata** (object) - Metadata
- **value** (string) - Value

#### Response Example

[
  {
    "acl_name": "string",
    "criterion": "string",
    "metadata": {
      "additionalProperty": {}
    },
    "value": "string"
  }
]


```

--------------------------------

### JSON response schema for ACL array

Source: https://www.haproxy.com/documentation/dataplaneapi/enterprise

Example JSON response schema for a successful operation (status 200). Shows the structure of an ACL object with fields acl_name, criterion, metadata, and value.

```json
[
  {
    "acl_name": "string",
    "criterion": "string",
    "metadata": {
      "additionalProperty": {}
    },
    "value": "string"
  }
]

```

--------------------------------

### Successful response for getting ACL lines

Source: https://www.haproxy.com/documentation/dataplaneapi/community

Shows the response body for the ACL retrieval operation when successful. The response is a JSON array of ACL objects, each with fields for name, criterion, metadata, and value. The metadata field is an object allowing additional properties.

```json
[
  {
    "acl_name": "string",
    "criterion": "string",
    "metadata": {
      "additionalProperty": {}
    },
    "value": "string"
  }
]
```

--------------------------------

### POST /services/haproxy/waf/rulesets/{ruleset_name}/files

Source: https://www.haproxy.com/documentation/dataplaneapi/enterprise

Creates a new file in a WAF ruleset.

```APIDOC
## POST /services/haproxy/waf/rulesets/{ruleset_name}/files

### Description
Creates a new file in a WAF ruleset.

### Method
POST

### Endpoint
/services/haproxy/waf/rulesets/{ruleset_name}/files

### Parameters
#### Path Parameters
- **ruleset_name** (string) - Required - Name of the ruleset.

#### Request Body
- **name** (string) - Required - Name of the file.

### Response
#### Success Response (201)
- **data** (object) - The created file.

#### Response Example
{
  "data": {}
}
```

--------------------------------

### POST /services/haproxy/waf/rulesets

Source: https://www.haproxy.com/documentation/dataplaneapi/enterprise

Creates a new WAF ruleset.

```APIDOC
## POST /services/haproxy/waf/rulesets

### Description
Creates a new WAF ruleset.

### Method
POST

### Endpoint
/services/haproxy/waf/rulesets

### Parameters
#### Request Body
- **name** (string) - Required - Name of the ruleset.

### Response
#### Success Response (201)
- **data** (object) - The created ruleset.

#### Response Example
{
  "data": {}
}
```

--------------------------------

### PUT /services/haproxy/waf/rulesets/{ruleset_name}/files/{name}

Source: https://www.haproxy.com/documentation/dataplaneapi/enterprise

Updates a file in a WAF ruleset.

```APIDOC
## PUT /services/haproxy/waf/rulesets/{ruleset_name}/files/{name}

### Description
Updates a file in a WAF ruleset.

### Method
PUT

### Endpoint
/services/haproxy/waf/rulesets/{ruleset_name}/files/{name}

### Parameters
#### Path Parameters
- **ruleset_name** (string) - Required - Name of the ruleset.
- **name** (string) - Required - Name of the file to update.

#### Request Body
- **name** (string) - Required - New name of the file.

### Response
#### Success Response (200)
- **data** (object) - The updated file.

#### Response Example
{
  "data": {}
}
```

--------------------------------

### curl request to return all ACL lines of a backend

Source: https://www.haproxy.com/documentation/dataplaneapi/community

Use this cURL command to retrieve all ACL lines configured in a specified parent backend. The request expects path parameter 'parent_name' and query parameters 'acl_name' and 'transaction_id'. Set the server address and port via the 'address' and 'port' placeholders, and replace username:password with valid basic auth credentials.

```shell
curl 'http://[address]:[port]/services/haproxy/configuration/backends/{parent_name}/acls?acl_name=&transaction_id=' \
  --header 'Authorization: Basic username:password'
```

--------------------------------

### PUT /services/haproxy/waf/rulesets/{name}

Source: https://www.haproxy.com/documentation/dataplaneapi/enterprise

Updates a WAF ruleset by name.

```APIDOC
## PUT /services/haproxy/waf/rulesets/{name}

### Description
Updates a WAF ruleset by name.

### Method
PUT

### Endpoint
/services/haproxy/waf/rulesets/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - Name of the ruleset to update.

#### Request Body
- **name** (string) - Required - New name of the ruleset.

### Response
#### Success Response (200)
- **data** (object) - The updated ruleset.

#### Response Example
{
  "data": {}
}
```

--------------------------------

### DELETE /services/haproxy/waf/rulesets/{ruleset_name}/files/{name}

Source: https://www.haproxy.com/documentation/dataplaneapi/enterprise

Deletes a file from a WAF ruleset.

```APIDOC
## DELETE /services/haproxy/waf/rulesets/{ruleset_name}/files/{name}

### Description
Deletes a file from a WAF ruleset.

### Method
DELETE

### Endpoint
/services/haproxy/waf/rulesets/{ruleset_name}/files/{name}

### Parameters
#### Path Parameters
- **ruleset_name** (string) - Required - Name of the ruleset.
- **name** (string) - Required - Name of the file to delete.

### Response
#### Success Response (204)
No content.
```

--------------------------------

### DELETE /services/haproxy/waf/rulesets/{name}

Source: https://www.haproxy.com/documentation/dataplaneapi/enterprise

Deletes a WAF ruleset by name.

```APIDOC
## DELETE /services/haproxy/waf/rulesets/{name}

### Description
Deletes a WAF ruleset by name.

### Method
DELETE

### Endpoint
/services/haproxy/waf/rulesets/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - Name of the ruleset to delete.

### Response
#### Success Response (204)
No content.
```
Tokens:
Raw