- URL:
- https://<root>/services
- Methods:
GET- Operations:
- Can Create Service, Create Folder, Create Service, Delete Services, Edit Folder, Exists, Export Services, Federate, Import Services, Rename Service, Start Services, Stop Services, Unfederate
- Child Resources:
- Report, Permissions, Types, Folders, Service, Properties, Webhooks
- Version Introduced:
- 10.1
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 generate 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.
Description
The services resource acts as the root folder and container for all subfolders and GIS services. You can create a new subfolder by using the Create Folder operation and a new GIS service by using the Create Service operation.
Request parameters
| Parameter | Description |
|---|---|
| Indicates that a detailed description is expected. The default value is Values: |
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL used to access the services resource:
https://organization.example.com/<context>/admin/services?detail=true&f=pjsonJSON Response syntax
{
"folderName": "/",
"description": "Root folder",
"webEncrypted": <webEncrypted>,
"isDefault": <isDefault>,
"folders": [
"<folderName1>",
"<folderName2>"
],
"foldersDetail": [
{
"folderName": "<folderName>",
"description": "<description>",
"webEncrypted": <webEncrypted>,
"isDefault": <isDefault>
}
],
"services": [
{
"folderName": "<folderName>",
"serviceName": "<serviceName>",
"type": "<serviceType>",
"description": "<description>"
}
]
}The full name of a service is represented in JSON as follows
{
"folderName”: <folderName>,
"serviceName”: <name>,
"serviceType”: <type>,
"description”: <description>
}JSON Response example
{
"folderName": "/",
"description": "Root folder",
"webEncrypted": false,
"isDefault": false,
"folders": [
"System",
"Utilities"
],
"foldersDetail": [
{
"folderName": "System",
"description": "The System folder contains automatically deployed services that are used by ArcGIS Server.",
"webEncrypted": false,
"isDefault": true
},
{
"folderName": "Utilities",
"description": "The Utilities folder contains automatically deployed services that can be used by application developers.",
"webEncrypted": false,
"isDefault": true
}
],
"services": [
{
"folderName": "/",
"serviceName": "SampleWorldCities",
"type": "MapServer",
"description": "The SampleWorldCities service is provided so you can quickly and easily preview the
functionality of the GIS server. Click the thumbnail image to open in a web application.
This sample service is optional and can be deleted."
}
]
}