HTTP Request for IP Address Blacklist tool (Security)
POST https://api.hexometer.com/v2/app/services/v1/detected_errors?key={YOUR_API_KEY}
Parameters
Fields
YOUR_API_KEY

string

to get YOUR_API_KEY visit hexometer select desired property then go to settings and copy your api key

Request Body
Fields
tool_name

string

you should provide the specific tool name to get the corresponding error. In this case "Security_IP_Address_Blacklist"

property_id

number

you should provide property id

Example
{
"tool_name": "Security_IP_Address_Blacklist",
"property_id": 25
}
Response Body

if request is successful you will get

JSON representation
{
"tool_logs": [
 SecurityIPAddressBlacklist
]
}
Fields
SecurityIPAddressBlacklist

object(SecurityIPAddressBlacklist)

SecurityIPAddressBlacklist represents a securityIPAddressBlacklist object

IP Address Blacklist (Security)

SecurityIPAddressBlacklist object structure

JSON representation
SecurityIPAddressBlacklist = {
"ipExtractionTool": {
"error": null | Object,
"resolveInfo": [
{
"ip": String,
"address": String,
"country": String,
"createdAt": String,
"lastModified": String,
"hostnames": Array,
"ipRange": String,
"company": String,
"ipInBlackList": Boolean,
"ipBlackList": Array
}
]
}
}
Fields
error

null | object

if an error exists an object is returned with error code(string) and message(string)

ip

string

IP

address

string

URL address

country

string

country

createdAt

string

creation date

lastModified

string

last modified time

hostnames

array

hostname list

ipRange

string

range of IPs

company

string

company

ipInBlackList

boolean

true if IP is on black list

ipBlackList

array

IP black lists list

Example
{
"tool_logs": [
{
"ipExtractionTool": {
"error": null,
"resolveInfo": [
{
"ip": "100.21.84.00",
"address": "see http://www.example.org.",
"country": "EU",
"createdAt": "2019-02-04T15:28:58Z",
"lastModified": "2019-02-04T15:28:58Z",
"hostnames": [],
"ipRange": "03.252.92.0 - 100.37.31.255",
"company": "internet Assigned Numbers Authority",
"ipInBlackList": false,
"ipBlackList": []
}
]
}
}
]
}

if request is not successful you will get

JSON representation
{
"error": true,
"message": String
}
Fields
error

boolean

if the error returns true, it means that an error has occurred

message

string

the message contains information about the error

Example
{
"error": true,
"message": "invalid API key"
}



HTTP Request for SSL Certificate tool (Security)
POST https://api.hexometer.com/v2/app/services/v1/detected_errors?key={YOUR_API_KEY}
Parameters
Fields
YOUR_API_KEY

string

to get YOUR_API_KEY visit hexometer select desired property then go to settings and copy your api key

Request Body
Fields
tool_name

string

you should provide the specific tool name to get the corresponding error. In this case "Security_SSL_Certificate"

property_id

number

you should provide property id

Example
{
"tool_name": "Security_SSL_Certificate",
"property_id": 25
}
Response Body

if request is successful you will get

JSON representation
{
"tool_logs": [
 SecuritySSLCertificate
]
}
Fields
SecuritySSLCertificate

object(SecuritySSLCertificate)

SecuritySSLCertificate represents a SecuritySSLCertificate object

SSL Certificate (Security)

SecuritySSLCertificate object structure

JSON representation
SecuritySSLCertificate = {
"sslExtractionTool": {
"error": null | Object,
"protocol": String,
"cipher": String,
"issuer": String,
"subjectName": String,
"sanList": Array,
"validFrom": String,
"validTo": String,
"serialNumber": String,
"bits": Number
}
}
Fields
error

null | object

if an error exists an object is returned with error code(string) and message(string)

protocol

string

protocol

cipher

string

cipher

issuer

string

cloudflare destination issue

subjectName

string

subject name

sanList

array

cloudflare san list

validFrom

string

ssl validation date

