Create Site

URL:
https://<root>/createNewSite
Methods:
POST
Required Capability:
Access allowed only with the default administrator role
Version Introduced:
10.1

Description

The createNewSite operation is the first operation that you must invoke when you install ArcGIS Server for the first time. Creating a new site involves the following:

  • Allocating a store to save the site configuration
  • Configuring the server machine and registering it with the site
  • Configuring server directories
  • Deploying the services that are marked to automatically deploy

Because of the number of tasks, it usually takes awhile for this operation to complete. Once a site has been created, you can publish GIS services and deploy them to your server machines.

Request parameters

ParameterDescription

username

The name of the administrative account to be used by the site. This can be changed later.

Example
1
username=admin

password

The credentials of the administrative account.

Example
1
password=secret

configStoreConnection

A JSON object representing the connection to the configuration store. By default, the configuration store is maintained in the ArcGIS Server installation directory.

Example
1
2
3
4
5
configStoreConnection={
  "type"="FILESYSTEM",
  "connectionString": "\\myshare\config-store",
  "localRepositoryPath": "C:\\arcgisserver\\local"
}

directories

A JSON object representing a collection of server directories to create. By default, the server directories are created locally.

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
directories={
  "directories": [
    {
      "name": "arcgiscache",
      "physicalPath": "C:\\arcgisserver\\directories\\arcgiscache",
      "directoryType": "CACHE",
      "cleanupMode": "NONE",
      "maxFileAge": 0,
      "description": "Stores tile caches used by map, globe, and image services for rapid performance"
    },
    ...
  ]
}

settings

Optional log settings.

Example
1
2
3
4
5
6
settings={
  "logLevel": "INFO",
  "logDir": "C:\\arcgisserver\\logs\\",
  "maxErrorReportsCount": 10,
  "maxLogFileAge": 90
}

runAsync

A flag that indicates if the operation needs to be run asynchronously.

Values: true | false

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 createSite operation:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
POST /arcgis/admin/createNewSite HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

username=admin&password=secret&configStoreConnection={
  "type"="FILESYSTEM",
  "connectionString": "\\myshare\config-store",
  "localRepositoryPath": "C:\\arcgisserver\\local"
}&directories={
  "directories": [
    {
      "name": "arcgiscache",
      "physicalPath": "C:\\arcgisserver\\directories\\arcgiscache",
      "directoryType": "CACHE",
      "cleanupMode": "NONE",
      "maxFileAge": 0,
      "description": "Stores tile caches used by map, globe, and image services for rapid performance"
    },
    {
      "name": "arcgisjobs",
      "physicalPath": "C:\\arcgisserver\\directories\\arcgisjobs",
      "directoryType": "JOBS",
      "cleanupMode": "TIME_ELAPSED_SINCE_LAST_MODIFIED",
      "maxFileAge": 360,
      "description": "Stores results and other information from geoprocessing services"
    },
    {
      "name": "arcgisoutput",
      "physicalPath": "C:\\arcgisserver\\directories\\arcgisoutput",
      "directoryType": "OUTPUT",
      "cleanupMode": "TIME_ELAPSED_SINCE_LAST_MODIFIED",
      "maxFileAge": 10,
      "description": "Stores various information generated by services, such as map images"
    },
    {
      "name": "arcgissystem",
      "physicalPath": "C:\\arcgisserver\\directories\\arcgissystem",
      "directoryType": "SYSTEM",
      "cleanupMode": "NONE",
      "maxFileAge": 0,
      "description": "Stores directories and files used internally by ArcGIS Server"
    }
  ]
}&settings={
  "logLevel": "INFO",
  "logDir": "C:\\arcgisserver\\logs\\",
  "maxErrorReportsCount": 10,
  "maxLogFileAge": 90
}&runAsync=true&f=json

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close