mirror of
https://github.com/NginxProxyManager/nginx-proxy-manager.git
synced 2025-11-04 09:25:15 +00:00
148 lines
4.1 KiB
JSON
148 lines
4.1 KiB
JSON
{
|
|
"operationId": "createProxyHost",
|
|
"summary": "Create a Proxy Host",
|
|
"tags": ["proxy-hosts"],
|
|
"security": [
|
|
{
|
|
"bearerAuth": [
|
|
"proxy_hosts.manage"
|
|
]
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"description": "Proxy Host Payload",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"domain_names",
|
|
"forward_scheme",
|
|
"forward_host",
|
|
"forward_port"
|
|
],
|
|
"properties": {
|
|
"domain_names": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/domain_names"
|
|
},
|
|
"forward_scheme": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/forward_scheme"
|
|
},
|
|
"forward_host": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/forward_host"
|
|
},
|
|
"forward_port": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/forward_port"
|
|
},
|
|
"certificate_id": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/certificate_id"
|
|
},
|
|
"ssl_forced": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/ssl_forced"
|
|
},
|
|
"hsts_enabled": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/hsts_enabled"
|
|
},
|
|
"hsts_subdomains": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/hsts_subdomains"
|
|
},
|
|
"http2_support": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/http2_support"
|
|
},
|
|
"block_exploits": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/block_exploits"
|
|
},
|
|
"caching_enabled": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/caching_enabled"
|
|
},
|
|
"allow_websocket_upgrade": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/allow_websocket_upgrade"
|
|
},
|
|
"access_list_id": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/access_list_id"
|
|
},
|
|
"advanced_config": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/advanced_config"
|
|
},
|
|
"enabled": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/enabled"
|
|
},
|
|
"meta": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/meta"
|
|
},
|
|
"locations": {
|
|
"$ref": "../../../components/proxy-host-object.json#/properties/locations"
|
|
}
|
|
}
|
|
},
|
|
"example": {
|
|
"domain_names": [
|
|
"test.example.com"
|
|
],
|
|
"forward_scheme": "http",
|
|
"forward_host": "127.0.0.1",
|
|
"forward_port": 8080
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "201 response",
|
|
"content": {
|
|
"application/json": {
|
|
"examples": {
|
|
"default": {
|
|
"value": {
|
|
"id": 3,
|
|
"created_on": "2025-10-30T01:12:05.000Z",
|
|
"modified_on": "2025-10-30T01:12:05.000Z",
|
|
"owner_user_id": 1,
|
|
"domain_names": [
|
|
"test.example.com"
|
|
],
|
|
"forward_host": "127.0.0.1",
|
|
"forward_port": 8080,
|
|
"access_list_id": 0,
|
|
"certificate_id": 0,
|
|
"ssl_forced": false,
|
|
"caching_enabled": false,
|
|
"block_exploits": false,
|
|
"advanced_config": "",
|
|
"meta": {},
|
|
"allow_websocket_upgrade": false,
|
|
"http2_support": false,
|
|
"forward_scheme": "http",
|
|
"enabled": true,
|
|
"locations": [],
|
|
"hsts_enabled": false,
|
|
"hsts_subdomains": false,
|
|
"certificate": null,
|
|
"owner": {
|
|
"id": 1,
|
|
"created_on": "2025-10-28T00:50:24.000Z",
|
|
"modified_on": "2025-10-28T00:50:24.000Z",
|
|
"is_disabled": false,
|
|
"email": "jc@jc21.com",
|
|
"name": "jamiec",
|
|
"nickname": "jamiec",
|
|
"avatar": "//www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?default=mm",
|
|
"roles": [
|
|
"admin"
|
|
]
|
|
},
|
|
"access_list": null
|
|
}
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "../../../components/proxy-host-object.json"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|