mirror of
https://github.com/NginxProxyManager/nginx-proxy-manager.git
synced 2026-11-19 14:40:27 +00:00
- all four host types write nginx_online, nginx_err, nginx_details and nginx_checked_at to meta on create, update and enable; these keys are owned by the server and stripped from incoming data - an update nginx rejects at host level answers 400 and the previous row is restored (internalHost.updateAndConfigure), a rejected create is removed - a new host that requests a certificate is checked with a dry run first, so a rejected host doesn't leave an unused certificate behind - upstream host names are trimmed - advanced configs (host and custom location) may not point access_log / error_log at files nginx reads as configuration, nor include generated host configs (lib/nginx-advanced.js, tokenizer in lib/nginx-tokenize.js) - schema: meta keys of all host types, 400 examples Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
114 lines
2.4 KiB
JSON
114 lines
2.4 KiB
JSON
{
|
|
"type": "object",
|
|
"description": "Stream object",
|
|
"required": [
|
|
"id",
|
|
"created_on",
|
|
"modified_on",
|
|
"owner_user_id",
|
|
"incoming_port",
|
|
"forwarding_host",
|
|
"forwarding_port",
|
|
"tcp_forwarding",
|
|
"udp_forwarding",
|
|
"enabled",
|
|
"meta"
|
|
],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"id": {
|
|
"$ref": "../common.json#/properties/id"
|
|
},
|
|
"created_on": {
|
|
"$ref": "../common.json#/properties/created_on"
|
|
},
|
|
"modified_on": {
|
|
"$ref": "../common.json#/properties/modified_on"
|
|
},
|
|
"owner_user_id": {
|
|
"$ref": "../common.json#/properties/user_id"
|
|
},
|
|
"incoming_port": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"maximum": 65535,
|
|
"example": 9090
|
|
},
|
|
"forwarding_host": {
|
|
"anyOf": [
|
|
{
|
|
"description": "Domain Name",
|
|
"type": "string",
|
|
"pattern": "^(?=[^\\s\\p{Cc};{}\"'#\\\\$/]+$)[^.*]+(?:\\.[^.*]+)*\\.?[^.]$",
|
|
"example": "example.com"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"pattern": "^[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}$"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"format": "ipv6"
|
|
}
|
|
],
|
|
"example": "example.com"
|
|
},
|
|
"forwarding_port": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"maximum": 65535,
|
|
"example": 80
|
|
},
|
|
"tcp_forwarding": {
|
|
"type": "boolean",
|
|
"example": true
|
|
},
|
|
"udp_forwarding": {
|
|
"type": "boolean",
|
|
"example": false
|
|
},
|
|
"enabled": {
|
|
"$ref": "../common.json#/properties/enabled"
|
|
},
|
|
"certificate_id": {
|
|
"$ref": "../common.json#/properties/certificate_id"
|
|
},
|
|
"meta": {
|
|
"type": "object",
|
|
"description": "Extra metadata. Keys starting with nginx_ are owned by the server and ignored on input",
|
|
"properties": {
|
|
"nginx_online": {
|
|
"type": "boolean",
|
|
"description": "Server-owned. False only when this host's config is not active in nginx"
|
|
},
|
|
"nginx_err": {
|
|
"type": ["string", "null"],
|
|
"description": "Server-owned. Human readable reason when nginx_online is false"
|
|
},
|
|
"nginx_details": {
|
|
"type": ["object", "null"],
|
|
"description": "Server-owned. Structured details of the failure (same shape as error.details)"
|
|
},
|
|
"nginx_checked_at": {
|
|
"type": "string",
|
|
"description": "Server-owned. ISO timestamp of the last nginx configuration"
|
|
}
|
|
},
|
|
"example": {}
|
|
},
|
|
"certificate": {
|
|
"oneOf": [
|
|
{
|
|
"type": "null"
|
|
},
|
|
{
|
|
"$ref": "./certificate-object.json"
|
|
}
|
|
],
|
|
"example": null
|
|
},
|
|
"owner": {
|
|
"$ref": "./user-object.json"
|
|
}
|
|
}
|
|
}
|