- URL:https://<rootl>/createNewSite
- Required Capability:Default administrator role
- Version Introduced:10.2
Description
The createNewSite operation initializes and configures an ArcGIS Enterprise portal for use. It must be the first operation invoked after installation. Creating a new site involves the following:
- Creating the initial administrator account
- Creating a 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, the operation attempts to migrate the database to the current version while keeping its data intact. At the end of the operation, the web server that hosts the API is automatically restarted.
Request parameters
| Parameter | Details |
|---|---|
| username | The initial administrator account name. Example |
| password | The password for the initial administrator account. Example |
| fullname | The full name for the initial administrator account. Example |
The account email address. Example | |
| description | An optional description for the account. Example |
| securityQuestionIdx | The index of the secret question to retrieve a forgotten password. The secret questions and their indexes are listed below. Example |
| securityQuestionAns | The answer to the secret question specified in the securityQuestionIdx parameter. Example |
| contentStore | The JSON string including the path to the location of the site's content. Example |
| file | The portal license file. Starting at 10.7, you obtain the portal license file—a multipart POST file that contains information regarding your user types, apps, and app bundles—from My Esri. For more information, see Obtain a portal license file. |
| 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 about roles and user types, see User types, roles, and privileges. Values: creatorUT | GISProfessionalBasicUT | GISProfessionalStdUT | GISProfessionalAdvUT |
| f | The formatting parameter. The default format is html. Values: json | html | pjson |
Secret questions and indexes
The securityQuestionIdx parameter defines a security question that is used when retrieving a forgotten password. Listed below are the security questions and their associated index numbers:
| Index number | Security question |
|---|---|
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
The following is a sample POST request for the createNewSite operation:
POST /webadaptor/portaladmin/createNewSite HTTP/1.1
Host: machine.domain.com
Content-Type: multipart/form-data; boundary=----boundary
Content-Length: []
------boundary
Content-Disposition: form-data; name="username"
cadmin
------boundary
Content-Disposition: form-data; name="password"
admin.secret
------boundary
Content-Disposition: form-data; name="fullname"
Administrator
------boundary
Content-Disposition: form-data; name="email"
[email protected]
------boundary
Content-Disposition: form-data; name="description"
The initial admin account
------boundary
Content-Disposition: form-data; name="securityQuestionIdx"
1
------boundary
Content-Disposition: form-data; name="securityQuestionAns"
Mumbai
------boundary
Content-Disposition: form-data; name="contentStore"
{"type": "fileStore","provider": "FileSystem","connectionString": "C:/arcgisportal/content"}
------boundary
Content-Disposition: form-data; name="file"; filename=""
Content-Type: application/octet-stream
portal_license.json
------boundary
Content-Disposition: form-data; name="userLicenseTypeId"
creatorUT
------boundary
Content-Disposition: form-data; name="f"
pjson
------boundaryJSON Response example
{
"status": "success",
"recheckAfterSecs": 10
}