π§Listeners
Listeners endpoint to create/edit/manage/delete listeners
Get Listeners
GET
http://localhost:8080/listeners
Show all listeners in JSON or as the normal front end.
Query Parameters
Name | Type | Description |
---|---|---|
json | Boolean | If the output should be in json format |
Headers
Name | Type | Description |
---|---|---|
Api-Key | String | Your API-key. |
Get options
GET
http://localhost:8080/listeners/options
Get the options required to create a new listener.
Query Parameters
Name | Type | Description |
---|---|---|
json | Boolean | If the output should be in json format |
type* | String | The type of listener |
Headers
Name | Type | Description |
---|---|---|
Api-Key | String | Your API-key. |
Add listener
POST
http://localhost:8080/listeners/options
Get the options required to create a new listener.
Query Parameters
Name | Type | Description |
---|---|---|
json | Boolean | If the output should be in json format |
is_interface | Boolean | Indicates if the given address is a interface name so it's automatically converted to it's address. |
Headers
Name | Type | Description |
---|---|---|
Api-Key | String | Your API-key. |
Request Body
Name | Type | Description |
---|---|---|
type* | String | The type of the listener |
name* | String | The name of the listener |
address* | String | The address the listener should listen on, or its interface. |
port* | Integer | The port the listener should listen on. |
ssl | Boolean | If ssl should be used. |
limit | Integer | The limit of concurrent connections of stagers to this listener. |
*options | Any | Other options listed for this type of listener at the options endpoint |
Last updated