- URL:
- https://<root>/createNewSite
- Methods:
POST- Required Capability:
- Administrator
- Version Introduced:
- 12.2
Description
The create operation is the first operation that you must invoke when you install ArcGIS Data Pipelines Server for the first time. You can only run this operation when the machine is not participating in a site.
Creating a site involves the following tasks:
- Allocate a store to save the site configuration.
- Configure the server directories.
- Create the primary site administrator user.
It takes only a few seconds to create a site. Once a site has been created, you can register ArcGIS Web Adaptor and federate the server with ArcGIS Enterprise. For more information, see Install ArcGIS Data Pipelines Server using the installation guide.
Included in the request to this operation are JSON objects describing the file paths for the site configuration store and server directories.
For Windows systems, to join additional ArcGIS Data Pipelines Server machines to the site, the configuration store and all server directories must be on shared drives. For more information, see Join additional machines to an ArcGIS Data Pipelines Server site.
Request parameters
| Parameter | Details |
|---|---|
| The name of the primary administrator account to be used by the site. This can be changed later. Example |
| The credentials for the primary administrator account. This can be changed later. Example |
| A JSON object representing the connection to the configuration store. By default, the configuration store is maintained in the installation directory. The following is a sample input for file store configurations: Example |
| A JSON object representing the collection of server directories to create. By default, these directories are created in the installation directory. Example |
| Optional log settings. A JSON object representing the log settings for the newly created site. Syntax Example |
| Introduced at ArcGIS Enterprise 12.2. Specifies the recovery codes file. This file is used to generate the primary encryption key used in ArcGIS Data Pipelines Server. If this parameter is not specified, a new recovery codes file named recovery_codes.txt will be randomly generated and stored in the |
| The response format. The default response format is Values: |
Response properties
| Property | Details |
|---|---|
| Indicates success or failure of the |
Example usage
The following is an example POST request for the create operation for Windows or Linux machines:
POST /<context>/admin/createNewSite HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
username=administrator&password=secret&cloudConfigJson=&configStoreConnection={
"configPersistenceType":"FILESYSTEM",
"connectionString": "\\myshare\arcgisdatapipelinesserver\config-store"
}&directories={
"directories": [
{
"name": "arcgisoutput",
"path": "C:\\arcgisdatapipelinesserver\\directories\\arcgisoutput",
"type": "OUTPUT",
"id":"f94fb767-ba26-43db-a60a-78d14ccb3071"
},
{
"name": "arcgissystem",
"path": "C:\\arcgisdatapipelinesserver\\directories\\arcgissystem",
"type": "SYSTEM",
"id":"7ce18be7-9f17-4b80-9cb5-229822f7194e"
},{
"name": "arcgisjobs",
"path": "C:\\arcgisdatapipelinesserver\\directories\\arcgisjobs",
"type": "JOBS",
"id":"35f551c2-f873-4bfa-b470-49150404335a"
}
]
}&logsSettings={
"logLevel": "INFO",
"logDir": "C:\\arcgisdatapipelinesserver\\logs",
"maxErrorReportsCount": 10,
"maxLogFileAge": 90
}&f=jsonJSON Response syntax
{"status":"<success|failure>"}JSON Response example
{"status":"success"}