URL:
https://<root>/createNewSite
Methods:
POST
Version Introduced:
12.1

Description

The createNewSite operation is the first operation that you must invoke after installing ArcGIS Velocity for the first time. You can only run this operation when the machine is not participating in a site. This operation creates a new ArcGIS Velocity site, including the Primary Site Administrator (PSA) account.

Creating a site involves the following tasks:

  • Allocate a store to save the site configuration.
  • Configure the ArcGIS Velocity content and log directories.
  • Create the primary site administrator user.
  • Configure server directories.

It may take a few seconds for this operation to complete.

Request parameters

ParameterDetails

username

(Required)

The name of the administrative account to be used by this site.

Example

Use dark colors for code blocksCopy
1
username=admin

password

(Required)

The credential for the administrative account.

Example

Use dark colors for code blocksCopy
1
password=secret

externalHostname

(Optional)

The externally reachable hostname (or IP) for this Velocity machine.

Example

Use dark colors for code blocksCopy
1
externalHostname=organization.example.com

logsSettings

(Optional)

A JSON object representing the log settings for the newly created site.

Example

Use dark colors for code blocksCopy
1
2
3
4
{
  "level": "VERBOSE",
  "logDir": "C:\\Program Files\\ArcGIS\\Velocity\\data\\logs-root"
}

runAsync

(Optional)

A flag that indicates whether the operation should run asynchronously.

Value: false

configStoreConnection

(Optional)

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

Syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "configStoreConnection": {
    "connectionString": "\\\\myshare\\config-store",
    "configPersistenceType": "FILESYSTEM"
  }
}

Example

Use dark colors for code blocksCopy
1
2
3
4
{
  "connectionString": "C:\\Program Files\\ArcGIS\\Velocity\\data\\config-root",
  "configPersistenceType": "FILESYSTEM"
}

directories

(Optional)

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

Example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
[

  {
    "name": "arcgisoutput",
    "path": "C:\\Program Files\\ArcGIS\\Velocity\\data\\config-root\\server-dirs\\output",
    "type": "OUTPUT"
  },
  {
    "name": "arcgissystem",
    "path": "C:\\Program Files\\ArcGIS\\Velocity\\data\\config-root\\server-dirs\\system",
    "type": "SYSTEM"
  },
  {
    "name": "arcgisjobs",
    "path": "C:\\Program Files\\ArcGIS\\Velocity\\data\\config-root\\server-dirs\\jobs",
    "type": "JOBS"
  },
  {
    "name": "configbackups",
    "path": "C:\\Program Files\\ArcGIS\\Velocity\\config-backups",
    "type": "SYSTEM"
  }
]

recoveryCodesFile

(Optional)

Specifies a recovery codes file. This recovery codes file is used to generate a unique set of invariants, which are joined together to create an encryption key used by ArcGIS Velocity. If this parameter is not specified, a new recovery codes file will be randomly generated and stored in the /framework/etc folder.

f

(Optional)

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the createNewSite operation on Linux:

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

username=velocityadmin&password=secret&runAsync=false&externalHostname=organization.esri.com&logsSettings={"level":"INFO","logDir":"/home/linux/app_root/arcgis/velocity/data/logs-root"}&configStoreConnection={"connectionString":"/home/linux/app_root/arcgis/velocity/data/config-root","configPersistenceType":"FILESYSTEM"}&directories=[{"name":"arcgisoutput","path":"/home/linux/app_root/arcgis/velocity/data/config-root/server-dirs/output","type":"OUTPUT"},{"name":"arcgissystem","path":"/home/linux/app_root/arcgis/velocity/data/config-root/server-dirs/system","type":"SYSTEM"},{"name":"arcgisjobs","path":"/home/linux/app_root/arcgis/velocity/data/config-root/server-dirs/jobs","type":"JOBS"},{"name":"configbackups","path":"/home/linux/app_root/arcgis/velocity/config-backups","type":"SYSTEM"}]

The following is a sample POST request for the createNewSite operation on Windows:

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

username=velocityadmin&password=secret&runAsync=false&externalHostname=organization.example.com&logsSettings={"level":"INFO","logDir":"C:\\Program Files\\ArcGIS\\Velocity\\data\\logs-root"}&configStoreConnection={"connectionString":"C:\\Program Files\\ArcGIS\\Velocity\\data\\config-root","configPersistenceType":"FILESYSTEM"}&directories=[{"name":"arcgisoutput","path":"C:\\Program Files\\ArcGIS\\Velocity\\data\\config-root\\server-dirs\\output","type":"OUTPUT"},{"name":"arcgissystem","path":"C:\\Program Files\\ArcGIS\\Velocity\\data\\config-root\\server-dirs\\system","type":"SYSTEM"}, {"name":"configbackups","path":"C:\\Program Files\\ArcGIS\\Velocity\\config-backups","type":"SYSTEM"}]

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
{
    "success": true,
    "message": "Site created",
    "elapsedTime": 648
}

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