XML 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

XMLPolicyManagement

Create XML Policy

Code samples

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

POST /api/v1/xml-policies/{XMLPolicyName} HTTP/1.1

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

const inputBody = '{
  "status": "enabled",
  "policySettings": {
    "EnableWarningHandling": false,
    "BlockedTags": [
      "/XInclude:include",
      "/XSL/Transform:stylesheet"
    ],
    "AllowedEncodings": [
      "utf-8",
      "utf-16",
      "iso-8859-1"
    ],
    "AllowEmptyEncoding": true,
    "AllowDoctypeInCData": false
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v1/xml-policies/{XMLPolicyName}',
{
  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/xml-policies/{XMLPolicyName}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('/api/v1/xml-policies/{XMLPolicyName}', 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/xml-policies/{XMLPolicyName}', 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/xml-policies/{XMLPolicyName}");
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/xml-policies/{XMLPolicyName}", data)
    req.Header = headers

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

POST /api/v1/xml-policies/{XMLPolicyName}

Creates a named XML Policy with the provided values

Body parameter

{
  "status": "enabled",
  "policySettings": {
    "EnableWarningHandling": false,
    "BlockedTags": [
      "/XInclude:include",
      "/XSL/Transform:stylesheet"
    ],
    "AllowedEncodings": [
      "utf-8",
      "utf-16",
      "iso-8859-1"
    ],
    "AllowEmptyEncoding": true,
    "AllowDoctypeInCData": false
  }
}

Parameters

Example responses

201 Response

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

Responses

Update XML Policy

Code samples

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

PUT /api/v1/xml-policies/{XMLPolicyName} HTTP/1.1

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

const inputBody = '{
  "status": "enabled",
  "policySettings": {
    "EnableWarningHandling": false,
    "BlockedTags": [
      "/XInclude:include",
      "/XSL/Transform:stylesheet"
    ],
    "AllowedEncodings": [
      "utf-8",
      "utf-16",
      "iso-8859-1"
    ],
    "AllowEmptyEncoding": true,
    "AllowDoctypeInCData": false
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/v1/xml-policies/{XMLPolicyName}',
{
  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/xml-policies/{XMLPolicyName}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put('/api/v1/xml-policies/{XMLPolicyName}', 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/xml-policies/{XMLPolicyName}', 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/xml-policies/{XMLPolicyName}");
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/xml-policies/{XMLPolicyName}", data)
    req.Header = headers

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

PUT /api/v1/xml-policies/{XMLPolicyName}

Updates a named XML Policy with the provided values

Body parameter

{
  "status": "enabled",
  "policySettings": {
    "EnableWarningHandling": false,
    "BlockedTags": [
      "/XInclude:include",
      "/XSL/Transform:stylesheet"
    ],
    "AllowedEncodings": [
      "utf-8",
      "utf-16",
      "iso-8859-1"
    ],
    "AllowEmptyEncoding": true,
    "AllowDoctypeInCData": false
  }
}

Parameters

Example responses

200 Response

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

Responses

Get XML Policy

Code samples

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

GET /api/v1/xml-policies/{XMLPolicyName} HTTP/1.1

Accept: application/json

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

fetch('/api/v1/xml-policies/{XMLPolicyName}',
{
  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/xml-policies/{XMLPolicyName}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

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

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

GET /api/v1/xml-policies/{XMLPolicyName}

Gets a named XML Policy

Parameters

Example responses

200 Response

{
  "schemaName": "xmlvalidationv1",
  "policyName": "default",
  "policyIdentity": "11111111-1111-1111-1111-111111111111",
  "policyVersion": 2,
  "isDefaultPolicy": true,
  "status": "enabled",
  "schemaReferences": [],
  "policySettings": {
    "EnableWarningHandling": false,
    "BlockedTags": [
      "/XInclude:include",
      "/XSL/Transform:stylesheet"
    ],
    "AllowedEncodings": [
      "utf-8",
      "utf-16",
      "iso-8859-1"
    ],
    "AllowEmptyEncoding": true,
    "AllowDoctypeInCData": false
  }
}

Responses

Response Schema

Enumerated Values

Delete XML Policy

Code samples

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

DELETE /api/v1/xml-policies/{XMLPolicyName} HTTP/1.1

fetch('/api/v1/xml-policies/{XMLPolicyName}',
{
  method: 'DELETE'

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

require 'rest-client'
require 'json'

result = RestClient.delete '/api/v1/xml-policies/{XMLPolicyName}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/api/v1/xml-policies/{XMLPolicyName}')

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/xml-policies/{XMLPolicyName}', 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/xml-policies/{XMLPolicyName}");
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/xml-policies/{XMLPolicyName}", data)
    req.Header = headers

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

DELETE /api/v1/xml-policies/{XMLPolicyName}

Delete the specified XML Policy

Parameters

Responses

Get All XML Policies

Code samples

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

GET /api/v1/xml-policies HTTP/1.1

Accept: application/json

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

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

p JSON.parse(result)

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

r = requests.get('/api/v1/xml-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/xml-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/xml-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/xml-policies", data)
    req.Header = headers

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

GET /api/v1/xml-policies

Gets a full list of all configured XML Policies

Example responses

200 Response

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

Responses

Response Schema

Status Code 200

Reset XML Policy

Code samples

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

PUT /api/v1/xml-policies/{XMLPolicyName}/reset HTTP/1.1

Accept: application/json

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

fetch('/api/v1/xml-policies/{XMLPolicyName}/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/xml-policies/{XMLPolicyName}/reset',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put('/api/v1/xml-policies/{XMLPolicyName}/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/xml-policies/{XMLPolicyName}/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/xml-policies/{XMLPolicyName}/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/xml-policies/{XMLPolicyName}/reset", data)
    req.Header = headers

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

PUT /api/v1/xml-policies/{XMLPolicyName}/reset

Resets a named XML Policy to the default schema values

Parameters

Example responses

200 Response

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

Responses

Schemas

PolicyMetadata

{
  "EnableWarningHandling": false,
  "BlockedTags": [
    "/XInclude:include",
    "/XSL/Transform:stylesheet"
  ],
  "AllowedEncodings": [
    "utf-8",
    "utf-16",
    "iso-8859-1"
  ],
  "AllowEmptyEncoding": true,
  "AllowDoctypeInCData": false
}

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

Properties

Status

"enabled"

Properties

Enumerated Values

WritePolicyBody

{
  "status": "enabled",
  "policySettings": {
    "EnableWarningHandling": false,
    "BlockedTags": [
      "/XInclude:include",
      "/XSL/Transform:stylesheet"
    ],
    "AllowedEncodings": [
      "utf-8",
      "utf-16",
      "iso-8859-1"
    ],
    "AllowEmptyEncoding": true,
    "AllowDoctypeInCData": false
  }
}

The policy settings to be set for a named policy

Properties

WritePolicyBodyResponse

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

Properties

allOf

and

PolicyCommonProperties

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

Properties

SchemaName

"xmlvalidationv1"

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

PolicyVersion

2

Identifies the version of the Policy.

Properties

PolicyLocation

"api/v1/schemas/xmlvalidationv1/policies/policyName"

Properties

PolicyIdentity

"11111111-1111-1111-1111-111111111111"

Properties

PolicyName

"default"

Properties

IsDefaultPolicy

true

Properties

GetAllPolicyItem

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

Properties