Export Site | ArcGIS REST APIs

URL:: https://<root>/exportsite
Methods:: POST
Version Introduced:: 12.0

Description

The exportSite operation exports the site configuration to a specified location. The exported file includes, and excludes, the following information:

Information included in the backup	Information not included
Service configurations and service properties Service webhooks Registered data store item locations User and role information List of machines in the site Log settings	Data used by services (unless it was copied to a folder on the server automatically at publish time) Log messages Primary site administrator name and password ArcGIS Web Adaptor configurations

Protecting information not included in the backup

As noted above, some information is not included in the backup of your site. It's recommended you manually back up this information at the same time you run the backup utility. When you restore the site, manually copy or move this information back to the site, for example:

If the data used by your services was not copied to a folder on the server when publishing, it will not be included in the backup. Manually back up your data directories, geodatabases, databases, source tables, and any other information used by your services. When you restore the site, verify ArcGIS Video Server has permissions to access your data locations. For more information, see Making your data accessible to ArcGIS Server.

Request parameters

Parameter Details

Parameter	Details
`destination` (Required)	An absolute folder path, accessible to ArcGIS Video Server, where the exported site configuration will be written. If ArcGIS Server is configured to use cloud-based storage, the `location` parameter can instead be used to defined the prefix for where the exported site configuration will be located.
`validate` (Optional)	This parameter validates the folder path specified in the `location` parameter, ensuring that it is accessible before performing the `exportSite` 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`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

destination

(Required)

An absolute folder path, accessible to ArcGIS Video Server, where the exported site configuration will be written. If ArcGIS Server is configured to use cloud-based storage, the location parameter can instead be used to defined the prefix for where the exported site configuration will be located.

validate

(Optional)

This parameter validates the folder path specified in the location parameter, ensuring that it is accessible before performing the exportSite 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

The response format. The default response format is html.

Values: html | json | pjson

Example usages

The following are sample POST requests for the exportSite operation:

Use dark colors for code blocksCopy
POST /<context>/admin/exportSite HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

destination=\\server\share\backup&validate=true&f=pjson

JSON Response examples

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

Use dark colors for code blocksCopy
{
    "baseBackupTimeStamp": 1767633817855,
    "location": "\\\\host\\Shared\\backup\\date-time\\samplePM-EST.agssite",
    "status": "success"
}