urlchecks.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. .. _rest_api_urlchecks:
  2. URL Checks
  3. ==========
  4. An ``URL External Access Check`` is the check performed on user provided URLs that GeoServer will use to access remote resources.
  5. ``/urlchecks[.<format>]``
  6. --------------------------
  7. Returns all url checks.
  8. .. list-table::
  9. :header-rows: 1
  10. * - Method
  11. - Action
  12. - Status code
  13. - Formats
  14. - Default Format
  15. * - GET
  16. - List all url checks
  17. - 200
  18. - HTML, XML, JSON
  19. - JSON
  20. * - POST
  21. - Create a new url check
  22. - 201 with ``Location`` header
  23. - XML, JSON
  24. -
  25. * - PUT
  26. -
  27. - 405
  28. -
  29. -
  30. * - DELETE
  31. -
  32. - 405
  33. -
  34. -
  35. ``/urlchecks/<uc>[.<format>]``
  36. -------------------------------
  37. Returns a specific url check.
  38. .. list-table::
  39. :header-rows: 1
  40. * - Method
  41. - Action
  42. - Status code
  43. - Formats
  44. - Default Format
  45. - Parameters
  46. * - GET
  47. - Return url check ``uc``
  48. - 200
  49. - HTML, XML, JSON
  50. - JSON
  51. -
  52. * - POST
  53. -
  54. - 405
  55. -
  56. -
  57. -
  58. * - PUT
  59. - 200
  60. - Modify url check ``uc``
  61. - XML, JSON
  62. -
  63. -
  64. * - DELETE
  65. - 200
  66. - Delete url check ``uc``
  67. - XML, JSON
  68. -
  69. -
  70. Exceptions
  71. ~~~~~~~~~~
  72. .. list-table::
  73. :header-rows: 1
  74. * - Exception
  75. - Status code
  76. * - POST or PUT for a url check missing required fields
  77. - 401
  78. * - GET or DELETE for a url check that does not exist
  79. - 404
  80. * - POST for a url check that already exists
  81. - 409