- URL:
- https://<root>/exportSite
- Methods:
POST- Version Introduced:
- 10.2
Access requirements
Required privileges
The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
Description
The export 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 |
|---|---|
|
|
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:
These directories will contain the cache tiles and the tiling scheme file conf.xml. The cache directories may also contain a file geodatabase status.gdb that contains information about which tiles have been built. When you restore the site, move or copy the information back to the original arcgiscache directory.
Request parameters
| Parameter | Details |
|---|---|
(Optional) | A folder path, accessible to ArcGIS Server, where the exported site configuration will be written. Starting at ArcGIS Enterprise 12.0, if ArcGIS Server is configured to use cloud-based storage, the |
(Optional) | Introduced at ArcGIS Enterprise 12.0. This parameter defines the location configuration for a file store or cloud-based storage systems. If ArcGIS Server is configured to use cloud-based storage, the JSON object must contain connection information, such as bucket, container, credential, and cloud region information. If this parameter is not defined, or if ArcGIS Server is not configured with cloud-based storage, the parameter will use the file store configuration. The following is sample input for file store configurations. Example |
| Introduced at ArcGIS Enterprise 11.1. This parameter validates the folder path specified in the Values: |
| Introduced at ArcGIS Enterprise 12.0. This parameter specifies whether the backup is created asynchronously. If set as Values: |
| The response format. The default response format is Values: |
Example usages
The following are sample POST requests for the export operation:
POST /<context>/admin/exportSite HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
location=\\server\share\backup&locationConfig={"type": "fileStore","provider": "FileSystem"}&validate=true&async=false&f=pjsonJSON Response examples
The following demonstrates the differences in responses when the operation is performed synchronously, with the validate parameter set as false, and either defining a folder location for the site configuration to be exported to or leaving the location parameter empty.
{
status: "success",
location: "\\server\share\backup\Aug-15-2025_11-50-33.agssite"
}