Asynchronous 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

Glasswall Halo Async

Endpoints supporting the inspection and rebuilding of documents through Glasswall Halo asynchronously.

Processes the supplied document in base64 format using Glasswall Halo asynchronously.

Code samples

# You can also use wget
curl -X POST /api/v1/cdr-async \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'X-Session-Id: string'

POST /api/v1/cdr-async HTTP/1.1

Content-Type: application/json
Accept: application/json
X-Session-Id: string

const inputBody = '{
  "base64": "ZG9jdW1lbnQgY29udGVudA==",
  "fileName": "test-file.pdf",
  "password": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-Session-Id':'string'
};

fetch('/api/v1/cdr-async',
{
  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',
  'X-Session-Id' => 'string'
}

result = RestClient.post '/api/v1/cdr-async',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('/api/v1/cdr-async', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

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

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','/api/v1/cdr-async', 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/cdr-async");
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"},
        "X-Session-Id": []string{"string"},
    }

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

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

POST /api/v1/cdr-async

When submitting a document to Glasswall Halo, the required policy settings can optionally be provided, either in the form of specifying a ‘named policy’ or providing a ‘dynamic policy’. A ‘named policy’ can be specified by setting the policyName query parameter. If the specified policy does not exist, then a 404 error will be returned. A ‘dynamic policy’ can be specified in the body of the request by setting the ContentManagementPolicyDetail property. The schema defining the format for the policy settings can be retrieved from the cdr-policy/spec endpoint. If an invalid policy is submitted a 400 error will be returned. As this API processes the given file through Glasswall Halo asynchronously, it will return the “transactionId” for reference.

Body parameter

No policy specified, so the product’s default policy will be applied.

{
  "base64": "ZG9jdW1lbnQgY29udGVudA==",
  "fileName": "test-file.pdf",
  "password": null
}

Parameters

Detailed descriptions

response-content: Defines the output required for the request and depending on the value will determine what Glasswall Halo will do to your file.
Available values: noAnalysisReport, noRebuiltFile.
Multiple values can be provided in a comma seperated list.
If you set noAnalysisReport you will just receive the rebuilt file (Rebuild Mode). If you set noRebuiltFile you will receive the analysis report (Analysis Mode). If you set noRebuiltFile,noAnalysisReport you will receive the file type as a response header (File Type Detection). Leaving this value blank you will receive both the analysis and rebuilt file along with the file type in the header (Composite Mode), this is the default behaviour.

Enumerated Values

Example responses

202 Response

{
  "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"
}

404 Response

{
  "errors": [
    {
      "errorCode": 4000,
      "errorDescription": "Policy 'testpolicy' was not found"
    }
  ]
}

5XX Response

{
  "errors": [
    {
      "errorCode": 44406,
      "errorDescription": "Unable to connect to the database"
    }
  ]
}

Responses

Response Headers

Retrieves the result of the request that was made asynchronously

Code samples

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

GET /api/v1/cdr-async/{transactionId} HTTP/1.1

Accept: application/json

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

fetch('/api/v1/cdr-async/{transactionId}',
{
  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/cdr-async/{transactionId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('/api/v1/cdr-async/{transactionId}', 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/cdr-async/{transactionId}', 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/cdr-async/{transactionId}");
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/cdr-async/{transactionId}", data)
    req.Header = headers

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

GET /api/v1/cdr-async/{transactionId}

Retrieves the result of the request that was made asynchronously

Parameters

Example responses

200 Response

{
  "transactionId": "55cac2bf-d9e1-42cd-b163-30982660fe79",
  "processingStatus": "rebuilt",
  "fileType": "pdf",
  "analysisReport": {
    "content": "YW5hbHlzaXMgcmVwb3J0",
    "contentType": "application/json",
    "contentEncoding": "base64"
  },
  "rebuiltFile": {
    "content": "cmVidWlsdCBmaWxl",
    "contentType": "application/octet-stream",
    "contentEncoding": "base64"
  }
}

206 Response

{
  "errorReason": "Failed to rebuild file",
  "transactionId": "55cac2bf-d9e1-42cd-b163-30982660fe79",
  "processingStatus": "failed",
  "fileType": "pdf",
  "analysisReport": {
    "content": "YW5hbHlzaXMgcmVwb3J0",
    "contentType": "application/json",
    "contentEncoding": "base64"
  }
}

400 Response

{
  "errors": [
    {
      "errorCode": 44400,
      "errorDescription": "Format 'Base64' was requested, but transaction has encoding 'Binary'. Please use the provided endpoint for this encoding."
    }
  ]
}

404 Response

{
  "errors": [
    {
      "errorCode": 44404,
      "errorDescription": "Unable to find the transactionId"
    }
  ]
}

410 Response

{
  "errors": [
    {
      "errorCode": 44401,
      "errorDescription": "Transaction has been cleaned up in accordance to data retention"
    }
  ]
}

500 Error returned if unable to connect to the database

{
  "Errors": [
    {
      "ErrorCode": 4406,
      "ErrorDescription": "Unable to connect to the database"
    }
  ]
}

500 Error returned if unable to retrieve file from storage

{
  "Errors": [
    {
      "ErrorCode": 44405,
      "ErrorDescription": "Unable to determine if file exists"
    }
  ]
}

500 Error returned if file errored on rebuild

{
  "Errors": [
    {
      "ErrorCode": 5002,
      "ErrorDescription": "Unable to rebuild file"
    }
  ]
}

500 Error returned if license is unavailable

{
  "Errors": [
    {
      "ErrorCode": 5002,
      "ErrorDescription": "No license was set within the engine"
    }
  ]
}

Responses

Response Headers

Processes the uploaded file in binary format using the Glasswall Halo asynchronously.

Code samples

# You can also use wget
curl -X POST /api/v1/cdr-file-async \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'X-Session-Id: string' \
  -H 'password: null'

POST /api/v1/cdr-file-async HTTP/1.1

Content-Type: multipart/form-data
Accept: application/json
X-Session-Id: string
password: null

const inputBody = '{
  "file": "string",
  "ContentManagementPolicy": "{\"ContentManagementFlags\":{\"PdfContentManagement\":{\"Acroform\":1,\"ActionsAll\":1,\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Javascript\":1,\"Metadata\":1,\"Watermark\":\"\",\"DigitalSignatures\":1,\"ValueOutsideReasonableLimits\":1,\"RetainExportedStreams\":1},\"WordContentManagement\":{\"DynamicDataExchange\":1,\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Macros\":1,\"Metadata\":1,\"ReviewComments\":1},\"ExcelContentManagement\":{\"DynamicDataExchange\":1,\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Macros\":1,\"Metadata\":1,\"ReviewComments\":1, \"Connections\":1},\"PowerPointContentManagement\":{\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Macros\":1,\"Metadata\":1,\"ReviewComments\":1},\"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},\"SvgConfig\":{\"ForeignObjects\":1,\"Hyperlinks\":1,\"Scripts\":1},\"WebpConfig\":{\"Metadata\":1},\"TiffConfig\":{\"GeoTiff\":1}}}"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'X-Session-Id':'string',
  'password':null
};

fetch('/api/v1/cdr-file-async',
{
  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' => 'multipart/form-data',
  'Accept' => 'application/json',
  'X-Session-Id' => 'string',
  'password' => null
}

result = RestClient.post '/api/v1/cdr-file-async',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json',
  'X-Session-Id': 'string',
  'password': null
}

r = requests.post('/api/v1/cdr-file-async', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'X-Session-Id' => 'string',
    'password' => 'null',
);

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('POST','/api/v1/cdr-file-async', 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/cdr-file-async");
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{"multipart/form-data"},
        "Accept": []string{"application/json"},
        "X-Session-Id": []string{"string"},
        "password": []string{"null"},
    }

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

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

POST /api/v1/cdr-file-async

The endpoint accepts requests to rebuild files asynchronously. The file is sent in the request body as a field in ‘multipart/form-data’. When submitting a document to Glasswall Halo, the required policy settings can optionally be provided, either in the form of specifying a ‘named policy’ or providing a ‘dynamic policy’. A ‘named policy’ can be specified by setting the policyName query parameter. If the specified policy does not exist, then a 404 error will be returned. A ‘dynamic policy’ can be specified in the body of the request by setting the ContentManagementPolicy property. The schema defining the format for the policy settings can be retrieved from the cdr-policy/spec endpoint. If an invalid policy is submitted a 400 error will be returned. As this API processes the given file through Glasswall Halo asynchronously, it will return the “transactionId” for reference.

Body parameter

file: string
ContentManagementPolicy: '{"ContentManagementFlags":{"PdfContentManagement":{"Acroform":1,"ActionsAll":1,"EmbeddedFiles":1,"EmbeddedImages":1,"ExternalHyperlinks":1,"InternalHyperlinks":1,"Javascript":1,"Metadata":1,"Watermark":"","DigitalSignatures":1,"ValueOutsideReasonableLimits":1,"RetainExportedStreams":1},"WordContentManagement":{"DynamicDataExchange":1,"EmbeddedFiles":1,"EmbeddedImages":1,"ExternalHyperlinks":1,"InternalHyperlinks":1,"Macros":1,"Metadata":1,"ReviewComments":1},"ExcelContentManagement":{"DynamicDataExchange":1,"EmbeddedFiles":1,"EmbeddedImages":1,"ExternalHyperlinks":1,"InternalHyperlinks":1,"Macros":1,"Metadata":1,"ReviewComments":1,
  "Connections":1},"PowerPointContentManagement":{"EmbeddedFiles":1,"EmbeddedImages":1,"ExternalHyperlinks":1,"InternalHyperlinks":1,"Macros":1,"Metadata":1,"ReviewComments":1},"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},"SvgConfig":{"ForeignObjects":1,"Hyperlinks":1,"Scripts":1},"WebpConfig":{"Metadata":1},"TiffConfig":{"GeoTiff":1}}}'

Parameters

Detailed descriptions

response-content: Defines the output required for the request and depending on the value will determine what Glasswall Halo will do to your file.
Available values: noAnalysisReport, noRebuiltFile.
Multiple values can be provided in a comma seperated list.
If you set noAnalysisReport you will just receive the rebuilt file (Rebuild Mode). If you set noRebuiltFile you will receive the analysis report (Analysis Mode). If you set noRebuiltFile,noAnalysisReport you will receive the file type as a response header (File Type Detection). Leaving this value blank you will receive both the analysis and rebuilt file along with the file type in the header (Composite Mode), this is the default behaviour.

Enumerated Values

Example responses

202 Response

{
  "transactionId": "ee7b1c04-dade-4abf-b5db-5e3f13b06c2d"
}

404 Response

{
  "errors": [
    {
      "errorCode": 4000,
      "errorDescription": "Policy 'testpolicy' was not found"
    }
  ]
}

5XX Response

{
  "errors": [
    {
      "errorCode": 517,
      "errorDescription": "Unable to connect to the database"
    }
  ]
}

Responses

Response Headers

Retrieves the result of the request that was made asynchronously in binary format

Code samples

# You can also use wget
curl -X GET /api/v1/cdr-file-async/{transactionId} \
  -H 'Accept: application/zip'

GET /api/v1/cdr-file-async/{transactionId} HTTP/1.1

Accept: application/zip

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

fetch('/api/v1/cdr-file-async/{transactionId}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

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

result = RestClient.get '/api/v1/cdr-file-async/{transactionId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.get('/api/v1/cdr-file-async/{transactionId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

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

$client = new \GuzzleHttp\Client();

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

try {
    $response = $client->request('GET','/api/v1/cdr-file-async/{transactionId}', 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/cdr-file-async/{transactionId}");
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/zip"},
    }

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

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

GET /api/v1/cdr-file-async/{transactionId}

Retrieves the result of the request that was made asynchronously in binary format

Parameters

Example responses

200 Response

CDR OK.

The content returned in the response is dependant on the setting of the responseContent query parameter during the submission of an asynchronous request.

When processing an archive file the same return content is used, with the exception of when noRebuiltFile is selected.

{
  "?xml": {
    "@version": "1.0",
    "@encoding": "utf-8"
  },
  "gw:GWallInfo": {
    "...": null
  }
}

Glasswall Halo request is completed with the status of “failed”. Analysis report is returned.

{
  "?xml": {
    "@version": "1.0",
    "@encoding": "utf-8"
  },
  "gw:GWallInfo": {
    "...": null
  }
}

400 Response

{
  "errors": [
    {
      "errorCode": 44400,
      "errorDescription": "Format 'Base64' was requested, but transaction has encoding 'Binary'. Please use the provided endpoint for this encoding."
    }
  ]
}

404 Response

{
  "errors": [
    {
      "errorCode": 44404,
      "errorDescription": "Unable to find the transactionId"
    }
  ]
}

410 Response

{
  "errors": [
    {
      "errorCode": 44401,
      "errorDescription": "Transaction has been cleaned up in accordance to data retention"
    }
  ]
}

500 Error returned if unable to connect to the database

{
  "Errors": [
    {
      "ErrorCode": 517,
      "ErrorDescription": "Unable to connect to the database"
    }
  ]
}

500 Error returned if unable to retrieve file from storage

{
  "Errors": [
    {
      "ErrorCode": 44405,
      "ErrorDescription": "Unable to determine if file exists"
    }
  ]
}

500 Error returned if file errored on rebuild

{
  "Errors": [
    {
      "ErrorCode": 5002,
      "ErrorDescription": "Unable to rebuild file"
    }
  ]
}

500 Error returned if license is unavailable

{
  "Errors": [
    {
      "ErrorCode": 5002,
      "ErrorDescription": "No license was set within the engine"
    }
  ]
}

Responses

The content returned in the response is dependant on the setting of the responseContent query parameter during the submission of an asynchronous request.

When processing an archive file the same return content is used, with the exception of when noRebuiltFile is selected.

Response Headers

Schemas

CdrRequestBody

{
  "base64": "ZG9jdW1lbnQgY29udGVudA==",
  "fileName": "test-file.pdf",
  "password": null,
  "contentManagementPolicyDetail": "{\"ContentManagementFlags\":{\"PdfContentManagement\":{\"Acroform\":1,\"ActionsAll\":1,\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Javascript\":1,\"Metadata\":1,\"Watermark\":\"\",\"DigitalSignatures\":1,\"ValueOutsideReasonableLimits\":1,\"RetainExportedStreams\":1},\"WordContentManagement\":{\"DynamicDataExchange\":1,\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Macros\":1,\"Metadata\":1,\"ReviewComments\":1},\"ExcelContentManagement\":{\"DynamicDataExchange\":1,\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Macros\":1,\"Metadata\":1,\"ReviewComments\":1, \"Connections\":1},\"PowerPointContentManagement\":{\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Macros\":1,\"Metadata\":1,\"ReviewComments\":1},\"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},\"SvgConfig\":{\"ForeignObjects\":1,\"Hyperlinks\":1,\"Scripts\":1},\"WebpConfig\":{\"Metadata\":1},\"TiffConfig\":{\"GeoTiff\":1}}}"
}

Properties

CdrFileRequestBody

{
  "file": "string",
  "ContentManagementPolicy": "{\"ContentManagementFlags\":{\"PdfContentManagement\":{\"Acroform\":1,\"ActionsAll\":1,\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Javascript\":1,\"Metadata\":1,\"Watermark\":\"\",\"DigitalSignatures\":1,\"ValueOutsideReasonableLimits\":1,\"RetainExportedStreams\":1},\"WordContentManagement\":{\"DynamicDataExchange\":1,\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Macros\":1,\"Metadata\":1,\"ReviewComments\":1},\"ExcelContentManagement\":{\"DynamicDataExchange\":1,\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Macros\":1,\"Metadata\":1,\"ReviewComments\":1, \"Connections\":1},\"PowerPointContentManagement\":{\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Macros\":1,\"Metadata\":1,\"ReviewComments\":1},\"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},\"SvgConfig\":{\"ForeignObjects\":1,\"Hyperlinks\":1,\"Scripts\":1},\"WebpConfig\":{\"Metadata\":1},\"TiffConfig\":{\"GeoTiff\":1}}}"
}

Properties

CdrFileResponseZipBody

"string"

An archive file containing both the rebuilt file and associated analysis report.

Properties

CdrFileResponseBinaryBody

"string"

Properties

CdrFileResponseAnalysisXmlBody

"string"

Properties

CdrFileResponseAnalysisJsonBody

"string"

Properties

XAppliedPolicy

"service-dynamic"

Identifies the policy applied during Glasswall Halo processing.

• (name) the named policy that was applied
• default the configured default policy was applied
• service-dynamic a dynamic policy was submitted with the request and applied
• service-fallback the fallback policy was applied since the specified policy was not available

Properties

Enumerated Values

XFileReputationStatus

"Known"

Response status from the file reputation service.

• Known File hash is known, but found to be benign.
• Unknown File hash has not been seen by the File Reputation Service before.
• Malicious File hash is classified as Malicious.
• Suspicious File hash is considered suspicious based on the File Reputation Services classification algorithm.

Properties

Enumerated Values

QueryPolicyName

"string"

Identifies the policy. The name should consist of only alphanumeric characters [A-Za-z0-9].

Properties

QueryReportFormat

"XML"

Properties

Enumerated Values

QueryReturnExecutableFile

false

Properties

QuerySessionId

"string"

Properties

CdrDocumentContent

"ZG9jdW1lbnQgY29udGVudA=="

The content of the document being submitted, base64 encoded.

Properties

FileName

"test-file.pdf"

Specifies content filename.

Properties

FilePassword

null

Specifies the password to be applied when attempting to open the supplied content (Only applies to Archive files).

Properties

PolicySettings

"{\"ContentManagementFlags\":{\"PdfContentManagement\":{\"Acroform\":1,\"ActionsAll\":1,\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Javascript\":1,\"Metadata\":1,\"Watermark\":\"\",\"DigitalSignatures\":1,\"ValueOutsideReasonableLimits\":1,\"RetainExportedStreams\":1},\"WordContentManagement\":{\"DynamicDataExchange\":1,\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Macros\":1,\"Metadata\":1,\"ReviewComments\":1},\"ExcelContentManagement\":{\"DynamicDataExchange\":1,\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Macros\":1,\"Metadata\":1,\"ReviewComments\":1, \"Connections\":1},\"PowerPointContentManagement\":{\"EmbeddedFiles\":1,\"EmbeddedImages\":1,\"ExternalHyperlinks\":1,\"InternalHyperlinks\":1,\"Macros\":1,\"Metadata\":1,\"ReviewComments\":1},\"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},\"SvgConfig\":{\"ForeignObjects\":1,\"Hyperlinks\":1,\"Scripts\":1},\"WebpConfig\":{\"Metadata\":1},\"TiffConfig\":{\"GeoTiff\":1}}}"

The policy settings are defined in the schema and included here in JSON format.

Properties

None

CdrErroredBody

{
  "errors": [
    {
      "errorCode": 0,
      "errorDescription": "string"
    }
  ]
}

Contains the details of errors raised whilst processing a document.

Properties

CdrErrors

[
  {
    "errorCode": 0,
    "errorDescription": "string"
  }
]

Properties

CdrErrorReason

"string"

Properties

CdrProcessingStatus

"failed"

Properties

Enumerated Values

CdrFileType

"string"

Properties

CdrResponseContent

{
  "content": "string",
  "contentType": "string",
  "contentEncoding": "string"
}

Properties

CDRAsyncAcknowledgement

{
  "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"
}

Properties

CDRAsyncTransactionId

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

TransactionID that corresponds to the asynchronous request

Properties

CdrAsyncCompleteBody

{
  "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  "processingStatus": "failed",
  "fileType": "string",
  "analysisReport": {
    "content": "string",
    "contentType": "string",
    "contentEncoding": "string"
  },
  "rebuiltFile": {
    "content": "string",
    "contentType": "string",
    "contentEncoding": "string"
  }
}

Contains the results of document succeffully rebuilt by Glasswall Halo

Properties

CdrAsyncPartialBody

{
  "errorReason": "string",
  "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  "processingStatus": "failed",
  "fileType": "string",
  "analysisReport": {
    "content": "string",
    "contentType": "string",
    "contentEncoding": "string"
  }
}

Contains the results of an document that failed to be rebuilt Glasswall Halo

Properties

CacheControlHeader

"no-store"

Prevent sensitive information from being cached.

Properties

ContentTypeHeader

"application/json"

Indicates the response content type

Properties

ContentTypeOptionsHeader

"nosniff"

To prevent browsers from performing MIME sniffing, and inappropriately interpreting responses as HTML.

Properties

FrameOptionsHeader

"DENY"

To protect against drag-and-drop style clickjacking attacks.

Properties

ContentSecurityPolicyHeader

"frame-ancestors 'none'"

To protect against drag-and-drop style clickjacking attacks.

Properties

StrictTransportSecurityHeader

"max-age=31536000"

Uses a week long max-age to prevent any communications from being sent to this domain over HTTP

Properties