nginx-proxy-manager/backend/schema/paths/nginx/proxy-hosts/hostID/get.json

{
	"operationId": "getProxyHost",
	"summary": "Get a Proxy Host",
	"tags": ["proxy-hosts"],
	"security": [
		{
			"bearerAuth": [
				"proxy_hosts.view"
			]
		}
	],
	"parameters": [
		{
			"in": "path",
			"name": "hostID",
			"description": "The ID of the Proxy Host",
			"schema": {
				"type": "integer",
				"minimum": 1
			},
			"required": true,
			"example": 1
		}
	],
	"responses": {
		"200": {
			"description": "200 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": {
									"nginx_online": true,
									"nginx_err": null
								},
								"allow_websocket_upgrade": false,
								"http2_support": false,
								"forward_scheme": "http",
								"enabled": true,
								"locations": [],
								"hsts_enabled": false,
								"hsts_subdomains": false,
								"trust_forwarded_proto": false,
								"owner": {
									"id": 1,
									"created_on": "2025-10-28T00:50:24.000Z",
									"modified_on": "2025-10-28T00:50:24.000Z",
									"is_disabled": false,
									"email": "[email protected]",
									"name": "jamiec",
									"nickname": "jamiec",
									"avatar": "//www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?default=mm",
									"roles": [
										"admin"
									]
								}
							}
						}
					},
					"schema": {
						"$ref": "../../../../components/proxy-host-object.json"
					}
				}
			}
		}
	}
}