Skip to content
URL:
https://<root>/services/exists
Methods:
POST

Access requirements

Required privileges

The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.



Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.


Learn how to generate a token

Description

The exists operation checks if a folder or service already exists on the server.

Request parameters

ParameterDetails

folderName

The name of the folder.

Example
Use dark colors for code blocksCopy
1
folderName=Maps

serviceName

The name of the service.

Example
Use dark colors for code blocksCopy
1
serviceName=Test

type

The type of the service.

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the exists operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /<context>/admin/services/exists HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

folderName=Maps&serviceName=Test&type=MapServer&f=json

JSON Response example

Use dark colors for code blocksCopy
1
{"exists": true}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.