Policy Management API v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Please note this API is only available if you have deployed and configured MongoDB with the Glasswall Halo

Authentication

HTTP Authentication, scheme: basic
HTTP Authentication, scheme: Bearer

PolicyManagement

Create Policy

Code samples

# You can also use wget
curl -X POST /api/v1/policies/{policyName} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /api/v1/policies/{policyName} HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "status": "enabled",
  "policySettings": {
    "contentManagementFlags": {
      "pdfContentManagement": {
        "acroform": "sanitise",
        "digitalSignatures": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "javascript": "sanitise",
        "metadata": "sanitise",
        "actionsAll": "sanitise",
        "watermark": "",
        "retainExportedStreams": 1,
        "valueOutsideReasonableLimits": 1
      },
      "wordContentManagement": {
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "excelContentManagement": {
        "connections": "sanitise",
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "powerPointContentManagement": {
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "svgConfig": {
        "hyperlinks": "sanitise",
        "foreignObjects": "sanitise",
        "scripts": "sanitise"
      },
      "webpConfig": {
        "metadata": "sanitise"
      },
      "tiffConfig": {
        "geoTiff": "sanitise"
      },
      "archiveConfig": {
        "bmp": 1,
        "doc": 1,
        "docx": 1,
        "emf": 1,
        "gif": 1,
        "jpg": 1,
        "wav": 1,
        "elf": 1,
        "pe": 1,
        "mp4": 1,
        "mpg": 1,
        "pdf": 1,
        "png": 1,
        "ppt": 1,
        "pptx": 1,
        "tif": 1,
        "wmf": 1,
        "xls": 1,
        "xlsx": 1,
        "mp3": 1,
        "rtf": 1,
        "coff": 1,
        "macho": 1,
        "svg": 1,
        "webp": 1,
        "unknown": 1
      }
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v1/policies/{policyName}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post '/api/v1/policies/{policyName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v1/policies/{policyName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/policies/{policyName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/policies/{policyName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/v1/policies/{policyName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /api/v1/policies/{policyName}

Creates a named policy with the provided values

Body parameter

{
  "status": "enabled",
  "policySettings": {
    "contentManagementFlags": {
      "pdfContentManagement": {
        "acroform": "sanitise",
        "digitalSignatures": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "javascript": "sanitise",
        "metadata": "sanitise",
        "actionsAll": "sanitise",
        "watermark": "",
        "retainExportedStreams": 1,
        "valueOutsideReasonableLimits": 1
      },
      "wordContentManagement": {
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "excelContentManagement": {
        "connections": "sanitise",
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "powerPointContentManagement": {
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "svgConfig": {
        "hyperlinks": "sanitise",
        "foreignObjects": "sanitise",
        "scripts": "sanitise"
      },
      "webpConfig": {
        "metadata": "sanitise"
      },
      "tiffConfig": {
        "geoTiff": "sanitise"
      },
      "archiveConfig": {
        "bmp": 1,
        "doc": 1,
        "docx": 1,
        "emf": 1,
        "gif": 1,
        "jpg": 1,
        "wav": 1,
        "elf": 1,
        "pe": 1,
        "mp4": 1,
        "mpg": 1,
        "pdf": 1,
        "png": 1,
        "ppt": 1,
        "pptx": 1,
        "tif": 1,
        "wmf": 1,
        "xls": 1,
        "xlsx": 1,
        "mp3": 1,
        "rtf": 1,
        "coff": 1,
        "macho": 1,
        "svg": 1,
        "webp": 1,
        "unknown": 1
      }
    }
  }
}

Parameters

Name	In	Type	Required	Description
policyName	path	string	true	The name of the policy to create
body	body	WritePolicyBody	true	none

Example responses

201 Response

{
  "schemaName": "syncapiv1",
  "policyName": "default",
  "policyIdentity": "11111111-1111-1111-1111-111111111111",
  "policyVersion": 2,
  "isDefaultPolicy": true,
  "status": "enabled",
  "policyLocation": "api/v1/schemas/syncapiv1/policies/policyName"
}

Responses

Status	Meaning	Description	Schema
201	Created	Policy Created	WritePolicyBodyResponse
400	Bad Request	Policy failed validation, reasons in response	None
403	Forbidden	Attempt to create ‘default’ policy	None
404	Not Found	Specified schema not found	None
500	Internal Server Error	Issues occurred when attempting to access storage.	None

Update Policy

Code samples

# You can also use wget
curl -X PUT /api/v1/policies/{policyName} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

PUT /api/v1/policies/{policyName} HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "status": "enabled",
  "policySettings": {
    "contentManagementFlags": {
      "pdfContentManagement": {
        "acroform": "sanitise",
        "digitalSignatures": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "javascript": "sanitise",
        "metadata": "sanitise",
        "actionsAll": "sanitise",
        "watermark": "",
        "retainExportedStreams": 1,
        "valueOutsideReasonableLimits": 1
      },
      "wordContentManagement": {
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "excelContentManagement": {
        "connections": "sanitise",
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "powerPointContentManagement": {
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "svgConfig": {
        "hyperlinks": "sanitise",
        "foreignObjects": "sanitise",
        "scripts": "sanitise"
      },
      "webpConfig": {
        "metadata": "sanitise"
      },
      "tiffConfig": {
        "geoTiff": "sanitise"
      },
      "archiveConfig": {
        "bmp": 1,
        "doc": 1,
        "docx": 1,
        "emf": 1,
        "gif": 1,
        "jpg": 1,
        "wav": 1,
        "elf": 1,
        "pe": 1,
        "mp4": 1,
        "mpg": 1,
        "pdf": 1,
        "png": 1,
        "ppt": 1,
        "pptx": 1,
        "tif": 1,
        "wmf": 1,
        "xls": 1,
        "xlsx": 1,
        "mp3": 1,
        "rtf": 1,
        "coff": 1,
        "macho": 1,
        "svg": 1,
        "webp": 1,
        "unknown": 1
      }
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v1/policies/{policyName}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.put '/api/v1/policies/{policyName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/v1/policies/{policyName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/v1/policies/{policyName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/policies/{policyName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/v1/policies/{policyName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/v1/policies/{policyName}

Updates a named policy with the provided values

Body parameter

{
  "status": "enabled",
  "policySettings": {
    "contentManagementFlags": {
      "pdfContentManagement": {
        "acroform": "sanitise",
        "digitalSignatures": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "javascript": "sanitise",
        "metadata": "sanitise",
        "actionsAll": "sanitise",
        "watermark": "",
        "retainExportedStreams": 1,
        "valueOutsideReasonableLimits": 1
      },
      "wordContentManagement": {
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "excelContentManagement": {
        "connections": "sanitise",
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "powerPointContentManagement": {
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "svgConfig": {
        "hyperlinks": "sanitise",
        "foreignObjects": "sanitise",
        "scripts": "sanitise"
      },
      "webpConfig": {
        "metadata": "sanitise"
      },
      "tiffConfig": {
        "geoTiff": "sanitise"
      },
      "archiveConfig": {
        "bmp": 1,
        "doc": 1,
        "docx": 1,
        "emf": 1,
        "gif": 1,
        "jpg": 1,
        "wav": 1,
        "elf": 1,
        "pe": 1,
        "mp4": 1,
        "mpg": 1,
        "pdf": 1,
        "png": 1,
        "ppt": 1,
        "pptx": 1,
        "tif": 1,
        "wmf": 1,
        "xls": 1,
        "xlsx": 1,
        "mp3": 1,
        "rtf": 1,
        "coff": 1,
        "macho": 1,
        "svg": 1,
        "webp": 1,
        "unknown": 1
      }
    }
  }
}

Parameters

Name	In	Type	Required	Description
policyName	path	string	true	The name of the policy to create
body	body	WritePolicyBody	true	none

Example responses

200 Response

{
  "schemaName": "syncapiv1",
  "policyName": "default",
  "policyIdentity": "11111111-1111-1111-1111-111111111111",
  "policyVersion": 2,
  "isDefaultPolicy": true,
  "status": "enabled",
  "policyLocation": "api/v1/schemas/syncapiv1/policies/policyName"
}

Responses

Status	Meaning	Description	Schema
200	OK	Policy Updated	WritePolicyBodyResponse
400	Bad Request	Policy failed validation, reasons in response	None
404	Not Found	Specified schema or policy not found	None
500	Internal Server Error	Issues occurred when attempting to access storage.	None

Get Policy

Code samples

# You can also use wget
curl -X GET /api/v1/policies/{policyName} \
  -H 'Accept: application/json'

GET /api/v1/policies/{policyName} HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('/api/v1/policies/{policyName}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/api/v1/policies/{policyName}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v1/policies/{policyName}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/policies/{policyName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/policies/{policyName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/v1/policies/{policyName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/policies/{policyName}

Gets a named policy

Parameters

Name	In	Type	Required	Description
policyName	path	string	true	The name of the policy to retrieve the details of

Example responses

200 Response

{
  "schemaName": "syncapiv1",
  "policyName": "default",
  "policyIdentity": "11111111-1111-1111-1111-111111111111",
  "policyVersion": 2,
  "isDefaultPolicy": true,
  "status": "enabled",
  "policySettings": {
    "contentManagementFlags": {
      "pdfContentManagement": {
        "acroform": "sanitise",
        "digitalSignatures": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "javascript": "sanitise",
        "metadata": "sanitise",
        "actionsAll": "sanitise",
        "watermark": "",
        "retainExportedStreams": 1,
        "valueOutsideReasonableLimits": 1
      },
      "wordContentManagement": {
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "excelContentManagement": {
        "connections": "sanitise",
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "powerPointContentManagement": {
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "svgConfig": {
        "hyperlinks": "sanitise",
        "foreignObjects": "sanitise",
        "scripts": "sanitise"
      },
      "webpConfig": {
        "metadata": "sanitise"
      },
      "tiffConfig": {
        "geoTiff": "sanitise"
      },
      "archiveConfig": {
        "bmp": 1,
        "doc": 1,
        "docx": 1,
        "emf": 1,
        "gif": 1,
        "jpg": 1,
        "wav": 1,
        "elf": 1,
        "pe": 1,
        "mp4": 1,
        "mpg": 1,
        "pdf": 1,
        "png": 1,
        "ppt": 1,
        "pptx": 1,
        "tif": 1,
        "wmf": 1,
        "xls": 1,
        "xlsx": 1,
        "mp3": 1,
        "rtf": 1,
        "coff": 1,
        "macho": 1,
        "svg": 1,
        "webp": 1,
        "unknown": 1
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Policy found	Inline
404	Not Found	Specified schema or policy not found	None
500	Internal Server Error	Issues occurred when attempting to access storage.	None

Response Schema

Enumerated Values

Property	Value
status	enabled
status	disabled
acroform	allow
acroform	sanitise
acroform	disallow
digitalSignatures	allow
digitalSignatures	sanitise
digitalSignatures	disallow
embeddedFiles	allow
embeddedFiles	sanitise
embeddedFiles	disallow
embeddedImages	allow
embeddedImages	sanitise
embeddedImages	disallow
externalHyperlinks	allow
externalHyperlinks	sanitise
externalHyperlinks	disallow
internalHyperlinks	allow
internalHyperlinks	sanitise
internalHyperlinks	disallow
javascript	allow
javascript	sanitise
javascript	disallow
metadata	allow
metadata	sanitise
metadata	disallow
actionsAll	allow
actionsAll	sanitise
actionsAll	disallow
dynamicDataExchange	allow
dynamicDataExchange	sanitise
dynamicDataExchange	disallow
embeddedFiles	allow
embeddedFiles	sanitise
embeddedFiles	disallow
embeddedImages	allow
embeddedImages	sanitise
embeddedImages	disallow
externalHyperlinks	allow
externalHyperlinks	sanitise
externalHyperlinks	disallow
internalHyperlinks	allow
internalHyperlinks	sanitise
internalHyperlinks	disallow
macros	allow
macros	sanitise
macros	disallow
metadata	allow
metadata	sanitise
metadata	disallow
reviewComments	allow
reviewComments	sanitise
reviewComments	disallow
connections	allow
connections	sanitise
connections	disallow
dynamicDataExchange	allow
dynamicDataExchange	sanitise
dynamicDataExchange	disallow
embeddedFiles	allow
embeddedFiles	sanitise
embeddedFiles	disallow
embeddedImages	allow
embeddedImages	sanitise
embeddedImages	disallow
externalHyperlinks	allow
externalHyperlinks	sanitise
externalHyperlinks	disallow
internalHyperlinks	allow
internalHyperlinks	sanitise
internalHyperlinks	disallow
macros	allow
macros	sanitise
macros	disallow
metadata	allow
metadata	sanitise
metadata	disallow
reviewComments	allow
reviewComments	sanitise
reviewComments	disallow
embeddedFiles	allow
embeddedFiles	sanitise
embeddedFiles	disallow
embeddedImages	allow
embeddedImages	sanitise
embeddedImages	disallow
externalHyperlinks	allow
externalHyperlinks	sanitise
externalHyperlinks	disallow
internalHyperlinks	allow
internalHyperlinks	sanitise
internalHyperlinks	disallow
macros	allow
macros	sanitise
macros	disallow
metadata	allow
metadata	sanitise
metadata	disallow
reviewComments	allow
reviewComments	sanitise
reviewComments	disallow
hyperlinks	allow
hyperlinks	sanitise
hyperlinks	disallow
foreignObjects	allow
foreignObjects	sanitise
foreignObjects	disallow
scripts	allow
scripts	sanitise
scripts	disallow
metadata	allow
metadata	sanitise
metadata	disallow
geoTiff	allow
geoTiff	sanitise
geoTiff	disallow
bmp	allow
bmp	sanitise
bmp	disallow
doc	allow
doc	sanitise
doc	disallow
docx	allow
docx	sanitise
docx	disallow
emf	allow
emf	sanitise
emf	disallow
gif	allow
gif	sanitise
gif	disallow
jpg	allow
jpg	sanitise
jpg	disallow
wav	allow
wav	sanitise
wav	disallow
elf	allow
elf	sanitise
elf	disallow
pe	allow
pe	sanitise
pe	disallow
mp4	allow
mp4	sanitise
mp4	disallow
mpg	allow
mpg	sanitise
mpg	disallow
pdf	allow
pdf	sanitise
pdf	disallow
png	allow
png	sanitise
png	disallow
ppt	allow
ppt	sanitise
ppt	disallow
pptx	allow
pptx	sanitise
pptx	disallow
tif	allow
tif	sanitise
tif	disallow
wmf	allow
wmf	sanitise
wmf	disallow
xls	allow
xls	sanitise
xls	disallow
xlsx	allow
xlsx	sanitise
xlsx	disallow
mp3	allow
mp3	sanitise
mp3	disallow
rtf	allow
rtf	sanitise
rtf	disallow
coff	allow
coff	sanitise
coff	disallow
macho	allow
macho	sanitise
macho	disallow
svg	allow
svg	sanitise
svg	disallow
webp	allow
webp	sanitise
webp	disallow
unknown	allow
unknown	sanitise
unknown	disallow

Delete Policy

Code samples

# You can also use wget
curl -X DELETE /api/v1/policies/{policyName}

DELETE /api/v1/policies/{policyName} HTTP/1.1


fetch('/api/v1/policies/{policyName}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/api/v1/policies/{policyName}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/v1/policies/{policyName}')

print(r.json())

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/v1/policies/{policyName}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/policies/{policyName}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/v1/policies/{policyName}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /api/v1/policies/{policyName}

Delete the specified policy

Parameters

Name	In	Type	Required	Description
policyName	path	string	true	The name of the policy to delete

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
403	Forbidden	Attempt to delete ‘default’ policy	None
404	Not Found	Specified schema or policy not found	None
500	Internal Server Error	Storage error	None

Get All Policies

Code samples

# You can also use wget
curl -X GET /api/v1/policies \
  -H 'Accept: application/json'

GET /api/v1/policies HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('/api/v1/policies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/api/v1/policies',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v1/policies', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/policies', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/policies");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/v1/policies", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/v1/policies

Gets a full list of all configured policies

Example responses

200 Response

[
  {
    "policyName": "default",
    "isDefaultPolicy": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	A list of all policies	Inline
404	Not Found	Specified schema or policy not found	None
500	Internal Server Error	Issues occurred when attempting to access storage.	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[GetAllPolicyItem]	false	none	none
» policyName	PolicyName	false	none	none
» isDefaultPolicy	IsDefaultPolicy	false	none	none

Reset Policy

Code samples

# You can also use wget
curl -X PUT /api/v1/policies/{policyName}/reset \
  -H 'Accept: application/json'

PUT /api/v1/policies/{policyName}/reset HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('/api/v1/policies/{policyName}/reset',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.put '/api/v1/policies/{policyName}/reset',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/v1/policies/{policyName}/reset', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/api/v1/policies/{policyName}/reset', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/policies/{policyName}/reset");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/api/v1/policies/{policyName}/reset", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /api/v1/policies/{policyName}/reset

Resets a named policy to the default schema values

Parameters

Name	In	Type	Required	Description
policyName	path	string	true	The name of the policy to reset

Example responses

200 Response

{
  "schemaName": "syncapiv1",
  "policyName": "default",
  "policyIdentity": "11111111-1111-1111-1111-111111111111",
  "policyVersion": 2,
  "isDefaultPolicy": true,
  "status": "enabled",
  "policyLocation": "api/v1/schemas/syncapiv1/policies/policyName"
}

Responses

Status	Meaning	Description	Schema
200	OK	Policy Updated	WritePolicyBodyResponse
400	Bad Request	Policy failed validation, reasons in response	None
404	Not Found	Specified schema or policy not found	None
500	Internal Server Error	Issues occurred when attempting to access storage.	None

Schemas

PolicyMetadata

{
  "contentManagementFlags": {
    "pdfContentManagement": {
      "acroform": "sanitise",
      "digitalSignatures": "sanitise",
      "embeddedFiles": "sanitise",
      "embeddedImages": "sanitise",
      "externalHyperlinks": "sanitise",
      "internalHyperlinks": "sanitise",
      "javascript": "sanitise",
      "metadata": "sanitise",
      "actionsAll": "sanitise",
      "watermark": "",
      "retainExportedStreams": 1,
      "valueOutsideReasonableLimits": 1
    },
    "wordContentManagement": {
      "dynamicDataExchange": "sanitise",
      "embeddedFiles": "sanitise",
      "embeddedImages": "sanitise",
      "externalHyperlinks": "sanitise",
      "internalHyperlinks": "sanitise",
      "macros": "sanitise",
      "metadata": "sanitise",
      "reviewComments": "sanitise"
    },
    "excelContentManagement": {
      "connections": "sanitise",
      "dynamicDataExchange": "sanitise",
      "embeddedFiles": "sanitise",
      "embeddedImages": "sanitise",
      "externalHyperlinks": "sanitise",
      "internalHyperlinks": "sanitise",
      "macros": "sanitise",
      "metadata": "sanitise",
      "reviewComments": "sanitise"
    },
    "powerPointContentManagement": {
      "embeddedFiles": "sanitise",
      "embeddedImages": "sanitise",
      "externalHyperlinks": "sanitise",
      "internalHyperlinks": "sanitise",
      "macros": "sanitise",
      "metadata": "sanitise",
      "reviewComments": "sanitise"
    },
    "svgConfig": {
      "hyperlinks": "sanitise",
      "foreignObjects": "sanitise",
      "scripts": "sanitise"
    },
    "webpConfig": {
      "metadata": "sanitise"
    },
    "tiffConfig": {
      "geoTiff": "sanitise"
    },
    "archiveConfig": {
      "bmp": 1,
      "doc": 1,
      "docx": 1,
      "emf": 1,
      "gif": 1,
      "jpg": 1,
      "wav": 1,
      "elf": 1,
      "pe": 1,
      "mp4": 1,
      "mpg": 1,
      "pdf": 1,
      "png": 1,
      "ppt": 1,
      "pptx": 1,
      "tif": 1,
      "wmf": 1,
      "xls": 1,
      "xlsx": 1,
      "mp3": 1,
      "rtf": 1,
      "coff": 1,
      "macho": 1,
      "svg": 1,
      "webp": 1,
      "unknown": 1
    }
  }
}

Provides the policy metadata and link to where the full policy settings can be acquired.

Properties

Name	Type	Required	Restrictions	Description
contentManagementFlags	ContentManagementFlags	true	none	none

SanitisationOptions

"sanitise"

How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).

Enumerated Values

Property	Value
anonymous	allow
anonymous	sanitise
anonymous	disallow

Status

"enabled"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	enabled
anonymous	disabled

ContentManagementFlags

{
  "pdfContentManagement": {
    "acroform": "sanitise",
    "digitalSignatures": "sanitise",
    "embeddedFiles": "sanitise",
    "embeddedImages": "sanitise",
    "externalHyperlinks": "sanitise",
    "internalHyperlinks": "sanitise",
    "javascript": "sanitise",
    "metadata": "sanitise",
    "actionsAll": "sanitise",
    "watermark": "string",
    "retainExportedStreams": true,
    "valueOutsideReasonableLimits": true
  },
  "wordContentManagement": {
    "dynamicDataExchange": "sanitise",
    "embeddedFiles": "sanitise",
    "embeddedImages": "sanitise",
    "externalHyperlinks": "sanitise",
    "internalHyperlinks": "sanitise",
    "macros": "sanitise",
    "metadata": "sanitise",
    "reviewComments": "sanitise"
  },
  "excelContentManagement": {
    "connections": "sanitise",
    "dynamicDataExchange": "sanitise",
    "embeddedFiles": "sanitise",
    "embeddedImages": "sanitise",
    "externalHyperlinks": "sanitise",
    "internalHyperlinks": "sanitise",
    "macros": "sanitise",
    "metadata": "sanitise",
    "reviewComments": "sanitise"
  },
  "powerPointContentManagement": {
    "embeddedFiles": "sanitise",
    "embeddedImages": "sanitise",
    "externalHyperlinks": "sanitise",
    "internalHyperlinks": "sanitise",
    "macros": "sanitise",
    "metadata": "sanitise",
    "reviewComments": "sanitise"
  },
  "svgConfig": {
    "hyperlinks": "sanitise",
    "foreignObjects": "sanitise",
    "scripts": "sanitise"
  },
  "webpConfig": {
    "metadata": "sanitise"
  },
  "tiffConfig": {
    "geoTiff": "sanitise"
  },
  "archiveConfig": {
    "bmp": "sanitise",
    "doc": "sanitise",
    "docx": "sanitise",
    "emf": "sanitise",
    "gif": "sanitise",
    "jpg": "sanitise",
    "wav": "sanitise",
    "elf": "sanitise",
    "pe": "sanitise",
    "mp4": "sanitise",
    "mpg": "sanitise",
    "pdf": "sanitise",
    "png": "sanitise",
    "ppt": "sanitise",
    "pptx": "sanitise",
    "tif": "sanitise",
    "wmf": "sanitise",
    "xls": "sanitise",
    "xlsx": "sanitise",
    "mp3": "sanitise",
    "rtf": "sanitise",
    "coff": "sanitise",
    "macho": "sanitise",
    "svg": "sanitise",
    "webp": "sanitise",
    "unknown": "sanitise"
  }
}

Properties

Name	Type	Required	Restrictions	Description
pdfContentManagement	object	true	none	none
» acroform	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» digitalSignatures	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» embeddedFiles	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» embeddedImages	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» externalHyperlinks	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» internalHyperlinks	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» javascript	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» metadata	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» actionsAll	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» watermark	string	false	none	none
» retainExportedStreams	boolean	false	none	none
» valueOutsideReasonableLimits	boolean	false	none	none
wordContentManagement	object	true	none	none
» dynamicDataExchange	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» embeddedFiles	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» embeddedImages	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» externalHyperlinks	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» internalHyperlinks	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» macros	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» metadata	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» reviewComments	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
excelContentManagement	object	true	none	none
» connections	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» dynamicDataExchange	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» embeddedFiles	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» embeddedImages	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» externalHyperlinks	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» internalHyperlinks	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» macros	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» metadata	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» reviewComments	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
powerPointContentManagement	object	true	none	none
» embeddedFiles	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» embeddedImages	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» externalHyperlinks	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» internalHyperlinks	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» macros	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» metadata	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» reviewComments	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
svgConfig	object	true	none	none
» hyperlinks	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» foreignObjects	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» scripts	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
webpConfig	object	true	none	none
» metadata	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
tiffConfig	object	true	none	none
» geoTiff	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
archiveConfig	object	true	none	none
» bmp	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» doc	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» docx	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» emf	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» gif	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» jpg	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» wav	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» elf	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» pe	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» mp4	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» mpg	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» pdf	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» png	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» ppt	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» pptx	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» tif	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» wmf	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» xls	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» xlsx	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» mp3	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» rtf	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» coff	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» macho	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» svg	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» webp	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).
» unknown	SanitisationOptions	false	none	How the system will handle the content item found in documents. Can be a number or string e.g 0 (allow), 1 (sanitise) or 2 (disallow).

WritePolicyBody

{
  "status": "enabled",
  "policySettings": {
    "contentManagementFlags": {
      "pdfContentManagement": {
        "acroform": "sanitise",
        "digitalSignatures": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "javascript": "sanitise",
        "metadata": "sanitise",
        "actionsAll": "sanitise",
        "watermark": "",
        "retainExportedStreams": 1,
        "valueOutsideReasonableLimits": 1
      },
      "wordContentManagement": {
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "excelContentManagement": {
        "connections": "sanitise",
        "dynamicDataExchange": "sanitise",
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "powerPointContentManagement": {
        "embeddedFiles": "sanitise",
        "embeddedImages": "sanitise",
        "externalHyperlinks": "sanitise",
        "internalHyperlinks": "sanitise",
        "macros": "sanitise",
        "metadata": "sanitise",
        "reviewComments": "sanitise"
      },
      "svgConfig": {
        "hyperlinks": "sanitise",
        "foreignObjects": "sanitise",
        "scripts": "sanitise"
      },
      "webpConfig": {
        "metadata": "sanitise"
      },
      "tiffConfig": {
        "geoTiff": "sanitise"
      },
      "archiveConfig": {
        "bmp": 1,
        "doc": 1,
        "docx": 1,
        "emf": 1,
        "gif": 1,
        "jpg": 1,
        "wav": 1,
        "elf": 1,
        "pe": 1,
        "mp4": 1,
        "mpg": 1,
        "pdf": 1,
        "png": 1,
        "ppt": 1,
        "pptx": 1,
        "tif": 1,
        "wmf": 1,
        "xls": 1,
        "xlsx": 1,
        "mp3": 1,
        "rtf": 1,
        "coff": 1,
        "macho": 1,
        "svg": 1,
        "webp": 1,
        "unknown": 1
      }
    }
  }
}

The policy settings to be set for a named policy

Properties

Name	Type	Required	Restrictions	Description
status	Status	false	none	none
policySettings	PolicyMetadata	true	none	Provides the policy metadata and link to where the full policy settings can be acquired.

WritePolicyBodyResponse

{
  "schemaName": "syncapiv1",
  "policyName": "default",
  "policyIdentity": "11111111-1111-1111-1111-111111111111",
  "policyVersion": 2,
  "isDefaultPolicy": true,
  "status": "enabled",
  "policyLocation": "api/v1/schemas/syncapiv1/policies/policyName"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	PolicyCommonProperties	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» policyLocation	PolicyLocation	false	none	none

PolicyCommonProperties

{
  "schemaName": "syncapiv1",
  "policyName": "default",
  "policyIdentity": "11111111-1111-1111-1111-111111111111",
  "policyVersion": 2,
  "isDefaultPolicy": true,
  "status": "enabled"
}

Properties

Name	Type	Required	Restrictions	Description
schemaName	SchemaName	false	none	Identifies the schema and its version. The format should be in the format of `[name]v[version]`, consisting of only alphanumeric characters `[A-Za-z0-9]`.
policyName	PolicyName	false	none	none
policyIdentity	PolicyIdentity	false	none	none
policyVersion	PolicyVersion	false	none	Identifies the version of the Policy.
isDefaultPolicy	IsDefaultPolicy	false	none	none
status	Status	false	none	none

SchemaName

"syncapiv1"

Identifies the schema and its version. The format should be in the format of [name]v[version], consisting of only alphanumeric characters [A-Za-z0-9].

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	Identifies the schema and its version. The format should be in the format of `[name]v[version]`, consisting of only alphanumeric characters `[A-Za-z0-9]`.

PolicyVersion

Identifies the version of the Policy.

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer	false	none	Identifies the version of the Policy.

PolicyLocation

"api/v1/schemas/syncapiv1/policies/policyName"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string(uri)	false	none	none

PolicyIdentity

"11111111-1111-1111-1111-111111111111"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string(uuid)	false	none	none

PolicyName

"default"

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

IsDefaultPolicy

true

Properties

Name	Type	Required	Restrictions	Description
anonymous	boolean	false	none	none

GetAllPolicyItem

{
  "policyName": "default",
  "isDefaultPolicy": true
}

Properties

Name	Type	Required	Restrictions	Description
policyName	PolicyName	false	none	none
isDefaultPolicy	IsDefaultPolicy	false	none	none