Download Policies File
get
/mobile/tools/1.0/policies/export
Downloads a file that lists the environment policies.
Request
Supported Media Types
- application/json
Query Parameters
- format
-
Type:
stringThe output type for the policy file.
properties: Lists each policy on a separate line. This format is easy to read and edit, and is in the same format that you use to import a policies file.-
json: Lists the polices JSON format. This format is suitable for automatic processing.
properties[ "properties", "json" ]
Response
Supported Media Types
- text/plain
- application/json
200 Response
The policies.
Examples
The following example shows how to use cURL to download the policies file in JSON format. For more information about cURL, see Use cURL.
curl -i -X GET -H "Authorization: Bearer $TOKEN" "$BASE_URL/mobile/tools/1.0/policies/export?format=json"Example of Response Header
The following shows an example of the response headers.
200 OK Content-Length: 2091 Content-Type: application/json Date: Thu, 18 Jun 2017 00:26:10 GMT
Example of Response Body
The following example shows the contents of the downloaded file when the format=json query parameter is used. Note that the hiddenPolicies are the policies that you must not change.
{
"policies":{
},
"environment":"instance1",
"systemVersion":"17.3.1.0.0.170706.0620",
"hiddenPolicies":{
"*.custom/promo(1.0).Routing_BindApiToImpl":"promo(1.0)"
},
"systemPolicies":{
"*.*.Admin_DcsConfig":"{}",
"*.*.Admin_FeatureConfiguration":"{ \"DCS\": true }",
"*.*.Asset_AllowPurge":"ALL",
"*.*.Asset_AllowTrash":"ALL",
"*.*.Asset_AllowUntrash":"ALL",
"*.*.Asset_DefaultInitialVersion":"1.0",
...
"*.*.User_AllowDynamicUserSchema":"false"
}
}
The following example shows the contents of the response body when the format=properties query parameter is used. Note that properties is the default format.
# ---------------------------------------------------------
# MCS Policies.
# ---------------------------------------------------------
# ! DO NOT EDIT THE HEADER !
# Snapshot from: instance1
# System version: 17.3.1.0.0.170706.0620
# Data format: 2
# ---------------------------------------------------------
*.*.Admin_DcsConfig={}
*.*.Admin_FeatureConfiguration={ "DCS"\: true }
*.*.Asset_AllowPurge=ALL
*.*.Asset_AllowTrash=ALL
*.*.Asset_AllowUntrash=ALL
*.*.Asset_DefaultInitialVersion=1.0
...
.*.User_AllowDynamicUserSchema=false
# ---------------------------------------------------------
# WARNING:
#
# The policies in this section are critical to MCS system operability.
# Editing these policies could severely impact MCS. Generally,
# you shouldn't need to modify them. If you must make changes,
# you should have a thorough understanding of each policy's function
# and the impact the changes will make to MCS.
# ---------------------------------------------------------
*.custom/promo(1.0).Routing_BindApiToImpl=promo(1.0)