Validate Xml

API endpoints to validate XML documents against their schema definitions and/or predefined scanning rules

/api/v1/validate-xml

POST

https://api.glasswall.com

/api/v1/validate-xml

Parses and validates an XML string against a provided schema and/or predefined set of rules

This endpoint accepts requests to validate an XML document against a provided XML schema definition. Alternatively or in addition to, the endpoint can scan the provided XML document against Glasswall's set of predefined rules.'

/api/v1/validate-xml › query Parameters

policyName

string

Named policy to configure XML validation call

/api/v1/validate-xml › Headers

X-Session-Id

string

A string that can be used to group requests in reports

/api/v1/validate-xml › Request Body

file

string · required

This field contains the XML document to be validated.

Example: <?xml version="1.0" encoding="UTF-8"?> <example> <field>Value</field> </example>

schema

string · required

Required if Validate is set to 'true'. This field contains the XML Schema definition to validate the document against.

Example: <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="example"> <xs:complexType> <xs:sequence> <xs:element name="field" type="xs:string" /> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>

policy

string · json

Inline policy to configure xml validation behaviours

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

/api/v1/validate-xml › Responses

XmlValidationResponse

validationResults

string[]

Errors encountered when validating the provided XML document

POST/api/v1/validate-xml

curl https://api.glasswall.com/api/v1/validate-xml \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --header 'Authorization: Basic <credentials>' \
  --form 'file=<?xml version="1.0" encoding="UTF-8"?>
<example>
  <field>Value</field>
</example>' \
  --form 'schema=<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="example">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="field" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>' \
  --form 'policy={
  "EnableWarningHandling": false,
  "BlockedTags": [
    "/XInclude:include",
    "/XSL/Transform:stylesheet"
  ],
  "AllowedEncodings": [
    "utf-8",
    "utf-16",
    "iso-8859-1"
  ],
  "AllowEmptyEncoding": true,
  "AllowDoctypeInCData": false
}'

Example Request Body

{
  "file": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<example>\n  <field>Value</field>\n</example>",
  "schema": "<xs:schema attributeFormDefault=\"unqualified\" elementFormDefault=\"qualified\" xmlns:xs=\"http://www.w3.org/2001/XMLSchema\">\n  <xs:element name=\"example\">\n    <xs:complexType>\n      <xs:sequence>\n        <xs:element name=\"field\" type=\"xs:string\" />\n      </xs:sequence>\n    </xs:complexType>\n  </xs:element>\n</xs:schema>",
  "policy": "{\n  \"EnableWarningHandling\": false,\n  \"BlockedTags\": [\n    \"/XInclude:include\",\n    \"/XSL/Transform:stylesheet\"\n  ],\n  \"AllowedEncodings\": [\n    \"utf-8\",\n    \"utf-16\",\n    \"iso-8859-1\"\n  ],\n  \"AllowEmptyEncoding\": true,\n  \"AllowDoctypeInCData\": false\n}"
}

text

Example Responses

{
  "ValidationResults": [
    "The prefix 'xs' for element 'xs:schema' is not bound."
  ]
}

json

Error returned if the XML document failed validation against the schema, or fails check against a list of predefined rules.

application/json

/api/v1/validate-xml

POST

https://api.glasswall.com

/api/v1/validate-xml

Parses and validates an XML string against a provided schema and/or predefined set of rules

/api/v1/validate-xml › query Parameters

policyName

string

Named policy to configure XML validation call

/api/v1/validate-xml › Headers

X-Session-Id

string

A string that can be used to group requests in reports

/api/v1/validate-xml › Request Body

file

string · required

This field contains the XML document to be validated.

Example: <?xml version="1.0" encoding="UTF-8"?> <example> <field>Value</field> </example>

schema

string · required

Required if Validate is set to 'true'. This field contains the XML Schema definition to validate the document against.

policy

string · json

Inline policy to configure xml validation behaviours

/api/v1/validate-xml › Responses

XmlValidationResponse

validationResults

string[]

Errors encountered when validating the provided XML document