nginx-proxy-manager/backend/schema/endpoints/redirection-hosts.json

306 lines
8.1 KiB
JSON
Raw Normal View History

2018-07-08 21:22:10 -04:00
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "endpoints/redirection-hosts",
2018-07-24 02:56:39 -04:00
"title": "Redirection Hosts",
2018-07-08 21:22:10 -04:00
"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"
},
2018-07-24 02:56:39 -04:00
"domain_names": {
"$ref": "../definitions.json#/definitions/domain_names"
},
"forward_http_code": {
"$ref": "../definitions.json#/definitions/http_code"
},
"forward_scheme": {
"$ref": "../definitions.json#/definitions/scheme"
},
2018-07-24 02:56:39 -04:00
"forward_domain_name": {
"$ref": "../definitions.json#/definitions/domain_name"
},
"preserve_path": {
"description": "Should the path be preserved",
"example": true,
2018-07-08 21:22:10 -04:00
"type": "boolean"
2018-07-24 02:56:39 -04:00
},
"certificate_id": {
"$ref": "../definitions.json#/definitions/certificate_id"
2018-07-24 02:56:39 -04:00
},
"ssl_forced": {
"$ref": "../definitions.json#/definitions/ssl_forced"
},
2019-02-18 03:21:45 -05:00
"hsts_enabled": {
"$ref": "../definitions.json#/definitions/hsts_enabled"
},
"hsts_subdomains": {
"$ref": "../definitions.json#/definitions/hsts_subdomains"
},
"http2_support": {
"$ref": "../definitions.json#/definitions/http2_support"
},
2018-07-24 02:56:39 -04:00
"block_exploits": {
"$ref": "../definitions.json#/definitions/block_exploits"
},
"advanced_config": {
"type": "string"
},
"enabled": {
"$ref": "../definitions.json#/definitions/enabled"
},
2018-07-24 02:56:39 -04:00
"meta": {
"type": "object"
2018-07-24 02:56:39 -04:00
}
},
"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"
},
2018-07-24 02:56:39 -04:00
"forward_domain_name": {
"$ref": "#/definitions/forward_domain_name"
},
"preserve_path": {
"$ref": "#/definitions/preserve_path"
},
"certificate_id": {
"$ref": "#/definitions/certificate_id"
2018-07-24 02:56:39 -04:00
},
"ssl_forced": {
"$ref": "#/definitions/ssl_forced"
},
2019-02-18 03:21:45 -05:00
"hsts_enabled": {
"$ref": "#/definitions/hsts_enabled"
},
"hsts_subdomains": {
"$ref": "#/definitions/hsts_subdomains"
},
"http2_support": {
2018-11-12 06:48:12 -05:00
"$ref": "#/definitions/http2_support"
},
2018-07-24 02:56:39 -04:00
"block_exploits": {
"$ref": "#/definitions/block_exploits"
},
"advanced_config": {
"$ref": "#/definitions/advanced_config"
},
"enabled": {
"$ref": "#/definitions/enabled"
},
2018-07-24 02:56:39 -04:00
"meta": {
"$ref": "#/definitions/meta"
2018-07-08 21:22:10 -04:00
}
},
"links": [
{
"title": "List",
2018-07-24 02:56:39 -04:00
"description": "Returns a list of Redirection Hosts",
"href": "/nginx/redirection-hosts",
2018-07-08 21:22:10 -04:00
"access": "private",
"method": "GET",
"rel": "self",
"http_header": {
"$ref": "../examples.json#/definitions/auth_header"
},
"targetSchema": {
"type": "array",
"items": {
"$ref": "#/properties"
}
}
},
{
"title": "Create",
2018-07-24 02:56:39 -04:00
"description": "Creates a new Redirection Host",
"href": "/nginx/redirection-hosts",
2018-07-08 21:22:10 -04:00
"access": "private",
"method": "POST",
"rel": "create",
"http_header": {
"$ref": "../examples.json#/definitions/auth_header"
},
"schema": {
"type": "object",
2018-07-25 18:23:32 -04:00
"additionalProperties": false,
2018-07-08 21:22:10 -04:00
"required": [
2018-07-24 02:56:39 -04:00
"domain_names",
"forward_scheme",
"forward_http_code",
2018-07-24 02:56:39 -04:00
"forward_domain_name"
2018-07-08 21:22:10 -04:00
],
"properties": {
2018-07-24 02:56:39 -04:00
"domain_names": {
"$ref": "#/definitions/domain_names"
2018-07-08 21:22:10 -04:00
},
"forward_http_code": {
"$ref": "#/definitions/forward_http_code"
},
"forward_scheme": {
"$ref": "#/definitions/forward_scheme"
},
2018-07-24 02:56:39 -04:00
"forward_domain_name": {
"$ref": "#/definitions/forward_domain_name"
2018-07-08 21:22:10 -04:00
},
2018-07-24 02:56:39 -04:00
"preserve_path": {
"$ref": "#/definitions/preserve_path"
2018-07-08 21:22:10 -04:00
},
"certificate_id": {
"$ref": "#/definitions/certificate_id"
2018-07-08 21:22:10 -04:00
},
2018-07-24 02:56:39 -04:00
"ssl_forced": {
"$ref": "#/definitions/ssl_forced"
2018-07-08 21:22:10 -04:00
},
2019-02-18 03:21:45 -05:00
"hsts_enabled": {
"$ref": "#/definitions/hsts_enabled"
},
"hsts_subdomains": {
"$ref": "#/definitions/hsts_enabled"
},
"http2_support": {
"$ref": "#/definitions/http2_support"
},
2018-07-24 02:56:39 -04:00
"block_exploits": {
"$ref": "#/definitions/block_exploits"
},
"advanced_config": {
"$ref": "#/definitions/advanced_config"
},
2018-07-24 02:56:39 -04:00
"meta": {
"$ref": "#/definitions/meta"
2018-07-08 21:22:10 -04:00
}
}
},
"targetSchema": {
"properties": {
"$ref": "#/properties"
}
}
},
{
"title": "Update",
2018-07-24 02:56:39 -04:00
"description": "Updates a existing Redirection Host",
"href": "/nginx/redirection-hosts/{definitions.identity.example}",
2018-07-08 21:22:10 -04:00
"access": "private",
"method": "PUT",
"rel": "update",
"http_header": {
"$ref": "../examples.json#/definitions/auth_header"
},
"schema": {
"type": "object",
2018-07-25 18:23:32 -04:00
"additionalProperties": false,
2018-07-08 21:22:10 -04:00
"properties": {
2018-07-24 02:56:39 -04:00
"domain_names": {
"$ref": "#/definitions/domain_names"
},
"forward_http_code": {
"$ref": "#/definitions/forward_http_code"
},
"forward_scheme": {
"$ref": "#/definitions/forward_scheme"
},
2018-07-24 02:56:39 -04:00
"forward_domain_name": {
"$ref": "#/definitions/forward_domain_name"
2018-07-08 21:22:10 -04:00
},
2018-07-24 02:56:39 -04:00
"preserve_path": {
"$ref": "#/definitions/preserve_path"
2018-07-08 21:22:10 -04:00
},
"certificate_id": {
"$ref": "#/definitions/certificate_id"
2018-07-08 21:22:10 -04:00
},
2018-07-24 02:56:39 -04:00
"ssl_forced": {
"$ref": "#/definitions/ssl_forced"
2018-07-08 21:22:10 -04:00
},
2019-02-18 03:21:45 -05:00
"hsts_enabled": {
"$ref": "#/definitions/hsts_enabled"
},
"hsts_subdomains": {
"$ref": "#/definitions/hsts_enabled"
},
"http2_support": {
"$ref": "#/definitions/http2_support"
},
2018-07-24 02:56:39 -04:00
"block_exploits": {
"$ref": "#/definitions/block_exploits"
},
"advanced_config": {
"$ref": "#/definitions/advanced_config"
},
2018-07-24 02:56:39 -04:00
"meta": {
"$ref": "#/definitions/meta"
2018-07-08 21:22:10 -04:00
}
}
},
"targetSchema": {
"properties": {
"$ref": "#/properties"
}
}
},
{
"title": "Delete",
2018-07-24 02:56:39 -04:00
"description": "Deletes a existing Redirection Host",
"href": "/nginx/redirection-hosts/{definitions.identity.example}",
2018-07-08 21:22:10 -04:00
"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"
}
2018-07-08 21:22:10 -04:00
}
2018-07-24 02:56:39 -04:00
]
2018-07-08 21:22:10 -04:00
}