mirror of
				https://github.com/NginxProxyManager/nginx-proxy-manager.git
				synced 2025-11-04 01:15:14 +00:00 
			
		
		
		
	Moved v3 code from NginxProxyManager/nginx-proxy-manager-3 to NginxProxyManager/nginx-proxy-manager
This commit is contained in:
		
							
								
								
									
										60
									
								
								backend/embed/api_docs/paths/hosts/hostID/delete.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										60
									
								
								backend/embed/api_docs/paths/hosts/hostID/delete.json
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,60 @@
 | 
			
		||||
{
 | 
			
		||||
	"operationId": "deleteHost",
 | 
			
		||||
	"summary": "Delete a Host",
 | 
			
		||||
	"tags": [
 | 
			
		||||
		"Hosts"
 | 
			
		||||
	],
 | 
			
		||||
	"parameters": [
 | 
			
		||||
		{
 | 
			
		||||
			"in": "path",
 | 
			
		||||
			"name": "hostID",
 | 
			
		||||
			"schema": {
 | 
			
		||||
				"type": "integer",
 | 
			
		||||
				"minimum": 1
 | 
			
		||||
			},
 | 
			
		||||
			"required": true,
 | 
			
		||||
			"description": "Numeric ID of the Host",
 | 
			
		||||
			"example": 1
 | 
			
		||||
		}
 | 
			
		||||
	],
 | 
			
		||||
	"responses": {
 | 
			
		||||
		"200": {
 | 
			
		||||
			"description": "200 response",
 | 
			
		||||
			"content": {
 | 
			
		||||
				"application/json": {
 | 
			
		||||
					"schema": {
 | 
			
		||||
						"$ref": "#/components/schemas/DeletedItemResponse"
 | 
			
		||||
					},
 | 
			
		||||
					"examples": {
 | 
			
		||||
						"default": {
 | 
			
		||||
							"value": {
 | 
			
		||||
								"result": true
 | 
			
		||||
							}
 | 
			
		||||
						}
 | 
			
		||||
					}
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		},
 | 
			
		||||
		"400": {
 | 
			
		||||
			"description": "400 response",
 | 
			
		||||
			"content": {
 | 
			
		||||
				"application/json": {
 | 
			
		||||
					"schema": {
 | 
			
		||||
						"$ref": "#/components/schemas/DeletedItemResponse"
 | 
			
		||||
					},
 | 
			
		||||
					"examples": {
 | 
			
		||||
						"default": {
 | 
			
		||||
							"value": {
 | 
			
		||||
								"result": null,
 | 
			
		||||
								"error": {
 | 
			
		||||
									"code": 400,
 | 
			
		||||
									"message": "You cannot delete a host that is in use!"
 | 
			
		||||
								}
 | 
			
		||||
							}
 | 
			
		||||
						}
 | 
			
		||||
					}
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										65
									
								
								backend/embed/api_docs/paths/hosts/hostID/get.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										65
									
								
								backend/embed/api_docs/paths/hosts/hostID/get.json
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,65 @@
 | 
			
		||||
{
 | 
			
		||||
	"operationId": "getHost",
 | 
			
		||||
	"summary": "Get a Host object by ID",
 | 
			
		||||
	"tags": ["Hosts"],
 | 
			
		||||
	"parameters": [
 | 
			
		||||
		{
 | 
			
		||||
			"in": "path",
 | 
			
		||||
			"name": "hostID",
 | 
			
		||||
			"schema": {
 | 
			
		||||
				"type": "integer",
 | 
			
		||||
				"minimum": 1
 | 
			
		||||
			},
 | 
			
		||||
			"required": true,
 | 
			
		||||
			"description": "ID of the Host",
 | 
			
		||||
			"example": 1
 | 
			
		||||
		}
 | 
			
		||||
	],
 | 
			
		||||
	"responses": {
 | 
			
		||||
		"200": {
 | 
			
		||||
			"description": "200 response",
 | 
			
		||||
			"content": {
 | 
			
		||||
				"application/json": {
 | 
			
		||||
					"schema": {
 | 
			
		||||
						"required": ["result"],
 | 
			
		||||
						"properties": {
 | 
			
		||||
							"result": {
 | 
			
		||||
								"$ref": "#/components/schemas/HostObject"
 | 
			
		||||
							}
 | 
			
		||||
						}
 | 
			
		||||
					},
 | 
			
		||||
					"examples": {
 | 
			
		||||
						"default": {
 | 
			
		||||
							"value": {
 | 
			
		||||
								"result": {
 | 
			
		||||
									"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
 | 
			
		||||
								}
 | 
			
		||||
							}
 | 
			
		||||
						}
 | 
			
		||||
					}
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										74
									
								
								backend/embed/api_docs/paths/hosts/hostID/put.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										74
									
								
								backend/embed/api_docs/paths/hosts/hostID/put.json
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,74 @@
 | 
			
		||||
{
 | 
			
		||||
	"operationId": "updateHost",
 | 
			
		||||
	"summary": "Update an existing Host",
 | 
			
		||||
	"tags": ["Hosts"],
 | 
			
		||||
	"parameters": [
 | 
			
		||||
		{
 | 
			
		||||
			"in": "path",
 | 
			
		||||
			"name": "hostID",
 | 
			
		||||
			"schema": {
 | 
			
		||||
				"type": "integer",
 | 
			
		||||
				"minimum": 1
 | 
			
		||||
			},
 | 
			
		||||
			"required": true,
 | 
			
		||||
			"description": "ID of the Host",
 | 
			
		||||
			"example": 1
 | 
			
		||||
		}
 | 
			
		||||
	],
 | 
			
		||||
	"requestBody": {
 | 
			
		||||
		"description": "Host details to update",
 | 
			
		||||
		"required": true,
 | 
			
		||||
		"content": {
 | 
			
		||||
			"application/json": {
 | 
			
		||||
				"schema": "{{schema.UpdateHost}}"
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	},
 | 
			
		||||
	"responses": {
 | 
			
		||||
		"200": {
 | 
			
		||||
			"description": "200 response",
 | 
			
		||||
			"content": {
 | 
			
		||||
				"application/json": {
 | 
			
		||||
					"schema": {
 | 
			
		||||
						"required": ["result"],
 | 
			
		||||
						"properties": {
 | 
			
		||||
							"result": {
 | 
			
		||||
								"$ref": "#/components/schemas/HostObject"
 | 
			
		||||
							}
 | 
			
		||||
						}
 | 
			
		||||
					},
 | 
			
		||||
					"examples": {
 | 
			
		||||
						"default": {
 | 
			
		||||
							"value": {
 | 
			
		||||
								"result": {
 | 
			
		||||
									"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
 | 
			
		||||
								}
 | 
			
		||||
							}
 | 
			
		||||
						}
 | 
			
		||||
					}
 | 
			
		||||
				}
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
		Reference in New Issue
	
	Block a user