URL:
https://<root>/exportSite
Methods:
POST
Required Capability:
Administrator
Version Introduced:
12.2

Description

ArcGIS Data Pipelines Server provides the exportSite 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 backupInformation not included
  • Data pipeline items
  • Items created by data pipeline workflows
  • Log messages
  • ArcGIS Web Adaptor configurations
  • Primary site administrator name and password

Request parameters

ParameterDetails

location

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
Use dark colors for code blocksCopy
1
location=/myfolder/export_may2026

validate

This parameter validates the 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

Response properties

PropertyDetails

status

Indicates success or failure of the export operation.

location

The location of the exported file. This is only returned if validate is set to false.

baseBackupTimeStamp

The timestamp of the exported file. This is only returned if validate is set to false.

Example usage

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

Use dark colors for code blocksCopy
1
2
3
4
5
6
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=pjson

JSON Response examples

The following is an example response when the validate parameter set as false and the operation succeeds:

Use dark colors for code blocksCopy
1
2
3
4
5
{
    "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:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "error" : {
    "code" : 500,
    "message" : "Export operation failed. Failed to create the folder '/server/no_access'.",
    "details" : null
  }
}

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