nginx-proxy-manager/src/backend/schema/endpoints/dead-hosts.json

181 lines
4.3 KiB
JSON
Raw Normal View History

2018-07-08 21:22:10 -04:00
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "endpoints/dead-hosts",
2018-07-25 18:23:32 -04:00
"title": "404 Hosts",
"description": "Endpoints relating to 404 Hosts",
2018-07-08 21:22:10 -04:00
"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-25 18:23:32 -04:00
"domain_names": {
"$ref": "../definitions.json#/definitions/domain_names"
},
"ssl_enabled": {
"$ref": "../definitions.json#/definitions/ssl_enabled"
},
"ssl_forced": {
"$ref": "../definitions.json#/definitions/ssl_forced"
},
"ssl_provider": {
"$ref": "../definitions.json#/definitions/ssl_provider"
},
"meta": {
"type": "object",
"additionalProperties": false,
"properties": {
"letsencrypt_email": {
"type": "string",
"format": "email"
},
"letsencrypt_agree": {
"type": "boolean"
}
}
}
},
"properties": {
"id": {
"$ref": "#/definitions/id"
},
"created_on": {
"$ref": "#/definitions/created_on"
},
"modified_on": {
"$ref": "#/definitions/modified_on"
},
"domain_names": {
"$ref": "#/definitions/domain_names"
},
"ssl_enabled": {
"$ref": "#/definitions/ssl_enabled"
},
"ssl_forced": {
"$ref": "#/definitions/ssl_forced"
},
"ssl_provider": {
"$ref": "#/definitions/ssl_provider"
},
"meta": {
"$ref": "#/definitions/meta"
2018-07-08 21:22:10 -04:00
}
},
"links": [
{
"title": "List",
2018-07-25 18:23:32 -04:00
"description": "Returns a list of 404 Hosts",
"href": "/nginx/dead-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-25 18:23:32 -04:00
"description": "Creates a new 404 Host",
"href": "/nginx/dead-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-25 18:23:32 -04:00
"domain_names"
2018-07-08 21:22:10 -04:00
],
"properties": {
2018-07-25 18:23:32 -04:00
"domain_names": {
"$ref": "#/definitions/domain_names"
2018-07-08 21:22:10 -04:00
},
2018-07-25 18:23:32 -04:00
"ssl_enabled": {
"$ref": "#/definitions/ssl_enabled"
2018-07-08 21:22:10 -04:00
},
2018-07-25 18:23:32 -04:00
"ssl_forced": {
"$ref": "#/definitions/ssl_forced"
2018-07-08 21:22:10 -04:00
},
2018-07-25 18:23:32 -04:00
"ssl_provider": {
"$ref": "#/definitions/ssl_provider"
2018-07-08 21:22:10 -04:00
},
2018-07-25 18:23:32 -04:00
"meta": {
"$ref": "#/definitions/meta"
2018-07-08 21:22:10 -04:00
}
}
},
"targetSchema": {
"properties": {
"$ref": "#/properties"
}
}
},
{
"title": "Update",
2018-07-25 18:23:32 -04:00
"description": "Updates a existing 404 Host",
"href": "/nginx/dead-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-25 18:23:32 -04:00
"domain_names": {
"$ref": "#/definitions/domain_names"
2018-07-08 21:22:10 -04:00
},
2018-07-25 18:23:32 -04:00
"ssl_enabled": {
"$ref": "#/definitions/ssl_enabled"
2018-07-08 21:22:10 -04:00
},
2018-07-25 18:23:32 -04:00
"ssl_forced": {
"$ref": "#/definitions/ssl_forced"
2018-07-08 21:22:10 -04:00
},
2018-07-25 18:23:32 -04:00
"ssl_provider": {
"$ref": "#/definitions/ssl_provider"
2018-07-08 21:22:10 -04:00
},
2018-07-25 18:23:32 -04:00
"meta": {
"$ref": "#/definitions/meta"
2018-07-08 21:22:10 -04:00
}
}
},
"targetSchema": {
"properties": {
"$ref": "#/properties"
}
}
},
{
"title": "Delete",
2018-07-25 18:23:32 -04:00
"description": "Deletes a existing 404 Host",
"href": "/nginx/dead-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"
}
}
2018-07-25 18:23:32 -04:00
]
2018-07-08 21:22:10 -04:00
}