- URL:
- https://<root>/services/exportServices
- Methods:
POST- Version Introduced:
- 10.5
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. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the ArcGIS 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 ArcGIS Server Administrator API generate operation. For security reasons, all POST requests made to the ArcGIS Server Administrator API must include a token in the request body.
Description
The export operation exports the site's user published, System, and Utility services to a specified folder location or a directory on the server.
Request parameters
| Parameter | Details |
|---|---|
(Optional) | A folder path, accessible to ArcGIS Server, where the exported services configuration will be written. Starting at ArcGIS Enterprise 12.1, 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 services configuration will be located. If the location parameter is not specified, the server writes the exported site configuration file to a directory owned by the server and returns a virutal path (HTTPS URL) to that directory. The URL returned from that response can be used to download the exported site configuration from the directory. |
(Optional) | Introduced at ArcGIS Enterprise 12.1. 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 |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the export operation:
POST /<context>/admin/services/exportServices HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
location=\\server\share\backup&f=pjson