Skip to content
URL:
https://<root>/importsite
Methods:
POST
Version Introduced:
12.0

Description

The importSite operation imports a site configuration into the currently running site. Importing a site means replacing all site configurations (including video services, security configurations, and so on) of the currently running site with those contained in the site configuration file. The site configuration file can be obtained through the Export Site operation, which writes the information to either a file location accessible to ArcGIS Video Server or to a directory where you can download the configuration file.

The importSite operation also restores a site from a backup that was created using the exportSite operation. The importSite operation uses the server directory paths from the exported configuration. These paths must be available for the importSite operation to complete successfully.

This operation will restore all information included in the backup, as described in Export Site. Once the import is complete, this operation returns a report that should be reviewed. Fix any problems listed in the report to ensure that the site functions as expected.

Request parameters

ParameterDetails

location

(Required)

The folder path to an exported configuration, or an ID referencing the stored configuration on the server.

validate

This parameter validates the file path specified in the location parameter, ensuring that it is accessible before performing the importSite operation. If set to true, the path will be validated, and the operation will return either a success response or an error message. The default value is false.

Values: true | false

f

(Required)

The response format. The default response format is html.

Values: html | json | pjson

token

(Required)

Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

Example usage

The following is a sample POST request for the importSite operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /<context>/admin/importSite HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

location=\\server\share\backup\Nov-15-2025_11-50-33.agssite&validate=true&f=pjson

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
{
    "backupFileName": [],
    "status": "success"
}

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