- URL:
- https://<root>/createNewSite
- Methods:
POST- Version Introduced:
- 12.1
Description
The create 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
| Parameter | Details |
|---|---|
(Required) | The name of the administrative account to be used by this site. Example |
(Required) | The credential for the administrative account. Example |
(Optional) | The externally reachable hostname (or IP) for this Velocity machine. Example |
(Optional) | A JSON object representing the log settings for the newly created site. Example |
(Optional) | A flag that indicates whether the operation should run asynchronously. Value: |
(Optional) | A JSON object representing the connection to the configuration store. By default, the configuration store is maintained in the installation directory. Syntax Example |
(Optional) | A JSON object representing the collection of server directories to create. By default, these directories are created locally. Example |
(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 |
(Optional) | The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the create operation on Linux:
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 create operation on Windows:
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
{
"success": true,
"message": "Site created",
"elapsedTime": 648
}