Skip To Content
ArcGIS Developers
Dashboard

Create Site

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.

Example

username=cadmin
password

The password for the initial administrator account.

Example

password=admin.secret
fullname

The full name for the initial administrator account.

Example

fullname=Administrator
email

The account email address.

Example

email=admin@email.com
description

An optional description for the account.

Example

description=The initial admin account
securityQuestionIdx

The index of the secret question to retrieve a forgotten password. Below is a full list of all possible secret question indexes.

Example

securityQuestionIdx=1
securityQuestionAns

The answer to the secret question specified in the securityQuestionIdx parameter.

Example

securityQuestionAns=Mumbai
contentStore

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

Example

contentStore={"type": "fileStore","provider": "FileSystem","connectionString": "C:/arcgisportal/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.

Example

file=portal_license.json
userLicenseTypeId

Introduced at 10.7. 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

Example

userLicenseTypeId=creatorUT
f

The formatting parameter. Default is html.

Values: json | html | pjson

Secret questions & indexes

The securityQuestionIdx parameter defines a security question that will be used when retrieving forgotten passwords. Listed below are the security questions and their associated index numbers:

  1. What city were you born in?
  2. What was your high school mascot?
  3. What is your mother's maiden name?
  4. What was the make of your first car?
  5. What high school did you go to?
  6. What is the last name of your best friend?
  7. What is the middle name of your youngest sibling?
  8. What is the name of the street on which you grew up?
  9. What is the name of your favorite fictional character?
  10. What is the name of your favorite pet?
  11. What is the name of your favorite restaurant?
  12. What is the title of your favorite book?
  13. What is your dream job?
  14. Where did you go on your first date?

Example usage

Below is a sample request URL for createNewSite:

https://machine.domain.com/webadaptor/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&f=json

JSON Response example

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