ArcGIS REST API

Create Site

  • URL:https://<portaladmin>/createNewSite
  • Required Capability:Administrator
  • Version Introduced:10.2

Description

The Create Site operation initializes and configures your ArcGIS Enterprise portal for use. It must be the first operation invoked after installation. Creating a new site involves:

  • Creating the initial administrator account
  • Creating a new database administrator account (which is same as the initial administrator account)
  • Creating token shared keys
  • Registering directories

This operation is time-consuming, as the database is initialized and populated with default templates and content. If the database directory is not empty, this operation attempts to migrate the database to the current version while keeping its data intact. At the end of this operation, the web server that hosts the API is restarted.

Request Parameters

ParameterDetails
username

The initial administrator account name.

password

The password for the initial administrator account.

fullname

The full name for the initial administrator account.

email

The account email address.

description

An optional description for the account.

securityQuestionIdx

The index of the secret question to retrieve a forgotten password.

securityQuestionAns

The answer to the secret question.

contentStore

The JSON string including the path to the location of the site's content.

file

The portal license file. Starting at 10.7, you will obtain your portal license file—which contains information regarding your user types, apps, and app bundles—from My Esri. For more information, see Obtain a portal license file.

userLicenseTypeId

The user type for the initial administrator account. The values listed below are the user types that are compatible with the Administrator role. For more information on roles and user types, see User types, roles, and privileges.

Values: creatorUT | GISProfessionalBasicUT | GISProfessionalStdUT | GISProfessionalAdvUT

f

The formatting parameter. Default is html.

Values: json | html

Note:

Both the file and userLicenseTypeId parameters are new at 10.7.

Example Usage

https://<portaladmin>/createNewSite
username=admin
password=admin.secret
fullname=Administrator
email=admin@email.com
description=The initial admin account
securityQuestionIdx=1
securityQuestionAns=Mumbai
contentStore={
"type": "fileStore",
"provider": "FileSystem",
"connectionString": "C:/arcgisportal/content"
}
file=portal_license.json
userLicenseTypeId=creatorUT

JSON Response Example

{
    "status": "success",
    "recheckAfterSecs": 10
}