mirror of
				https://github.com/NginxProxyManager/nginx-proxy-manager.git
				synced 2025-10-31 15:53:33 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			45 lines
		
	
	
		
			799 B
		
	
	
	
		
			JSON
		
	
	
	
	
	
			
		
		
	
	
			45 lines
		
	
	
		
			799 B
		
	
	
	
		
			JSON
		
	
	
	
	
	
| {
 | |
| 	"operationId": "health",
 | |
| 	"summary": "Returns the API health status",
 | |
| 	"responses": {
 | |
| 		"200": {
 | |
| 			"description": "200 response",
 | |
| 			"content": {
 | |
| 				"application/json": {
 | |
| 					"schema": {
 | |
| 						"type": "object",
 | |
| 						"required": ["result"],
 | |
| 						"properties": {
 | |
| 							"result": {
 | |
| 								"$ref": "#/components/schemas/HealthObject"
 | |
| 							}
 | |
| 						}
 | |
| 					},
 | |
| 					"examples": {
 | |
| 						"default": {
 | |
| 							"value": {
 | |
| 								"result": {
 | |
| 									"version": "3.0.0",
 | |
| 									"commit": "9f119b6",
 | |
| 									"healthy": true,
 | |
| 									"setup": true
 | |
| 								}
 | |
| 							}
 | |
| 						},
 | |
| 						"unhealthy": {
 | |
| 							"value": {
 | |
| 								"result": {
 | |
| 									"version": "3.0.0",
 | |
| 									"commit": "9f119b6",
 | |
| 									"healthy": false,
 | |
| 									"setup": true
 | |
| 								}
 | |
| 							}
 | |
| 						}
 | |
| 					}
 | |
| 				}
 | |
| 			}
 | |
| 		}
 | |
| 	}
 | |
| }
 |