nginx-proxy-manager/backend/schema/components/redirection-host-object.json

{
	"type": "object",
	"description": "Redirection Host object",
	"required": [
		"id",
		"created_on",
		"modified_on",
		"owner_user_id",
		"domain_names",
		"forward_http_code",
		"forward_scheme",
		"forward_domain_name",
		"preserve_path",
		"certificate_id",
		"ssl_forced",
		"hsts_enabled",
		"hsts_subdomains",
		"http2_support",
		"block_exploits",
		"advanced_config",
		"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"
		},
		"domain_names": {
			"$ref": "../common.json#/properties/domain_names"
		},
		"forward_http_code": {
			"description": "Redirect HTTP Status Code",
			"type": "integer",
			"minimum": 300,
			"maximum": 308,
			"example": 302
		},
		"forward_scheme": {
			"type": "string",
			"enum": [
				"auto",
				"http",
				"https"
			],
			"example": "http"
		},
		"forward_domain_name": {
			"description": "Domain Name",
			"type": "string",
			"pattern": "^(?:[^.*]+\\.?)+[^.]$",
			"example": "jc21.com"
		},
		"preserve_path": {
			"description": "Should the path be preserved",
			"type": "boolean",
			"example": true
		},
		"certificate_id": {
			"$ref": "../common.json#/properties/certificate_id"
		},
		"ssl_forced": {
			"$ref": "../common.json#/properties/ssl_forced"
		},
		"hsts_enabled": {
			"$ref": "../common.json#/properties/hsts_enabled"
		},
		"hsts_subdomains": {
			"$ref": "../common.json#/properties/hsts_subdomains"
		},
		"http2_support": {
			"$ref": "../common.json#/properties/http2_support"
		},
		"block_exploits": {
			"$ref": "../common.json#/properties/block_exploits"
		},
		"advanced_config": {
			"type": "string",
			"example": ""
		},
		"enabled": {
			"$ref": "../common.json#/properties/enabled"
		},
		"meta": {
			"type": "object",
			"example": {
				"nginx_online": true,
				"nginx_err": null
			}
		},
		"certificate": {
			"oneOf": [
				{
					"type": "null",
					"example": null
				},
				{
					"$ref": "./certificate-object.json"
				}
			],
			"example": null
		},
		"owner": {
			"$ref": "./user-object.json"
		}
	}
}