validTo

string

ssl validation date

serialNumber

string

serial number

bits

number

bit count

Example
{
"tool_logs": [
{
"sslExtractionTool": {
"error": null,
"protocol": "TLSv1.3",
"cipher": "TLS_AES_256_GCM_SHA384",
"issuer": "US, Cloudflare, Inc., Cloudflare Inc ECC CA-3",
"subjectName": "sni.cloudflaressl.com",
"sanList": [
"sni.cloudflaressl.com",
"exapmle.com",
"*.exapmle.com"
],
"validFrom": "2022-06-10T23:50:59.000Z",
"validTo": "2022-06-10T23:59:59.000Z",
"serialNumber": "012C446D5584DB4D602A548E0DA4522B",
"bits": 256
}
}
]
}

if request is not successful you will get

JSON representation
{
"error": true,
"message": String
}
Fields
error

boolean

if the error returns true, it means that an error has occurred

message

string

the message contains information about the error

Example
{
"error": true,
"message": "invalid API key"
}



HTTP Request for Security Headers tool (Security)
POST https://api.hexometer.com/v2/app/services/v1/detected_errors?key={YOUR_API_KEY}
Parameters
Fields
YOUR_API_KEY

string

to get YOUR_API_KEY visit hexometer select desired property then go to settings and copy your api key

Request Body
Fields
tool_name

string

you should provide the specific tool name to get the corresponding error. In this case "Security_Headers"

property_id

number

you should provide property id

Example
{
"tool_name": "Security_Headers",
"property_id": 25
}
Response Body

if request is successful you will get

JSON representation
{
"tool_logs": [
 SecurityHeaders
]
}
Fields
SecurityHeaders

object(SecurityHeaders)

SecurityHeaders represents a SecurityHeaders object

Security Headers (Security)

SecurityHeaders object structure

JSON representation
SecurityHeaders = {
"securityHeadersTool": {
"error": null | Object,
"allHeaders": Object,
"authenticationHeaders": Array,
"securityHeaders": Array,
"cachingHeaders": Array,
"conditionalsHeaders": Array,
"connectionHeaders": Array,
"cookies": Array,
"cors": Array,
"messageBodyHeaders": Array,
"responseContextHeaders": Array
}
}
Fields
error

null | object

if an error exists an object is returned with error code(string) and message(string)

allHeaders

object

all headers info

authenticationHeaders

array

authentication headers list

securityHeaders

array

security headers list

cachingHeaders

array

caching headers list

conditionalsHeaders

array

conditionals headers list

connectionHeaders

array

connection headers list

cookies

array

cookies list

cors

array

cors list

messageBodyHeaders

array

message body headers list

responseContextHeaders

array

response context headers list

