- URL:
- https://<root>/exportSite
- Methods:
POST- Required Capability:
- Administrator
- Version Introduced:
- 12.2
Description
ArcGIS Data Pipelines Server provides the export operation to back up the site's configuration store, along with the importSite operation to restore a site configuration from a backup. The configuration store hosts essential information about the ArcGIS Data Pipelines Server site and its machines.
The output of this operation is a ZIP file with the .agssite file extension and is written to a file location accessible to ArcGIS Data Pipelines Server.
The exported file includes, and excludes, the following information:
| Information included in the backup | Information not included |
|---|---|
|
|
Request parameters
| Parameter | Details |
|---|---|
| Specify the full path for the directory to which you want to export the site configuration. The site must have access to this directory. Example |
| This parameter validates the path specified in the Values: |
| The response format. The default response format is Values: |
Response properties
| Property | Details |
|---|---|
| Indicates success or failure of the export operation. |
| The location of the exported file. This is only returned if |
| The timestamp of the exported file. This is only returned if |
Example usage
The following is a sample POST request 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\backups&validate=true&f=pjsonJSON Response examples
The following is an example response when the validate parameter set as false and the operation succeeds:
{
"baseBackupTimeStamp": 1779290582518,
"location": "C:\\backups\\20260520-083000.agssite",
"status": "success"
}The following is an example response when the validate parameter set as false and the operation fails:
{
"error" : {
"code" : 500,
"message" : "Export operation failed. Failed to create the folder '/server/no_access'.",
"details" : null
}
}