mirror of
https://github.com/xiaoxinpro/nginx-proxy-manager-zh.git
synced 2025-01-24 05:38:15 -05:00
81 lines
1.5 KiB
JSON
81 lines
1.5 KiB
JSON
{
|
|
"operationId": "getNginxTemplates",
|
|
"summary": "Get a list of Nginx Templates",
|
|
"tags": ["Nginx Templates"],
|
|
"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": {
|
|
"type": "object",
|
|
"required": ["result"],
|
|
"properties": {
|
|
"result": {
|
|
"$ref": "#/components/schemas/NginxTemplateList"
|
|
}
|
|
}
|
|
},
|
|
"examples": {
|
|
"default": {
|
|
"value": {
|
|
"result": {
|
|
"total": 1,
|
|
"offset": 0,
|
|
"limit": 10,
|
|
"sort": [
|
|
{
|
|
"field": "created_at",
|
|
"direction": "ASC"
|
|
}
|
|
],
|
|
"items": [
|
|
{
|
|
"id": 1,
|
|
"created_at": 1646218093000,
|
|
"updated_at": 1646218093000,
|
|
"user_id": 1,
|
|
"name": "Default Proxy Template",
|
|
"type": "proxy",
|
|
"template": "# this is a proxy template"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|