mirror of
				https://github.com/NginxProxyManager/nginx-proxy-manager.git
				synced 2025-10-30 23:33:34 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			151 lines
		
	
	
		
			4.2 KiB
		
	
	
	
		
			JSON
		
	
	
	
	
	
			
		
		
	
	
			151 lines
		
	
	
		
			4.2 KiB
		
	
	
	
		
			JSON
		
	
	
	
	
	
| {
 | |
| 	"operationId": "updateProxyHost",
 | |
| 	"summary": "Update a Proxy Host",
 | |
| 	"tags": ["proxy-hosts"],
 | |
| 	"security": [
 | |
| 		{
 | |
| 			"bearerAuth": [
 | |
| 				"proxy_hosts.manage"
 | |
| 			]
 | |
| 		}
 | |
| 	],
 | |
| 	"parameters": [
 | |
| 		{
 | |
| 			"in": "path",
 | |
| 			"name": "hostID",
 | |
| 			"description": "The ID of the Proxy Host",
 | |
| 			"schema": {
 | |
| 				"type": "integer",
 | |
| 				"minimum": 1
 | |
| 			},
 | |
| 			"required": true,
 | |
| 			"example": 2
 | |
| 		}
 | |
| 	],
 | |
| 	"requestBody": {
 | |
| 		"description": "Proxy Host Payload",
 | |
| 		"required": true,
 | |
| 		"content": {
 | |
| 			"application/json": {
 | |
| 				"schema": {
 | |
| 					"type": "object",
 | |
| 					"additionalProperties": false,
 | |
| 					"minProperties": 1,
 | |
| 					"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"
 | |
| 						}
 | |
| 					}
 | |
| 				}
 | |
| 			}
 | |
| 		}
 | |
| 	},
 | |
| 	"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:17:06.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,
 | |
| 								"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"
 | |
| 									]
 | |
| 								},
 | |
| 								"certificate": null,
 | |
| 								"access_list": null
 | |
| 							}
 | |
| 						}
 | |
| 					},
 | |
| 					"schema": {
 | |
| 						"$ref": "../../../../components/proxy-host-object.json"
 | |
| 					}
 | |
| 				}
 | |
| 			}
 | |
| 		}
 | |
| 	}
 | |
| }
 |