Export Site

  • URL:https://<portaladmin>/exportSite(POST only)
  • Required Capability:Administrator
  • Version Introduced:10.4

Description

This operation exports the portal site configuration to a location you specify. The exported file includes the following information:

  • Content directory — The content directory contains the data associated with every item in the portal.
  • Portal database — A snapshot of the portal database that stores users, groups, items, and other information about the portal.

Caution:

You cannot make other administrative site configuration changes while a backup is in progress.

Request parameters - file store

ParameterDetails
location

A path to a folder accessible to the portal where the exported site configuration will be written.

f

The response format. The default response format is html.

Values: json | html

Request parameters - AWS S3 store

ParameterDetails
location

A path to the location where the exported site configuration will be created. The backup file written to this location will contain a pointer to the Backup Bucket Name and Backup Bucket Region parameters.

backupObjectStore

The name of your Backup Bucket.

backupObjectStoreRegion

The AWS region your Backup Bucket is in.

f

The response format. The default response format is html.

Values: json | html

Request parameters - Azure Blob store

ParameterDetails
location

A path to a folder accessible to the portal where the exported site configuration will be written.

backupObjectStore

The URL for the backup Blob container, which will have the format <https://<accountName>.blob.core.windows.net/<container>.

backupObjectStoreRegion

A string that stores the connection information for the Blob container. Include the parameters accountKey, accountName, and optionally accountEndpoint (if connecting to storage services in different regions).

f

The response format. The default response format is html.

Values: json | html

Example usage - file store

https://<portaladmin>/exportSite
  location=\\server\share\backup

JSON response syntax - file store

{
  "status": "success",
  "location": "\\server\share\backup\Oct-06-2017_10-20-55.portalsite"
}

Example usage - AWS S3

https://<portaladmin>/exportSite
  location=\\server\share\backup
  backupObjectStore="sampleBucket"
  backupObjectStoreRegion="us-east-1"

JSON response syntax - AWS S3

{
  "status": "success",
  "location": "\\server\share\backup\Oct-06-2017_10-20-55.portalsite"
}

Example usage - Azure

https://<portaladmin>/exportSite
  location=\\server\share\backup
  backupObjectStore=https://sampleserver.blob.core.windows.net/mycontainer
  backupObjectStoreConnectionStr={"accountName":"myaccountName",
                                  "accountKey": "myAccountKey",
                                  ”accountEndpoint”: [optional] “accountEndpoint“}

JSON response syntax - Azure

{
  "status": "success",
  "location": "\\server\share\backup\Oct-06-2017_10-20-55.portalsite"
}