- URL:
- https://<root>/createNewSite
- Methods:
POST- 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.
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 create 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
| Parameter | Description |
|---|---|
| The name of the administrative account to be used by the site. This can be changed later. Example |
| The credentials of the administrative account. Example |
| Introduced at ArcGIS Enterprise 12.0. A JSON array containing the cloud storage configuration for the deployment's cloud-native object stores. This parameter is only required if ArcGIS Enterprise is deployed in a cloud environment. When providing cloud storage information, administrators do not need to define any configuration store connections ( |
| A JSON object representing the connection to the configuration store. By default, the configuration store is maintained in the ArcGIS Server installation directory. This parameter is only required when deploying ArcGIS Enterprise on Windows and Linux. Example |
| A JSON object representing a collection of server directories to create. By default, the server directories are created locally. This parameter is only required when deploying ArcGIS Enterprise on Windows and Linux. Example |
| Optional log settings. Example |
| A flag that indicates if the operation needs to be run asynchronously. Values: |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the create operation:
POST /<context>/admin/createNewSite HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
username=admin&password=secret&cloudConfigJson=&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