put.json 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  1. {
  2. "operationId": "updateProxyHost",
  3. "summary": "Update a Proxy Host",
  4. "tags": ["proxy-hosts"],
  5. "security": [
  6. {
  7. "bearerAuth": [
  8. "proxy_hosts.manage"
  9. ]
  10. }
  11. ],
  12. "parameters": [
  13. {
  14. "in": "path",
  15. "name": "hostID",
  16. "description": "The ID of the Proxy Host",
  17. "schema": {
  18. "type": "integer",
  19. "minimum": 1
  20. },
  21. "required": true,
  22. "example": 2
  23. }
  24. ],
  25. "requestBody": {
  26. "description": "Proxy Host Payload",
  27. "required": true,
  28. "content": {
  29. "application/json": {
  30. "schema": {
  31. "type": "object",
  32. "additionalProperties": false,
  33. "minProperties": 1,
  34. "properties": {
  35. "domain_names": {
  36. "$ref": "../../../../components/proxy-host-object.json#/properties/domain_names"
  37. },
  38. "forward_scheme": {
  39. "$ref": "../../../../components/proxy-host-object.json#/properties/forward_scheme"
  40. },
  41. "forward_host": {
  42. "$ref": "../../../../components/proxy-host-object.json#/properties/forward_host"
  43. },
  44. "forward_port": {
  45. "$ref": "../../../../components/proxy-host-object.json#/properties/forward_port"
  46. },
  47. "certificate_id": {
  48. "$ref": "../../../../components/proxy-host-object.json#/properties/certificate_id"
  49. },
  50. "ssl_forced": {
  51. "$ref": "../../../../components/proxy-host-object.json#/properties/ssl_forced"
  52. },
  53. "hsts_enabled": {
  54. "$ref": "../../../../components/proxy-host-object.json#/properties/hsts_enabled"
  55. },
  56. "hsts_subdomains": {
  57. "$ref": "../../../../components/proxy-host-object.json#/properties/hsts_subdomains"
  58. },
  59. "trust_forwarded_proto": {
  60. "$ref": "../../../../components/proxy-host-object.json#/properties/trust_forwarded_proto"
  61. },
  62. "http2_support": {
  63. "$ref": "../../../../components/proxy-host-object.json#/properties/http2_support"
  64. },
  65. "block_exploits": {
  66. "$ref": "../../../../components/proxy-host-object.json#/properties/block_exploits"
  67. },
  68. "caching_enabled": {
  69. "$ref": "../../../../components/proxy-host-object.json#/properties/caching_enabled"
  70. },
  71. "allow_websocket_upgrade": {
  72. "$ref": "../../../../components/proxy-host-object.json#/properties/allow_websocket_upgrade"
  73. },
  74. "access_list_id": {
  75. "$ref": "../../../../components/proxy-host-object.json#/properties/access_list_id"
  76. },
  77. "advanced_config": {
  78. "$ref": "../../../../components/proxy-host-object.json#/properties/advanced_config"
  79. },
  80. "enabled": {
  81. "$ref": "../../../../components/proxy-host-object.json#/properties/enabled"
  82. },
  83. "meta": {
  84. "$ref": "../../../../components/proxy-host-object.json#/properties/meta"
  85. },
  86. "locations": {
  87. "$ref": "../../../../components/proxy-host-object.json#/properties/locations"
  88. }
  89. }
  90. }
  91. }
  92. }
  93. },
  94. "responses": {
  95. "200": {
  96. "description": "200 response",
  97. "content": {
  98. "application/json": {
  99. "examples": {
  100. "default": {
  101. "value": {
  102. "id": 3,
  103. "created_on": "2025-10-30T01:12:05.000Z",
  104. "modified_on": "2025-10-30T01:17:06.000Z",
  105. "owner_user_id": 1,
  106. "domain_names": [
  107. "test.example.com"
  108. ],
  109. "forward_host": "127.0.0.1",
  110. "forward_port": 8080,
  111. "access_list_id": 0,
  112. "certificate_id": 0,
  113. "ssl_forced": false,
  114. "caching_enabled": false,
  115. "block_exploits": false,
  116. "advanced_config": "",
  117. "meta": {
  118. "nginx_online": true,
  119. "nginx_err": null
  120. },
  121. "allow_websocket_upgrade": false,
  122. "http2_support": false,
  123. "forward_scheme": "http",
  124. "enabled": true,
  125. "locations": [],
  126. "hsts_enabled": false,
  127. "hsts_subdomains": false,
  128. "trust_forwarded_proto": false,
  129. "owner": {
  130. "id": 1,
  131. "created_on": "2025-10-28T00:50:24.000Z",
  132. "modified_on": "2025-10-28T00:50:24.000Z",
  133. "is_disabled": false,
  134. "email": "[email protected]",
  135. "name": "jamiec",
  136. "nickname": "jamiec",
  137. "avatar": "//www.gravatar.com/avatar/6193176330f8d38747f038c170ddb193?default=mm",
  138. "roles": [
  139. "admin"
  140. ]
  141. },
  142. "certificate": null,
  143. "access_list": null
  144. }
  145. }
  146. },
  147. "schema": {
  148. "$ref": "../../../../components/proxy-host-object.json"
  149. }
  150. }
  151. }
  152. }
  153. }
  154. }