URL:
https://<root>/createNewSite
Methods:
POST
Required Capability:
Administrator
Version Introduced:
12.2

Description

The createNewSite 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

ParameterDetails

username

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

Example
Use dark colors for code blocksCopy
1
username=administrator

password

The credentials for the primary administrator account. This can be changed later.

Example
Use dark colors for code blocksCopy
1
password=secret

configStoreConnection

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
Use dark colors for code blocksCopy
1
2
3
4
configStoreConnection={
  "configPersistenceType"="FILESYSTEM",
  "connectionString": "\\myshare\config-store"
}

directories

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

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
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

Optional log settings.

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

Syntax
Use dark colors for code blocksCopy
1
2
3
4
5
{
  "maxLogFileAge": <number of days up to which logs should be retained>,
  "logLevel": "SEVERE|WARNING|INFO|VERBOSE|DEBUG",
  "logDir": "A local or a shared directory location for writing the log files"
}
Example
Use dark colors for code blocksCopy
1
2
3
4
5
{
  "maxLogFileAge": 90,
  "logLevel": "WARNING",
  "logDir": "C:\\arcgisdatapipelinesserver\\logs\\"
}

recoveryCodesFile

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 <ArcGIS Data Pipelines Server installation location>/framework/etc folder.

f

The response format. The default response format is html .

Values: html | json | pjson

Response properties

PropertyDetails

status

Indicates success or failure of the createNewSite operation.

Example usage

The following is an example POST request for the createNewSite operation for Windows or Linux machines:

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
24
25
26
27
28
29
30
31
32
33
34
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=json

JSON Response syntax

Use dark colors for code blocksCopy
1
{"status":"<success|failure>"}

JSON Response example

Use dark colors for code blocksCopy
1
{"status":"success"}

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