{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "endpoints/redirection-hosts", "title": "Redirection Hosts", "description": "Endpoints relating to Redirection Hosts", "stability": "stable", "type": "object", "definitions": { "id": { "$ref": "../definitions.json#/definitions/id" }, "created_on": { "$ref": "../definitions.json#/definitions/created_on" }, "modified_on": { "$ref": "../definitions.json#/definitions/modified_on" }, "domain_names": { "$ref": "../definitions.json#/definitions/domain_names" }, "forward_http_code": { "$ref": "../definitions.json#/definitions/http_code" }, "forward_scheme": { "$ref": "../definitions.json#/definitions/scheme" }, "forward_domain_name": { "$ref": "../definitions.json#/definitions/domain_name" }, "preserve_path": { "description": "Should the path be preserved", "example": true, "type": "boolean" }, "certificate_id": { "$ref": "../definitions.json#/definitions/certificate_id" }, "ssl_forced": { "$ref": "../definitions.json#/definitions/ssl_forced" }, "hsts_enabled": { "$ref": "../definitions.json#/definitions/hsts_enabled" }, "hsts_subdomains": { "$ref": "../definitions.json#/definitions/hsts_subdomains" }, "http2_support": { "$ref": "../definitions.json#/definitions/http2_support" }, "block_exploits": { "$ref": "../definitions.json#/definitions/block_exploits" }, "advanced_config": { "type": "string" }, "enabled": { "$ref": "../definitions.json#/definitions/enabled" }, "meta": { "type": "object" } }, "properties": { "id": { "$ref": "#/definitions/id" }, "created_on": { "$ref": "#/definitions/created_on" }, "modified_on": { "$ref": "#/definitions/modified_on" }, "domain_names": { "$ref": "#/definitions/domain_names" }, "forward_http_code": { "$ref": "#/definitions/forward_http_code" }, "forward_scheme": { "$ref": "#/definitions/forward_scheme" }, "forward_domain_name": { "$ref": "#/definitions/forward_domain_name" }, "preserve_path": { "$ref": "#/definitions/preserve_path" }, "certificate_id": { "$ref": "#/definitions/certificate_id" }, "ssl_forced": { "$ref": "#/definitions/ssl_forced" }, "hsts_enabled": { "$ref": "#/definitions/hsts_enabled" }, "hsts_subdomains": { "$ref": "#/definitions/hsts_subdomains" }, "http2_support": { "$ref": "#/definitions/http2_support" }, "block_exploits": { "$ref": "#/definitions/block_exploits" }, "advanced_config": { "$ref": "#/definitions/advanced_config" }, "enabled": { "$ref": "#/definitions/enabled" }, "meta": { "$ref": "#/definitions/meta" } }, "links": [ { "title": "List", "description": "Returns a list of Redirection Hosts", "href": "/nginx/redirection-hosts", "access": "private", "method": "GET", "rel": "self", "http_header": { "$ref": "../examples.json#/definitions/auth_header" }, "targetSchema": { "type": "array", "items": { "$ref": "#/properties" } } }, { "title": "Create", "description": "Creates a new Redirection Host", "href": "/nginx/redirection-hosts", "access": "private", "method": "POST", "rel": "create", "http_header": { "$ref": "../examples.json#/definitions/auth_header" }, "schema": { "type": "object", "additionalProperties": false, "required": [ "domain_names", "forward_scheme", "forward_http_code", "forward_domain_name" ], "properties": { "domain_names": { "$ref": "#/definitions/domain_names" }, "forward_http_code": { "$ref": "#/definitions/forward_http_code" }, "forward_scheme": { "$ref": "#/definitions/forward_scheme" }, "forward_domain_name": { "$ref": "#/definitions/forward_domain_name" }, "preserve_path": { "$ref": "#/definitions/preserve_path" }, "certificate_id": { "$ref": "#/definitions/certificate_id" }, "ssl_forced": { "$ref": "#/definitions/ssl_forced" }, "hsts_enabled": { "$ref": "#/definitions/hsts_enabled" }, "hsts_subdomains": { "$ref": "#/definitions/hsts_enabled" }, "http2_support": { "$ref": "#/definitions/http2_support" }, "block_exploits": { "$ref": "#/definitions/block_exploits" }, "advanced_config": { "$ref": "#/definitions/advanced_config" }, "meta": { "$ref": "#/definitions/meta" } } }, "targetSchema": { "properties": { "$ref": "#/properties" } } }, { "title": "Update", "description": "Updates a existing Redirection Host", "href": "/nginx/redirection-hosts/{definitions.identity.example}", "access": "private", "method": "PUT", "rel": "update", "http_header": { "$ref": "../examples.json#/definitions/auth_header" }, "schema": { "type": "object", "additionalProperties": false, "properties": { "domain_names": { "$ref": "#/definitions/domain_names" }, "forward_http_code": { "$ref": "#/definitions/forward_http_code" }, "forward_scheme": { "$ref": "#/definitions/forward_scheme" }, "forward_domain_name": { "$ref": "#/definitions/forward_domain_name" }, "preserve_path": { "$ref": "#/definitions/preserve_path" }, "certificate_id": { "$ref": "#/definitions/certificate_id" }, "ssl_forced": { "$ref": "#/definitions/ssl_forced" }, "hsts_enabled": { "$ref": "#/definitions/hsts_enabled" }, "hsts_subdomains": { "$ref": "#/definitions/hsts_enabled" }, "http2_support": { "$ref": "#/definitions/http2_support" }, "block_exploits": { "$ref": "#/definitions/block_exploits" }, "advanced_config": { "$ref": "#/definitions/advanced_config" }, "meta": { "$ref": "#/definitions/meta" } } }, "targetSchema": { "properties": { "$ref": "#/properties" } } }, { "title": "Delete", "description": "Deletes a existing Redirection Host", "href": "/nginx/redirection-hosts/{definitions.identity.example}", "access": "private", "method": "DELETE", "rel": "delete", "http_header": { "$ref": "../examples.json#/definitions/auth_header" }, "targetSchema": { "type": "boolean" } }, { "title": "Enable", "description": "Enables a existing Redirection Host", "href": "/nginx/redirection-hosts/{definitions.identity.example}/enable", "access": "private", "method": "POST", "rel": "update", "http_header": { "$ref": "../examples.json#/definitions/auth_header" }, "targetSchema": { "type": "boolean" } }, { "title": "Disable", "description": "Disables a existing Redirection Host", "href": "/nginx/redirection-hosts/{definitions.identity.example}/disable", "access": "private", "method": "POST", "rel": "update", "http_header": { "$ref": "../examples.json#/definitions/auth_header" }, "targetSchema": { "type": "boolean" } } ] }