mirror of
https://github.com/jc21/nginx-proxy-manager.git
synced 2024-08-30 18:22:48 +00:00
95 lines
1.9 KiB
JSON
95 lines
1.9 KiB
JSON
{
|
|
"operationId": "getHosts",
|
|
"summary": "Get a list of Hosts",
|
|
"tags": ["Hosts"],
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "offset",
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"description": "The pagination row offset, default 0",
|
|
"example": 0
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "limit",
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"description": "The pagination row limit, default 10",
|
|
"example": 10
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sort",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"description": "The sorting of the list",
|
|
"example": "id,name.asc,value.desc"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "200 response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"required": ["result"],
|
|
"properties": {
|
|
"result": {
|
|
"$ref": "#/components/schemas/HostList"
|
|
}
|
|
}
|
|
},
|
|
"examples": {
|
|
"default": {
|
|
"value": {
|
|
"result": {
|
|
"total": 1,
|
|
"offset": 0,
|
|
"limit": 10,
|
|
"sort": [
|
|
{
|
|
"field": "domain_names",
|
|
"direction": "ASC"
|
|
}
|
|
],
|
|
"items": [
|
|
{
|
|
"id": 1,
|
|
"created_on": 1646279455,
|
|
"modified_on": 1646279455,
|
|
"user_id": 2,
|
|
"type": "proxy",
|
|
"host_template_id": 1,
|
|
"listen_interface": "",
|
|
"domain_names": ["jc21.com"],
|
|
"upstream_id": 0,
|
|
"certificate_id": 0,
|
|
"access_list_id": 0,
|
|
"ssl_forced": false,
|
|
"caching_enabled": false,
|
|
"block_exploits": false,
|
|
"allow_websocket_upgrade": false,
|
|
"http2_support": false,
|
|
"hsts_enabled": false,
|
|
"hsts_subdomains": false,
|
|
"paths": "",
|
|
"upstream_options": "",
|
|
"advanced_config": "",
|
|
"is_disabled": false
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|