Enterprise Recon v1 API
Group and Target Reports
Use this set of APIs to generate and download reports for a Group, Target or a Global Summary report.
Download the Summary Report
Download Global Summary report which includes a summary of all Targets scanned to-date, and a breakdown of matches by platform, Group, Targets, Data Type and File Format.
Request
GET
https://er-master:8339/v1/summary/report
Authorization
Query Parameters
| Parameter | Data Type | Description |
|---|---|---|
| pdf_page_size |
string enum: letter a4 |
Specify the PDF report page size. Only applicable if PDF is the selected media response format. |
Header Parameters
| Parameter | Data Type | Description |
|---|---|---|
| Accept |
string default: text/plain enum: text/plain text/csv text/html application/xml application/pdf application/json |
Response media format. Due to the maximum integer limit in JSON encoding, all numeric values in JSON encoded reports will be represented as strings. |
Request Samples
HTTP
GET /v1/summary/report?pdf_page_size=letter
Accept: application/pdf
cURL
curl --request GET 'https://er-master:8339/v1/summary/report?pdf_page_size=letter' \
--user apiuser:password123 \
--header "Accept: application/pdf"
Response Samples
Download the Target Group Report
Download Target Group report for a specific Group. The report provides a summary of all Targets in the Group that have been scanned to-date, and a breakdown of matches by platform, Targets, Data Type and File Format.
Request
GET
https://er-master:8339/v1/groups/<group_id>/report
Authorization
Path Parameters
| Parameter | Data Type | Description |
|---|---|---|
| group_id |
string |
Group ID of the Group to retrieve data for. group_id is the id response item from the /v1/groups/all endpoint. |
Query Parameters
| Parameter | Data Type | Description |
|---|---|---|
| pdf_page_size |
string enum: letter a4 |
Specify the PDF report page size. Only applicable if PDF is the selected media response format. |
Header Parameters
| Parameter | Data Type | Description |
|---|---|---|
| Accept |
string default: text/plain enum: text/plain text/csv text/html application/xml application/pdf application/json |
Response media format. Due to the maximum integer limit in JSON encoding, all numeric values in JSON encoded reports will be represented as strings. |
Request Samples
HTTP
GET /v1/groups/16145931871908944000/report
Accept: application/pdf
cURL
curl --request GET 'https://er-master:8339/v1/groups/16145931871908944000/report' \
--user apiuser:password123 \
--header "Accept: application/pdf"
Response Samples
List All Consolidated or Isolated Target Reports
Lists all available Consolidated or Isolated reports for a specific Target.
Request
GET
https://er-master:8339/v1/targets/<target_id>/<report_type>
Authorization
Path Parameters
| Parameter | Data Type | Description |
|---|---|---|
| target_id |
string |
Specify Target to retrieve data for. target_id is the targets->id response item from the /v1/groups/all endpoint. |
| report_type |
string enum: consolidated isolated |
Consolidated or isolated Target report. |
Request Samples
HTTP
GET /v1/targets/4759598330602895744/isolated
Accept: application/json
cURL
curl --request GET 'https://er-master:8339/v1/targets/4759598330602895744/isolated' \
--user apiuser:password123 \
--header "Accept: application/json"
Response Schema
200 OK
| Parameter | Data Type | Description |
|---|---|---|
| - |
string <array> |
List of report IDs. This report_id is the concatenated value of the report timestamp (in Unix time format) and scan ID for the scan. |
Response Samples
200 OK
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
[
"1652400161-14681556993219427045",
"1652068032-14378634313338250716",
"1652065751",
"1652065597"
]
Download Consolidated or Isolated Target Report
Download Consolidated or Isolated report for a specific Target. The report provides a summary of all Target Locations that have been scanned to-date, and a breakdown of matches by match status, Data Type and File Format.
Request
GET
https://er-master:8339/v1/targets/<target_id>/<report_type>/<report_id>
Authorization
Path Parameters
| Parameter | Data Type | Description |
|---|---|---|
| target_id |
string |
Specify Target to retrieve data for. target_id is the targets->id response item from the /v1/groups/all endpoint. |
| report_type |
string enum: consolidated isolated |
Consolidated or isolated Target report. |
| report_id |
string |
Specify the report_id of the Target report to be generated. Get the report_id information from the /v1/targets/<target_id>/<report_type> endpoint. |
Query Parameters
| Parameter | Data Type | Description |
|---|---|---|
| pdf_page_size |
string enum: letter a4 |
Specify the PDF report page size. Only applicable if PDF is the selected media response format. |
| samples |
boolean enum: true false |
Set true to include contextual data for match samples in the generated Target report. |
| details |
boolean enum: true false |
Set true to include details on each matched stream. Only applicable to CSV report formats. |
| metadata |
boolean enum: true false |
Set true to include metadata in the generated report. See Metadata for the list of possible ER2 metadata values. |
Header Parameters
| Parameter | Data Type | Description |
|---|---|---|
| Accept |
string default: text/plain enum: text/plain text/csv text/html application/xml application/pdf application/json |
Response media format. Due to the maximum integer limit in JSON encoding, all numeric values in JSON encoded reports will be represented as strings. |
Request Samples
HTTP
GET /v1/targets/4759598330602895744/isolated/1652399413-326535879799420269?samples=true&details=true
Accept: text/csv
cURL
curl --request GET 'https://er-master:8339/v1/targets/4759598330602895744/isolated/1652399413-326535879799420269?samples=true&details=true' \
--user apiuser:password123 \
--header "Accept: text/csv"
Response Samples
Download Raw Isolated Target Report
Download the raw Isolated report for a specific Target. The report includes detailed information such as the scanned locations, inaccessible locations, match count, metadata and data types found during a specific scan schedule for the Target.
Empty arrays, objects, strings or integers with value of 0 may not be returned in the response.
Request
GET
https://er-master:8339/v1/targets/<target_id>/rawisolated/<report_id>
Authorization
Path Parameters
| Parameter | Data Type | Description |
|---|---|---|
| target_id |
string |
Specify Target to retrieve data for. target_id is the targets->id response item from the /v1/groups/all endpoint. |
| report_id |
string |
Specify the report_id of the Raw Isolated Target report to be generated. Get the report_id information from the /v1/targets/<target_id>/isolated endpoint. Raw Isolated Reports can only be generated for scan schedules that were executed using ER 2.0.30 and later. |
Query Parameters
| Parameter | Data Type | Description |
|---|---|---|
| match_data_limit |
integer default: 0 |
Maximum number of match data results to return per match location. If no value is specified or match_data_limit=0, query will return data for all available match data results for all match locations. |
Header Parameters
| Parameter | Data Type | Description |
|---|---|---|
| Accept |
string enum: application/json |
Set application/json to download the raw isolated report. |
| Accept-Encoding |
string enum: gzip deflate |
Specify the compression algorithm to use on the response object.
Compressed content will not be returned for endpoints that return reports as files (e.g. PDF, CSV etc), endpoints that return binary files (e.g. Node Agent installers) or unsuccessful API calls. |
Request Samples
HTTP
GET /v1/targets/4759598330602895744/rawisolated/1652399413-326535879799420269?match_data_limit=1000
Accept: application/json
cURL
curl --request GET 'https://er-master:8339/v1/targets/4759598330602895744/rawisolated/1652399413-326535879799420269?match_data_limit=1000' \
--user apiuser:password123 \
--header "Accept: application/json"
Response Schema
200 OK
| Parameter | Data Type | Description |
|---|---|---|
| label |
string |
Descriptive label for the scan schedule. |
| target |
string |
Target name. |
| group |
string |
Group the Target belongs to. |
| platform |
string example: Windows 10 64bit |
Platform name. Will not be returned if platform is unknown. |
| path |
string |
Root search path defined for Target. Value will be blank if no search path was specified during when setting up the scan schedule. |
| timestamp |
number |
Timestamp for the Isolated Report generation in Unix time format. |
| start |
number |
Timestamp for when the scan started in Unix time format. |
| end |
number |
Timestamp for when the scan ended in Unix time format. |
| match_locations |
string |
Total number of locations containing matches data privacy breach patterns and prohibited PCI data patterns for the scan schedule. |
| match |
string |
Total number of matches with data privacy breach patterns. |
| prohibited |
string |
Total number of matches containing prohibited PCI data patterns. |
| test |
string |
Total number of matches containing test data patterns. |
| scanned_bytes |
string <bytes> |
Total amount of data scanned for the scan schedule. Unit is in bytes. |
| scanned_locations |
integer |
Total number of scanned locations for the scan schedule. |
| inaccessible_locations |
string |
Total number of inaccessible locations for the scan schedule. |
| match_locations_overflow |
integer |
Total number of Target locations containing matches with data privacy breaches and prohibited PCI data that were not saved with complete match information (e.g. context details, metadata etc). Not returned if all match locations with data privacy breaches and prohibited PCI data matches were saved with complete information. |
| test_locations_overflow |
integer |
Total number of Target locations containing test data patterns that were not saved with complete test data information (e.g. context details, metadata etc). Not returned if all match locations with test data patterns were saved with complete information. |
| failed |
boolean enum: true false |
Returns true if the scan had failed. |
| stopped |
boolean enum: true false |
Returns true if the scan was manually stopped by a user. |
| inaccess |
array <objects> |
Array of inaccessible locations. |
| inaccess/path |
string |
Path of the inaccessible location. |
| inaccess/description |
string |
Details about the inaccessible location. |
| inaccess/severity |
string enum: notice error critical |
Severity level for the inaccessible location. |
| data_types |
array <objects> |
Array of data types enabled for the scan schedule. |
| data_types/name |
string |
Data type name. |
| data_types/match |
string |
Number of data privacy breaches matches for the data type. |
| data_types/prohibited |
string |
Number of prohibited PCI data matches for the data type. |
| data_types/test |
string |
Number of test pattern matches for the data type. |
| content_types |
array <objects> |
Array of file formats or content types (e.g. ZIP archive, HTML/XML document, Rich Text Document) containing matches with data privacy breaches and prohibited PCI data. |
| content_types/name |
string |
File formats or content type (e.g. ZIP archive, HTML/XML document, Rich Text Document). |
| content_types/match |
string |
Number of data privacy breaches matches for the file format or content type. |
| content_types/prohibited |
string |
Number of prohibited PCI data matches for the file format or content type. |
| content_types/test |
string |
Number of test pattern matches for the file format or content type. |
| filters |
array <objects> |
Array of global filters enabled for the scan schedule. |
| filters/type |
string |
Global filter type. |
| filters/values |
array <string> |
Array of expressions or values defined for the global filter type. |
| filters/overflow |
integer |
Indicates the number of filters that are not included in the response. |
| test_summary |
array |
Array of Target locations containing test pattern matches. |
| test_summary/path |
string |
Path to the location or object containing test pattern matches. |
| test_summary/count |
string |
Total number of test pattern matches. |
| test_summary/metadata |
array <objects> |
Array of metadata information for the location or object containing test pattern matches. See Metadata for the list of possible ER2 metadata values. |
| test_summary/metadata/label |
string |
Label describing the type of metadata. |
| test_summary/metadata/values |
string |
Array of metadata values. |
| test_summary/data_types |
array <objects> |
Array of matched data types for the location or object. |
| test_summary/data_types/name |
string |
Data type name. |
| test_summary/data_types/count |
string |
Number of matches for the data type. |
| test_summary/data_types/metadata |
array <objects> |
Array of metadata information for the location or object containing test pattern matches. See Metadata for the list of possible ER2 metadata values. |
| test_summary/data_types/metadata/label |
string |
Label describing the type of metadata. |
| test_summary/data_types/metadata/values |
string |
Array of metadata values. |
| test_summary/data_types/match_data |
array <string> |
Array of match data. |
| prohibited_summary |
array |
Array of Target locations containing prohibited PCI data matches. |
| prohibited_summary/path |
string |
Path to the location or object containing prohibited PCI data matches. |
| prohibited_summary/count |
string |
Total number of prohibited PCI data matches. |
| prohibited_summary/metadata |
array <objects> |
Array of metadata information for the location or object containing prohibited PCI data matches. See Metadata for the list of possible ER2 metadata values. |
| prohibited_summary/metadata/label |
string |
Label describing the type of metadata. |
| prohibited_summary/metadata/values |
string |
Array of metadata values. |
| prohibited_summary/data_types |
array <objects> |
Array of matched data types for the location or object. |
| prohibited_summary/data_types/name |
string |
Data type name. |
| prohibited_summary/data_types/count |
string |
Number of matches for the data type. |
| prohibited_summary/data_types/metadata |
array <objects> |
Array of metadata information for the location or object containing prohibited PCI data matches. See Metadata for the list of possible ER2 metadata values. |
| prohibited_summary/data_types/metadata/label |
string |
Label describing the type of metadata. |
| prohibited_summary/data_types/metadata/values |
string |
Array of metadata values. |
| prohibited_summary/data_types/match_data |
array <string> |
Array of match data. |
| locations |
array |
Array of Target locations containing matches with data privacy breaches and prohibited PCI data. |
| locations/path |
string |
Path to the location or object containing matches with data privacy breaches and prohibited PCI data. |
| locations/count |
string |
Total number of matches with data privacy breaches and prohibited PCI data. |
| locations/metadata |
array <objects> |
Array of metadata information for the location or object containing matches with data privacy breaches and prohibited PCI data. See Metadata for the list of possible ER2 metadata values. |
| locations/metadata/label |
string |
Label describing the type of metadata. |
| locations/metadata/values |
string |
Array of metadata values. |
| locations/data_types |
array <objects> |
Array of matched data types for the location or object. |
| locations/data_types/name |
string |
Data type name. |
| locations/data_types/count |
string |
Number of matches for the data type. |
| locations/data_types/metadata |
array <objects> |
Array of metadata information for the location or object containing matches with data privacy breaches and prohibited PCI data. See Metadata for the list of possible ER2 metadata values. |
| locations/data_types/metadata/label |
string |
Label describing the type of metadata. |
| locations/data_types/metadata/values |
string |
Array of metadata values. |
| locations/data_types/match_data |
array <string> |
Array of match data. |
| locations/sublocations |
array |
Array of sub-locations containing matches with data privacy breaches and prohibited PCI data.
Match locations can contain multiple levels of nested sublocations.
For example, if a match was found in a ZIP file containing a PDF, the match location data would
be accessed via locations (GZIP) -> sublocations (PDF)
-> sublocations (pdf).
Not returned if there are no sub-locations or sub-paths for the Target location. |
| locations/sublocations/path |
string |
Path to the location or object containing matches with data privacy breaches and prohibited PCI data. |
| locations/sublocations/count |
string |
Total number of matches with data privacy breaches and prohibited PCI data. |
| locations/sublocations/metadata |
array <objects> |
Array of metadata information for the location or object containing matches with data privacy breaches and prohibited PCI data. See Metadata for the list of possible ER2 metadata values. |
| locations/sublocations/metadata/label |
string |
Label describing the type of metadata. |
| locations/sublocations/metadata/values |
string |
Array of metadata values. |
| locations/sublocations/data_types |
array <objects> |
Array of matched data types for the location or object. |
| locations/sublocations/data_types/name |
string |
Data type name. |
| locations/sublocations/data_types/count |
string |
Number of matches for the data type. |
| locations/sublocations/data_types/metadata |
array <objects> |
Array of metadata information for the location or object containing matches with data privacy breaches and prohibited PCI data. See Metadata for the list of possible ER2 metadata values. |
| locations/sublocations/data_types/metadata/label |
string |
Label describing the type of metadata. |
| locations/sublocations/data_types/metadata/values |
string |
Array of metadata values. |
| locations/sublocations/data_types/match_data |
array <string> |
Array of match data. |
Response Samples
Sample raw isolated report response for a Target location with plain text, Office ODS and 7Z archive files.
200 OK
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
{
"label": "MY-WINDOWS-HOST File path D:\\Sample-Data\\Txt-ODS-7z JUL24-1011",
"target": "MY-WINDOWS-HOST",
"group": "DEFAULT GROUP",
"platform": "Windows 10 64bit",
"path": "File path D:\\Sample-Data\\Txt-ODS-7z",
"timestamp": 1595556668,
"start": 1595556669,
"end": 1595556669,
"match_locations": "4",
"match": "69",
"prohibited": "6",
"test": "1",
"scanned_bytes": "58508",
"scanned_locations": 4,
"inaccessible_locations": 1,
"failed": false,
"stopped": false,
"data_types": [
{
"match": "24",
"name": "American Express"
},
{
"match": "8",
"name": "SWIFT Code"
},
{
"match": "6",
"name": "European EHIC"
},
{
"match": "5",
"name": "Personal Names (English)"
},
{
"match": "4",
"name": "Polish Telephone Number (robust)"
},
{
"match": "4",
"name": "Portuguese Phone Number (robust)"
},
{
"match": "4",
"name": "Luxembourg Phone Number (robust)"
},
{
"match": "4",
"name": "German Personalausweis (robust)"
},
{
"prohibited": "3",
"name": "Track 2"
},
{
"match": "2",
"name": "Email addresses"
},
{
"match": "2",
"name": "French CNI (robust)"
},
{
"prohibited": "2",
"name": "Visa"
},
{
"match": "2",
"name": "United Kingdom National Health Service Number (robust)"
},
{
"match": "2",
"name": "Australian Medicare Card (robust)"
},
{
"test": "1",
"name": "Test Data"
},
{
"match": "1",
"name": "Australian Mailing Address"
},
{
"prohibited": "1",
"name": "Mastercard"
},
{
"match": "1",
"name": "United States Telephone Number (robust)"
},
{
"name": "MAC Address"
},
{
"name": "Polish Telephone Number"
},
{
"name": "United States Telephone Number"
},
{
"name": "Portuguese Phone Number"
},
{
"name": "Luxembourg Phone Number"
},
{
"name": "United Kingdom National Health Service Number"
},
{
"name": "Australian Medicare Card"
},
{
"name": "United States Social Security Number"
},
{
"name": "German Personalausweis"
},
{
"name": "French CNI"
},
{
"name": "Australian Tax File Number"
},
{
"name": "International Bank Account Number (IBAN)"
},
{
"name": "JCB"
},
{
"name": "Diners Club"
}
],
"content_types": [
{
"match": "62",
"name": "ZIP Archive"
},
{
"match": "58",
"name": "HTML/XML Document"
},
{
"match": "33",
"name": "7Zip intermediate stream"
},
{
"match": "33",
"name": "7zip Archive"
},
{
"match": "4",
"name": "Adobe Portable Document"
}
],
"filters": [
{
"type": "Don't search locations ending in...",
"values": [
".doc"
]
}
],
"inaccess": [
{
"path": "File path D:\\Sample-Data\\Txt-ODS-7z\\Sample-Data.zip",
"description": "File contains encrypted data",
"severity": "notice"
}
],
"test_summary": [
{
"path": "File path D:\\Sample-Data\\Txt-ODS-7z\\Sample-Data.7z",
"data_types": [
{
"name": "Test Data",
"count": "1",
"match_data": [
"123 456 782"
]
}
],
"count": "1",
"metadata": [
{
"label": "File Modified",
"values": [
"Jul, 24 2020 09:52"
]
},
{
"label": "File Owner",
"values": [
"EXAMPLE\\UserA"
]
},
{
"label": "Document Modified",
"values": [
"Jun, 10 2020 10:04"
]
},
{
"label": "Document Created",
"values": [
"Mar, 21 2011 15:32"
]
}
]
}
],
"prohibited_summary": [
{
"path": "File path D:\\Sample-Data\\Txt-ODS-7z\\All-Text-Only.txt",
"data_types": [
{
"name": "Mastercard",
"count": "1",
"metadata": [
{
"label": "Expiry",
"values": [
"10/04"
]
}
],
"match_data": [
"553270######8138"
]
},
{
"name": "Visa",
"count": "2",
"metadata": [
{
"label": "Expiry",
"values": [
"10/04",
"10/04"
]
}
],
"match_data": [
"476430######5417",
"466030######8388"
]
},
{
"name": "Track 2",
"count": "3",
"metadata": [
{
"label": "Expiry",
"values": [
"10/04",
"10/04",
"10/04"
]
}
],
"match_data": [
"476430######5417",
"553270######8138",
"466030######8388"
]
}
],
"count": "6",
"metadata": [
{
"label": "File Created",
"values": [
"Jul, 24 2020 09:44"
]
},
{
"label": "File Modified",
"values": [
"Jul, 24 2020 09:44"
]
},
{
"label": "File Owner",
"values": [
"EXAMPLE\\UserA"
]
}
]
}
],
"locations": [
{
"path": "File path D:\\Sample-Data\\Txt-ODS-7z\\All-Text-Only.txt",
"data_types": [
{
"name": "Mastercard",
"count": "1",
"metadata": [
{
"label": "Expiry",
"values": [
"10/04"
]
}
],
"match_data": [
"553270######8138"
]
},
{
"name": "Visa",
"count": "2",
"metadata": [
{
"label": "Expiry",
"values": [
"10/04",
"10/04"
]
}
],
"match_data": [
"476430######5417",
"466030######8388"
]
},
{
"name": "Track 2",
"count": "3",
"metadata": [
{
"label": "Expiry",
"values": [
"10/04",
"10/04",
"10/04"
]
}
],
"match_data": [
"476430######5417",
"553270######8138",
"466030######8388"
]
},
{
"name": "United Kingdom National Health Service Number (robust)",
"count": "2",
"match_data": [
"410-950-6425",
"943 476 5919"
]
},
{
"name": "United States Telephone Number (robust)",
"count": "1",
"match_data": [
"410-950-6425"
]
},
{
"name": "European EHIC",
"count": "2",
"match_data": [
"80040795427632937101",
"80056612499209294775"
]
},
{
"name": "Australian Medicare Card (robust)",
"count": "2",
"match_data": [
"2428 77813 2",
"3278-85119-5"
]
}
],
"count": "13",
"metadata": [
{
"label": "File Created",
"values": [
"Jul, 24 2020 09:44"
]
},
{
"label": "File Modified",
"values": [
"Jul, 24 2020 09:44"
]
},
{
"label": "File Owner",
"values": [
"EXAMPLE\\UserA"
]
}
]
},
{
"path": "File path D:\\Sample-Data\\Txt-ODS-7z\\Open-Office-Spreadsheet-Only.ods",
"sublocations": [
{
"path": "content.xml",
"sublocations": [
{
"path": "(html/xml)",
"data_types": [
{
"name": "French CNI (robust)",
"count": "1",
"match_data": [
"020895259832"
]
},
{
"name": "Personal Names (English)",
"count": "2",
"match_data": [
"James Bond",
"Alan Schaefer"
]
},
{
"name": "European EHIC",
"count": "2",
"match_data": [
"80040795427632900000",
"80208952598329800000"
]
},
{
"name": "Polish Telephone Number (robust)",
"count": "2",
"match_data": [
"220001293",
"220001293"
]
},
{
"name": "Portuguese Phone Number (robust)",
"count": "2",
"match_data": [
"220001293",
"220001293"
]
},
{
"name": "Luxembourg Phone Number (robust)",
"count": "2",
"match_data": [
"220001293",
"220001293"
]
},
{
"name": "German Personalausweis (robust)",
"count": "2",
"match_data": [
"T22000129",
"T22000129"
]
},
{
"name": "American Express",
"count": "12",
"match_data": [
"371530#####4331",
"371530#####4331",
"377446#####5483",
"377446#####5483",
"374496#####0639",
"374496#####0639",
"372486#####1778",
"372486#####1778",
"371530#####4331",
"377446#####5483",
"374496#####0639",
"372486#####1778"
]
},
{
"name": "SWIFT Code",
"count": "4",
"match_data": [
"DIBKRUMM697",
"SLHI US 3H876",
"ISRAILIJ835",
"CTBAAU2S196"
]
}
],
"count": "29",
"metadata": [
{
"label": "File Modified",
"values": [
"Jul, 24 2020 09:49"
]
},
{
"label": "File Owner",
"values": [
"EXAMPLE\\"EXAMPLE\UserA""
]
}
]
}
]
}
]
},
{
"path": "File path D:\\Sample-Data\\Txt-ODS-7z\\Sample-Data.7z",
"sublocations": [
{
"path": "(lzma2)",
"sublocations": [
{
"path": "Open-Office-Spreadsheet-Only.ods",
"sublocations": [
{
"path": "content.xml",
"sublocations": [
{
"path": "(html/xml)",
"data_types": [
{
"name": "French CNI (robust)",
"count": "1",
"match_data": [
"020895259832"
]
},
{
"name": "Personal Names (English)",
"count": "2",
"match_data": [
"James Bond",
"Alan Schaefer"
]
},
{
"name": "European EHIC",
"count": "2",
"match_data": [
"80040795427632900000",
"80208952598329800000"
]
},
{
"name": "Polish Telephone Number (robust)",
"count": "2",
"match_data": [
"220001293",
"220001293"
]
},
{
"name": "Portuguese Phone Number (robust)",
"count": "2",
"match_data": [
"220001293",
"220001293"
]
},
{
"name": "Luxembourg Phone Number (robust)",
"count": "2",
"match_data": [
"220001293",
"220001293"
]
},
{
"name": "German Personalausweis (robust)",
"count": "2",
"match_data": [
"T22000129",
"T22000129"
]
},
{
"name": "American Express",
"count": "12",
"match_data": [
"371530#####4331",
"371530#####4331",
"377446#####5483",
"377446#####5483",
"374496#####0639",
"374496#####0639",
"372486#####1778",
"372486#####1778",
"371530#####4331",
"377446#####5483",
"374496#####0639",
"372486#####1778"
]
},
{
"name": "SWIFT Code",
"count": "4",
"match_data": [
"DIBKRUMM697",
"SLHI US 3H876",
"ISRAILIJ835",
"CTBAAU2S196"
]
}
],
"count": "29",
"metadata": [
{
"label": "File Modified",
"values": [
"Jul, 24 2020 09:52"
]
},
{
"label": "File Owner",
"values": [
"EXAMPLE\\UserA"
]
}
]
}
]
}
]
},
{
"path": "PDF-Only.zip",
"sublocations": [
{
"path": "PDF-Only.pdf",
"sublocations": [
{
"path": "(pdf)",
"data_types": [
{
"name": "Email addresses",
"count": "2",
"match_data": [
"deborra-lee@example.com",
"hugh.jackman@example.com"
]
},
{
"name": "Personal Names (English)",
"count": "1",
"match_data": [
"LANE STREET"
]
},
{
"name": "Australian Mailing Address",
"count": "1",
"match_data": [
"Taxation Office\nPO Box 3373\nPENRITH NSW 2740"
]
}
],
"count": "4",
"metadata": [
{
"label": "File Modified",
"values": [
"Jul, 24 2020 09:52"
]
},
{
"label": "File Owner",
"values": [
"EXAMPLE\\UserA"
]
},
{
"label": "Document Modified",
"values": [
"Jun, 10 2020 10:04"
]
},
{
"label": "Document Created",
"values": [
"Mar, 21 2011 15:32"
]
}
]
}
]
}
]
}
]
}
]
}
]
}
Sample raw isolated report response for a Target location with plain text, XLSX and ZIP archive files.
200 OK
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
{
"label": "MY-WINDOWS-HOST File path D:\\Sample-Data\\Txt-Excel-ZIP JUL24-1010",
"target": "MY-WINDOWS-HOST",
"group": "DEFAULT GROUP",
"platform": "Windows 10 64bit",
"path": "File path D:\\Sample-Data\\Txt-Excel-ZIP",
"timestamp": 1595556640,
"start": 1595556640,
"end": 1595556641,
"match_locations": "3",
"match": "22",
"prohibited": "6",
"test": "1",
"scanned_bytes": "32897",
"scanned_locations": 4,
"inaccessible_locations": 1,
"failed": false,
"stopped": false,
"data_types": [
{
"match": "5",
"name": "Email addresses"
},
{
"match": "3",
"name": "International Bank Account Number (IBAN)"
},
{
"match": "3",
"name": "United States Social Security Number (robust)"
},
{
"prohibited": "3",
"name": "Track 2"
},
{
"prohibited": "2",
"name": "Visa"
},
{
"match": "2",
"name": "United Kingdom National Health Service Number (robust)"
},
{
"match": "2",
"name": "European EHIC"
},
{
"match": "2",
"name": "Australian Medicare Card (robust)"
},
{
"match": "1",
"name": "Personal Names (English)"
},
{
"test": "1",
"name": "Test Data"
},
{
"match": "1",
"name": "Australian Mailing Address"
},
{
"match": "1",
"name": "American Express"
},
{
"match": "1",
"name": "JCB"
},
{
"prohibited": "1",
"name": "Mastercard"
},
{
"match": "1",
"name": "United States Telephone Number (robust)"
},
{
"name": "MAC Address"
},
{
"name": "Polish Telephone Number"
},
{
"name": "United States Telephone Number"
},
{
"name": "Portuguese Phone Number"
},
{
"name": "Luxembourg Phone Number"
},
{
"name": "United Kingdom National Health Service Number"
},
{
"name": "Australian Medicare Card"
},
{
"name": "United States Social Security Number"
},
{
"name": "German Personalausweis"
},
{
"name": "French CNI"
},
{
"name": "Australian Tax File Number"
},
{
"name": "SWIFT Code"
},
{
"name": "Diners Club"
}
],
"content_types": [
{
"match": "15",
"name": "ZIP Archive"
},
{
"match": "4",
"name": "Adobe Portable Document"
}
],
"filters": [
{
"type": "Don't search locations ending in...",
"values": [
".doc"
]
}
],
"inaccess": [
{
"path": "File path D:\\Sample-Data\\Txt-Excel-ZIP\\Sample-Data.zip",
"description": "File contains encrypted data",
"severity": "notice"
}
],
"test_summary": [
{
"path": "File path D:\\Sample-Data\\Txt-Excel-ZIP\\PDF-Only.zip",
"data_types": [
{
"name": "Test Data",
"count": "1",
"match_data": [
"123 456 782"
]
}
],
"count": "1",
"metadata": [
{
"label": "File Modified",
"values": [
"Jul, 24 2020 09:52"
]
},
{
"label": "File Owner",
"values": [
"EXAMPLE\\UserA"
]
},
{
"label": "Document Modified",
"values": [
"Jun, 10 2020 10:04"
]
},
{
"label": "Document Created",
"values": [
"Mar, 21 2011 15:32"
]
}
]
}
],
"prohibited_summary": [
{
"path": "File path D:\\Sample-Data\\Txt-Excel-ZIP\\All-Text-Only.txt",
"data_types": [
{
"name": "Mastercard",
"count": "1",
"metadata": [
{
"label": "Expiry",
"values": [
"10/04"
]
}
],
"match_data": [
"553270######8138"
]
},
{
"name": "Visa",
"count": "2",
"metadata": [
{
"label": "Expiry",
"values": [
"10/04",
"10/04"
]
}
],
"match_data": [
"476430######5417",
"466030######8388"
]
},
{
"name": "Track 2",
"count": "3",
"metadata": [
{
"label": "Expiry",
"values": [
"10/04",
"10/04",
"10/04"
]
}
],
"match_data": [
"476430######5417",
"553270######8138",
"466030######8388"
]
}
],
"count": "6",
"metadata": [
{
"label": "File Modified",
"values": [
"Jul, 24 2020 09:44"
]
},
{
"label": "File Owner",
"values": [
"EXAMPLE\\UserA"
]
}
]
}
],
"locations": [
{
"path": "File path D:\\Sample-Data\\Txt-Excel-ZIP\\All-Text-Only.txt",
"data_types": [
{
"name": "Mastercard",
"count": "1",
"metadata": [
{
"label": "Expiry",
"values": [
"10/04"
]
}
],
"match_data": [
"553270######8138"
]
},
{
"name": "Visa",
"count": "2",
"metadata": [
{
"label": "Expiry",
"values": [
"10/04",
"10/04"
]
}
],
"match_data": [
"476430######5417",
"466030######8388"
]
},
{
"name": "Track 2",
"count": "3",
"metadata": [
{
"label": "Expiry",
"values": [
"10/04",
"10/04",
"10/04"
]
}
],
"match_data": [
"476430######5417",
"553270######8138",
"466030######8388"
]
},
{
"name": "United Kingdom National Health Service Number (robust)",
"count": "2",
"match_data": [
"410-950-6425",
"943 476 5919"
]
},
{
"name": "United States Telephone Number (robust)",
"count": "1",
"match_data": [
"410-950-6425"
]
},
{
"name": "European EHIC",
"count": "2",
"match_data": [
"80040795427632937101",
"80056612499209294775"
]
},
{
"name": "Australian Medicare Card (robust)",
"count": "2",
"match_data": [
"2428 77813 2",
"3278-85119-5"
]
}
],
"count": "13",
"metadata": [
{
"label": "File Modified",
"values": [
"Jul, 24 2020 09:44"
]
},
{
"label": "File Owner",
"values": [
"EXAMPLE\\UserA"
]
}
]
},
{
"path": "File path D:\\Sample-Data\\Txt-Excel-ZIP\\Excel-Only.xlsx",
"sublocations": [
{
"path": "worksheets/sheet1",
"data_types": [
{
"name": "American Express",
"count": "1",
"match_data": [
"374622#####8428"
]
},
{
"name": "International Bank Account Number (IBAN)",
"count": "3",
"match_data": [
"HR60 5962 4389 1770 6702 6",
"AE28 2948 6193 2295 3095 803",
"CZ52 8593 9927 1740 6974 8100"
]
},
{
"name": "JCB",
"count": "1",
"match_data": [
"358021######8500"
]
},
{
"name": "Email addresses",
"count": "3",
"match_data": [
"rdrought7@deviantart.com",
"gtouseyg@washingtonpost.com",
"hmohringh@dailymotion.com"
]
},
{
"name": "United States Social Security Number (robust)",
"count": "3",
"match_data": [
"288-17-0468",
"786-81-6052",
"778-56-0577"
]
}
],
"count": "11",
"metadata": [
{
"label": "File Modified",
"values": [
"Jul, 24 2020 09:46"
]
},
{
"label": "File Owner",
"values": [
"EXAMPLE\\UserA"
]
},
{
"label": "Document Modified",
"values": [
"Jul, 24 2020 01:46"
]
},
{
"label": "Document Modifier",
"values": [
"Administrator"
]
},
{
"label": "Document Created",
"values": [
"Jul, 20 2020 04:10"
]
},
{
"label": "Document Creator",
"values": [
"Administrator"
]
}
]
}
]
},
{
"path": "File path D:\\Sample-Data\\Txt-Excel-ZIP\\PDF-Only.zip",
"sublocations": [
{
"path": "PDF-Only.pdf",
"sublocations": [
{
"path": "(pdf)",
"data_types": [
{
"name": "Email addresses",
"count": "2",
"match_data": [
"deborra-lee@example.com",
"hugh.jackman@example.com"
]
},
{
"name": "Personal Names (English)",
"count": "1",
"match_data": [
"LANE STREET"
]
},
{
"name": "Australian Mailing Address",
"count": "1",
"match_data": [
"Taxation Office\nPO Box 3373\nPENRITH NSW 2740"
]
}
],
"count": "4",
"metadata": [
{
"label": "File Modified",
"values": [
"Jul, 24 2020 09:52"
]
},
{
"label": "File Owner",
"values": [
"EXAMPLE\\UserA"
]
},
{
"label": "Document Modified",
"values": [
"Jun, 10 2020 10:04"
]
},
{
"label": "Document Created",
"values": [
"Mar, 21 2011 15:32"
]
}
]
}
]
}
]
}
]
}
Sample raw isolated report response for a database.
200 OK
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
{
"label": "WINDOWS-SERVER-01 MariaDB Catalog :3308 Table employee-db JUL24-1042",
"target": "WINDOWS-SERVER-01",
"group": "DEFAULT GROUP",
"platform": "Windows 10 64bit",
"path": "MariaDB Server GL-CPU-10:3308 Catalog employee-db",
"timestamp": 1595558572,
"start": 1595558572,
"end": 1595558573,
"match_locations": "2",
"match": "18",
"prohibited": "0",
"test": "0",
"scanned_bytes": "653",
"scanned_locations": 2,
"inaccessible_locations": 0,
"failed": false,
"stopped": false,
"data_types": [
{
"match": "6",
"name": "International Bank Account Number (IBAN)"
},
{
"match": "6",
"name": "Email addresses"
},
{
"match": "6",
"name": "United States Social Security Number (robust)"
},
{
"name": "MAC Address"
},
{
"name": "United States Telephone Number"
},
{
"name": "Australian Tax File Number"
},
{
"name": "SWIFT Code"
},
{
"name": "Visa"
},
{
"name": "American Express"
}
],
"filters": [
{
"type": "Don't search locations ending in...",
"values": [
".doc"
]
}
],
"locations": [
{
"path": "MariaDB Server GL-CPU-10:3308 Catalog employee-db Table employee-info-1",
"data_types": [
{
"name": "International Bank Account Number (IBAN)",
"count": "3",
"metadata": [
{
"label": "Column",
"values": [
"iban",
"iban",
"iban"
]
},
{
"label": "Key",
"values": [
"130-62-0543",
"371-34-5200",
"424-19-2521"
]
},
{
"label": "Column:Key",
"values": [
"iban:130-62-0543",
"iban:371-34-5200",
"iban:424-19-2521"
]
}
],
"match_data": [
"DE25 1074 5206 0384 3237 37",
"DK92 7379 4961 7222 46",
"LU40 423D KDE7 MKNR XESQ"
]
},
{
"name": "Email addresses",
"count": "3",
"metadata": [
{
"label": "Column",
"values": [
"email",
"email",
"email"
]
},
{
"label": "Key",
"values": [
"130-62-0543",
"371-34-5200",
"424-19-2521"
]
},
{
"label": "Column:Key",
"values": [
"email:130-62-0543",
"email:371-34-5200",
"email:424-19-2521"
]
}
],
"match_data": [
"akalb1@weebly.com",
"hkewzick2@hubpages.com",
"jgervaise0@theglobeandmail.com"
]
},
{
"name": "United States Social Security Number (robust)",
"count": "3",
"metadata": [
{
"label": "Column",
"values": [
"ssn",
"ssn",
"ssn"
]
},
{
"label": "Key",
"values": [
"130-62-0543",
"371-34-5200",
"424-19-2521"
]
},
{
"label": "Column:Key",
"values": [
"ssn:130-62-0543",
"ssn:371-34-5200",
"ssn:424-19-2521"
]
}
],
"match_data": [
"130-62-0543",
"371-34-5200",
"424-19-2521"
]
}
],
"count": "9",
"metadata": [
{
"label": "Table",
"values": [
"employee-info-1"
]
},
{
"label": "Catalog",
"values": [
"employee-db"
]
},
{
"label": "Key Source",
"values": [
"Primary Key"
]
},
{
"label": "Key Columns",
"values": [
"ssn"
]
},
{
"label": "Processed Rows",
"values": [
"3"
]
}
]
},
{
"path": "MariaDB Server GL-CPU-10:3308 Catalog employee-db Table employee-info-2",
"data_types": [
{
"name": "International Bank Account Number (IBAN)",
"count": "3",
"metadata": [
{
"label": "Column",
"values": [
"iban",
"iban",
"iban"
]
}
],
"match_data": [
"CZ52 8593 9927 1740 6974 8100",
"MR35 6999 4676 3077 0455 2385 609",
"MC35 5291 0177 68AB 8NNK QILT K86"
]
},
{
"name": "Email addresses",
"count": "3",
"metadata": [
{
"label": "Column",
"values": [
"email",
"email",
"email"
]
}
],
"match_data": [
"hmohringh@dailymotion.com",
"tlabeli@alexa.com",
"sheibelj@rakuten.co.jp"
]
},
{
"name": "United States Social Security Number (robust)",
"count": "3",
"metadata": [
{
"label": "Column",
"values": [
"ssn",
"ssn",
"ssn"
]
}
],
"match_data": [
"778-56-0577",
"401-34-2234",
"436-66-4958"
]
}
],
"count": "9",
"metadata": [
{
"label": "Table",
"values": [
"employee-info-2"
]
},
{
"label": "Catalog",
"values": [
"employee-db"
]
},
{
"label": "Key Source",
"values": [
"None"
]
},
{
"label": "Processed Rows",
"values": [
"3"
]
}
]
}
]
}
501 Not Implemented
Returned if the report_id defined in the query path is for an isolated report that was generated using ER 2.0.29 and prior. Specify a report_id for Target reports generated using ER 2.0.30 and later.
HTTP/1.1 501 Not Implemented
Content-Type: application/json
Content-Length: xxx
{
"message": "error"
}