Skip To Content
ArcGIS Developers
Dashboard

Edit Services Directory

Description

With this operation you can enable or disable the HTML view of ArcGIS REST API (also known as the Services Directory). You can also adjust the JavaScript and Map Viewer previews of services in the Services Directory so that they work with your own locally hosted JavaScript API and Map Viewer.

Note:

When the Services Directory is disabled, the HTML view is not accessible. However, the ArcGIS REST API is still available.

Request parameters

ParameterDetails
allowedOrigins

Comma-separated list of URLs of domains allowed to make requests. * can be used to denote all domains.

Example

allowedOrigins=*
arcgis.com.map

The URL to use for the preview link to open Map Viewer. The defaults URL is to ArcGIS Online's Map Viewer but could be used to point at your ArcGIS Enterprise portal's Map Viewer.

Example

arcgis.com.map=http://www.arcgis.com/home/webmap/viewer.html
arcgis.com.map.text

The text to use for the preview link that opens Map Viewer.

Example

arcgis.com.map.text=ArcGIS Online Map Viewer
jsapi.arcgis

The URL of the JavaScript API to use for service previews. Defaults to the online ArcGIS API for JavaScript, but could be pointed at your own locally-installed instance of the JavaScript API.

Note:

As of 10.6.x, when specifying the ArcGIS API for JavaScript version, it must be from the 4.x release.

Example

jsapi.arcgis=https://js.arcgis.com/4.11/
jsapi.arcgis.css

CSS file associated with the ArcGIS API for JavaScript. Defaults to the online Dojo tundra.css.

Note:

As of 10.6.x, when specifying the ArcGIS API for JavaScript version, it must be from the 4.x release.

Example

jsapi.arcgis.css=https://js.arcgis.com/4.11/esri/css/main.css
jsapi.arcgis.css2

Additional CSS file associated with the ArcGIS API for JavaScript. Defaults to the online esri.css.

Note:

Applicable prior to 10.6.x.

jsapi.arcgis.sdk

URL of the ArcGIS API for JavaScript help.

Example

jsapi.arcgis.sdk=https://help.arcgis.com/en/webapi/javascript/arcgis/
servicesDirEnabled

Flag to enable/disable the HTML view of the services directory.

Values: true | false

f

The response format. The default response format is html.

Values: html | json| pjson

Example usage

Below is a sample POST request for edit:

POST /webadaptor/admin/system/handlers/rest/servicesdirectory/edit HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

allowedOrigins=*&jsapi.arcgis=https://js.arcgis.com/4.11/&jsapi.arcgis.sdk=http://help.arcgis.com/en/webapi/javascript/arcgis/&jsapi.arcgis.css=https://js.arcgis.com/4.11/esri/css/main.css&arcgis.com.map.text=ArcGIS Online Map Viewer&arcgis.com.map=https://www.arcgis.com/home/webmap/viewer.html&f=json

JSON Response example

{"status": "success"}