GeoServer UrlCheck
An URL External Access Check is the check performed on user provided URLs that GeoServer will use to access remote resources.
Version: 1.0.0
BasePath:/geoserver/rest
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
delete /urlchecks/{urlcheckname}
(deleteUrlCheck)
Path parameters
urlcheckname (required)
Path Parameter — name of URL check to delete.
Responses
200
Successfully deleted URL check
404
Url check doesn't exist
(deleteUrlChecks)
Not permitted.
Responses
405
Not permitted
Up
get /urlchecks/{urlcheckname}
Retrieve a URL check (getUrlCheck)
Retrieves a single URL check definition. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/urlchecks/{urlcheck}.xml" for XML).
Path parameters
urlcheckname (required)
Path Parameter — the name of the URL check to fetch.
Return type
Example data
Content-Type: application/xml
"\n \n icons\n \n \n\n"
Example data
Content-Type: application/json
"{\n \"urlCheck\": {\n \"name\": \"icons\",\n \"description\": \"External graphic icons\",\n \"enabled\": true,\n \"regex\": \"^https://styles.server.net/icons/.*$\"\n }\n}\n"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/xml
application/json
text/html
Responses
200
OK
urlCheck
Example data
Content-Type: application/xml
icons
Example data
Content-Type: application/json
{
"urlCheck": {
"name": "icons",
"description": "External graphic icons",
"enabled": true,
"regex": "^https://styles.server.net/icons/.*$"
}
}
404
URL check does not exist
Get a list of URL checks (getUrlChecks)
Displays a list of all URL checks on the server. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/urlchecks.xml" for XML)
Return type
Example data
Content-Type: text/html
"\n \n GeoServer Configuration\n \n \n \n \n \n\n"
Example data
Content-Type: application/xml
"\n \n external\n \n \n \n icons\n \n \n \n safeWFS\n \n \n\n"
Example data
Content-Type: application/json
"{\"urlchecks\":{\"urlcheck\":[\n {\"name\":\"external\",\"href\":\"http:\\/\\/localhost:8080\\/geoserver\\/rest\\/urlchecks\\/external.json\"},\n {\"name\":\"icons\",\"href\":\"http:\\/\\/localhost:8080\\/geoserver\\/rest\\/urlchecks\\/icons.json\"},\n {\"name\":\"safeWFS\",\"href\":\"http:\\/\\/localhost:8080\\/geoserver\\/rest\\/urlchecks\\/safeWFS.json\"}]}}\n"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/html
application/json
application/xml
Responses
200
OK
urlChecks
Example data
Content-Type: text/html
GeoServer Configuration
Example data
Content-Type: application/xml
external
icons
safeWFS
Example data
Content-Type: application/json
{"urlchecks":{"urlcheck":[
{"name":"external","href":"http:\/\/localhost:8080\/geoserver\/rest\/urlchecks\/external.json"},
{"name":"icons","href":"http:\/\/localhost:8080\/geoserver\/rest\/urlchecks\/icons.json"},
{"name":"safeWFS","href":"http:\/\/localhost:8080\/geoserver\/rest\/urlchecks\/safeWFS.json"}]}}
401
Unauthorized
Up
post /urlchecks/{urlcheckname}
(postUrlCheck)
Not permitted.
Path parameters
urlcheckname (required)
Path Parameter — the name of the URL check to fetch.
Responses
405
Not permitted
add a new URL check to GeoServer (postUrlChecks)
Adds a new URL check to the server
Consumes
This API call consumes the following media types via the request header:
application/json
application/xml
Request body
Body Parameter — The url check body to upload.
Return type
String
Example data
Content-Type: application/json
""
Example data
Content-Type: application/xml
aeiou
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
text/html
application/json
application/xml
Responses
201
Created
String
400
Unable to add provided URL check as it misses required fields
409
Unable to add URL check as it already exists
Up
put /urlchecks/{urlcheckname}
Update a URL check (putUrlCheck)
Changes the URL check with the provided data.
Path parameters
urlcheckname (required)
Path Parameter — name of URL check.
Consumes
This API call consumes the following media types via the request header:
application/json
application/xml
Request body
Body Parameter — The url check body to perform the change against.
Responses
200
Modified
400
Cannot perform the change to the URL check as required fields are missing
404
Url check not found
(putUrlChecks)
Not permitted.
Responses
405
Not permitted
[ Jump to Methods ]
Table of Contents
urlCheck
-
urlChecks
-
The body for a URL check request.
For a PUT, only values which should be changed need to be included.
JSON or XML style requests should follow the schemas below:
-
application/xml:
<regexUrlCheck>
<name>string</name>
<description>string</description>
<enabled>false</enabled>
<regex>string</regex>
</regexUrlCheck>
-
application/json:
{
"regexUrlCheck": {
"name": "string",
"description": "string",
"enabled": false,
"regex": "string"
}
}
name
description (optional)
String description for the URL check
enabled (optional)
Boolean enabled status of the URL check
regex
String regex to perform the check with