Example
{
"tool_logs": [
{
"securityHeadersTool": {
"error": null,
"allHeaders": {
"date": "Tue, 06 Jul 2021 15:03:53 GMT",
"content-type": "text/html; charset=utf-8",
"transfer-encoding": "chunked",
"connection": "close",
"cf-ray": "56a9b8ec4a1415ee-DME" ,
"cache-control": "max-age=3600",
"last-modified": "Mon, 21 Jun 2021 14:18:14 GMT",,
"set-cookie": ["HttpOnly;Secure;SameSite=Strict"],
"strict-transport-security": "max-age=2000",
"vary": "x-fh-requested-host, accept-encoding",
"cf-cache-status": "DYNAMIC",
"content-security-policy": ,
"policy": "upgrade-insecure-requests",
"expect-ct": "max-age=604800, report-uri='https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct'",
"feature-policy": "usermedia *",
"referrer-policy": "strict-origin-when-cross-origin",
"x-cache": "HIT",
"x-cache-hits": "2",
"x-content-type-options": "nosniff",
"x-frame-options": "sameorigin",
"x-served-by": cache-ams21062-AMS",
"timer": "S1625583833.130368,VS0,VE0",
"x-xss-protection": "1; mode=block",
"report-to": "{"endpoints":[{"url":"https://a.nel.cloudflare.com/report/v2?s=dsvQENRDbbg4gqKR9oHpMjekbomuWt543ORYf5pPYr8Xw8DUfGs%2BRtskRL7sAbHefs7aVGqpjNvJ8MhkVqWtZjjSA8S5FbQ%2F3hEZRAO0H2LMq4jjLhj8"}],"group":"cf-nel","max_age":604800}",
"nel": "{"report_to":"cf-nel","max_age":604800}" ,
"server":"cloudflare",
"content-encoding": "gzip",
"alt-svc": "h3-27=":443"; ma=86400, h3-28=":443"; ma=86400, h3-29=":443"; ma=86400, h3=":443"; ma=86400",
 },
"authenticationHeaders": [
 {
"headerName": "www-authenticate",
"isExists": true,
"headerValue": ""
 }
 ],
"securityHeaders": [
 {
"headerName": "content-security-policy",
"isExists": false,
"headerValue": "strict-origin-when-cross-origin"
 }
 ],
"cachingHeaders": [
 {
"headerName": "age",
"isExists": false,
"headerValue": ""
 }
 ],
"conditionalsHeaders": [
 {
"headerName": "last-modified",
"isExists": true,
"headerValue": "Mon, 21 Jun 2021 14:18:14 GMT"
 }
 ],
"connectionHeaders": [
 {
"headerName": "connection",
"isExists": true,
"headerValue": "close"
 }
 ],
"cookies": [
 {
"headerName": "set-cookie",
"isExists": true,
"headerValue": "["HttpOnly;Secure;SameSite=Strict"]"
 }
 ],
"cors": [
 {
"headerName": "access-control-allow-origin",
"isExists": false,
"headerValue": ""
 }
 ],
"messageBodyHeaders": [
 {
"headerName": "content-length",
"isExists": false,
"headerValue": ""
 }
 ],
"responseContextHeaders": [
 {
"headerName": "allow",
"isExists": false,
"headerValue": ""
 }
 ]
}
}
]
}

if request is not successful you will get

JSON representation
{
"error": true,
"message": String
}
Fields
error

boolean

if the error returns true, it means that an error has occurred

message

string

the message contains information about the error

Example
{
"error": true,
"message": "invalid API key"
}



HTTP Request for Malicious Check tool (Security)
POST https://api.hexometer.com/v2/app/services/v1/detected_errors?key={YOUR_API_KEY}
Parameters
Fields
YOUR_API_KEY

string

to get YOUR_API_KEY visit hexometer select desired property then go to settings and copy your api key

Request Body
Fields
tool_name

string

you should provide the specific tool name to get the corresponding error. In this case "Security_Malicious_Check"

property_id

number

you should provide property id

Example
{
"tool_name": "Security_Malicious_Check",
"property_id": 25
}
Response Body

if request is successful you will get

JSON representation
{
"tool_logs": [
 SecurityMaliciousCheck
]
}
Fields
SecurityMaliciousCheck

object(SecurityMaliciousCheck)

SecurityMaliciousCheck represents a SecurityMaliciousCheck object

Security Malicious Check

SecurityMaliciousCheck object structure

JSON representation
SecurityMaliciousCheck = {
"maliciousUrlTool": {
"error": null | Object,
"problems": Boolean,
"threatTypes": Array,
"expireTime": String
}
}
Fields
error

null | object

if an error exists an object is returned with error code(string) and message(string)

problems

boolean

it true url has problems

threatTypes

array

threat array

expireTime

string

expire time

Example
{
"tool_logs": [
{
"maliciousUrlTool": {
"error": null,
"problems": false,
"threatTypes": [],
"expireTime": ""
}
}
]
}

if request is not successful you will get

JSON representation
{
"error": true,
"message": String
}
Fields
error

boolean

if the error returns true, it means that an error has occurred

message

string

the message contains information about the error

Example
{
"error": true,
"message": "invalid API key"
}