Authority Server API 2.0 API documentation version v2
https://api.cloudmark.com/score/v2
/ping
get
This endpoint is used by monitoring to test service availability.
get /ping
This endpoint is used by monitoring to test service availability.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"title": "Ping response",
"description": "This response is used to test for the server being alive. It is always empty.",
"properties": {
}
}
Example:
{
}
/version
get
Return the Server Version
get /version
Return the Server Version
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"required": ["version"],
"properties": {
"version": {
"type": "string",
"description": "The server version"
}
}
}
Example:
{
"version" : "2.0.1.35"
}
/mon
get
Ping the server
get /mon
Ping the server
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"required": ["uptime", "timeTsMs", "server"],
"properties": {
"uptime": {
"type": "integer",
"description": "The server uptime in seconds"
},
"timeTsMs": {
"type": "integer",
"title": "Time",
"description": "The time in milliseconds since the epoch (GMT)"
},
"server": {
"type": "string",
"title": "Server IP",
"description": "The ip address of the server"
}
}
}
Example:
{
"uptime" : 80013
"timeTsMs" : 1468884839000,
"server" : "127.0.0.1:2780"
}
/max-message-size
get
Return the maximum message size from the server
get /max-message-size
Return the maximum message size from the server
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"properties": {
"maxMessageSize": {
"type": "integer",
"minimum": 0,
"description": "The maximum message size accepted by the server"
}
},
"required": ["maxMessageSize"]
}
Example:
{ "maxMessageSize" : 4194304 }
/license
get
Return the server's licensing info
get /license
Return the server's licensing info
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"properties": {
"required" : [ "licenseId", "statusCode", "status", "expires", "expires", "maxSessions", "validSignatureTypes" ],
"licenseId": {
"type": "string",
"description": "Id from the Cloudmark supplied license file"
},
"oemId": {
"type": "string"
},
"oemCustomerString": {
"type": "string"
},
"statusCode": {
"type": "integer",
"description": "License status. 0 == valid and active"
},
"status": {
"type": "string",
"description": "String describing the license status"
},
"expiresTs": {
"type": "integer",
"description": "The expiration time for this license, as a UNIX timestamp"
},
"maxSessions": {
"type": "integer",
"description": "The maximum number of simultaneous auth installations that can use this license"
},
"validSignatureTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Allowed micro-update types"
}
}
}
Example:
{ "licenseId" : "3",
"oemId" : "",
"oemCustomerString" : "",
"statusCode" : 0,
"status" : "License OK",
"expiresTs" : 1661900395,
"maxSessions" : 19998,
"validSignatureTypes" : [
"comprehensive.4", "spvr.4", "sp.4", "comprehensive_sender_rep.4",
"spvr_sender_rep.4", "sp_sender_rep.4", "livecheck.4", "standard.4", "empty.4" ] }
HTTP status code 500
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"required": ["code", "message"],
"properties": {
"code": {
"type": "integer",
"description": "Code corresponding to the error"
},
"message": {
"type": "string",
"description": "Generic message describing the error"
},
"description": {
"type": "string",
"description": "Detailed Message describing the error"
}
}
}
/microupdate-versions
get
Return the list of microupdate versions
get /microupdate-versions
Return the list of microupdate versions
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"properties": {
"required" : [ "signatureType", "completeSrl", "incrementalSrl", "lastSuccessfulDownload", "lastDownloadSuccess" ],
"signatureType": {
"type": "string",
"description": "The currently configured micro-update set."
},
"completeSrl": {
"type": "number",
"description": "Serial number of the latest complete micro-update downloaded"
},
"incrementalSrl": {
"type": "integer",
"description": "Serial number of the latest incremental micro-update downloaded"
},
"lastSuccessfulDownloadTs": {
"type": "integer",
"description": "The time of the last successful download, as a UNIX timestamp"
},
"lastDownloadSuccess": {
"type": "boolean",
"description": "True if last download was completed successfully, false otherwise"
}
}
}
Example:
{ "signatureType": "sp_sender_rep.4",
"completeSrl": 9383475,
"incrementalSrl": 9387996,
"lastSuccessfulDownloadTs": 1401830127,
"lastDownloadSuccess": true }
HTTP status code 500
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"required": ["code", "message"],
"properties": {
"code": {
"type": "integer",
"description": "Code corresponding to the error"
},
"message": {
"type": "string",
"description": "Generic message describing the error"
},
"description": {
"type": "string",
"description": "Detailed Message describing the error"
}
}
}
/supported-attributes
get
Return the attributes supported by the cartridge
get /supported-attributes
Return the attributes supported by the cartridge
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"required" : ["supportedAttributes"],
"properties": {
"supportedAttributes": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Attributes supported by the cartridge"
}
}
Example:
{ "supportedtAttributes" : [
"category:sub-category pair",
"rescan",
"bulk sender" ] }
HTTP status code 500
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"required": ["code", "message"],
"properties": {
"code": {
"type": "integer",
"description": "Code corresponding to the error"
},
"message": {
"type": "string",
"description": "Generic message describing the error"
},
"description": {
"type": "string",
"description": "Detailed Message describing the error"
}
}
}
/runtime
get
Return a description of the runtime environment
get /runtime
Return a description of the runtime environment
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"required": [
"serverVersion",
"cmaeVersion",
"apiVersion",
"cartridgeVersion",
"osVersion",
"osDetails",
"customerServerId",
"hostname",
"applicationName"
],
"properties": {
"serverVersion": {
"type": "string",
"description": "The version of the server"
},
"cmaeVersion": {
"type": "string",
"description": "The version of CMAE used by the server"
},
"apiVersion": {
"type" : "array",
"description" : "An array of supported API versions",
"items" : {
"type": "string",
"description": "A supported version of the API"
}
},
"cartridgeVersion": {
"type": "string",
"description": "The version of the cartridge used by the server"
},
"osVersion": {
"type": "string",
"description": "version of the os"
},
"osDetails": {
"type": "string",
"description": "output of 'uname -a'"
},
"customerServerId": {
"type": "string",
"description": "The installation identified from the .cfg file"
},
"hostname": {
"type": "string",
"description": "The name of the host the server is running on"
},
"applicationName": {
"type": "string",
"description": "The name the server executable"
}
}
}
Example:
{ "serverVersion" : "5.0.1.9",
"cmaeVersion" : "4.0.0.8",
"apiVersion" : [
"2.0",
"1.5"
],
"cartridgeVersion" : "3053.0.0.4",
"osVersion" : "Linux 3.5.0-48-generic",
"osDetails" : "Linux 3.5.0-48-generic #72-Ubuntu SMP Mon Mar 10 23:18:29 UTC 2014 x86_64 GNU/Linux",
"customerServerId" : "foo bar",
"hostname" : "cmae.cloudmark.com",
"applicationName" : "authority_server" }
HTTP status code 500
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"required": ["code", "message"],
"properties": {
"code": {
"type": "integer",
"description": "Code corresponding to the error"
},
"message": {
"type": "string",
"description": "Generic message describing the error"
},
"description": {
"type": "string",
"description": "Detailed Message describing the error"
}
}
}
/message
post
post /message
Body
Type: multipart/form-data
Form Parameters- rfc822: required (string)
The text of the message to be scored.
- heloDomain: (string)
The domain field from the envelope's HELO message
- mailFrom: (string)
The MAIL FROM field from the envelope
- fromHost: (string)
The reverse DNS of the connecting IP address
- rcptTo: (string)
The list of from the RCPT TO field in the envelope
- connIp: (string)
The connecting IP address
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"properties": {
"rfc822": {
"type": "string",
"description": "The text of the message to be scored"
},
"heloDomain": {
"type": "string",
"description": "The domain field from the envelope's HELO message"
},
"mailFrom": {
"type": "string",
"description": "The MAIL FROM field from the envelope"
},
"fromHost": {
"type": "string",
"description": "The reverse DNS of the connecting IP address"
},
"rcptTo": {
"type": "string",
"description": "The list of from the RCPT TO field in the envelope"
},
"connIp": {
"type": "string",
"description": "The connecting IP address"
}
},
"required": ["rfc822"]
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"properties": {
"required": ["score", "analysis"],
"score": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The score returned by the cartridge"
},
"analysis": {
"type": "string",
"description": "The analysis string returned by the cartridge"
},
"appendHeaders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"headerField": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": ["headerField", "body"]
}
},
"resultAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": ["attribute", "value"]
}
}
}
}
Example:
{
"score" : 100,
"analysis" : "v=2.1 cv=SrfHkq60 c=1 sm=1 tr=0 p=DaXQsabPAAAA:8 a=bU0v77bwGRf84Jv5xUgO5A==:17 a=ZWCH5VE3ewwA:10 a=7z1cN_iqozsA:10 a=DAwyPP_o2Byb1YXLmDAA:9 a=gvNmmiocNOB2Wkj2abEA:9 a=CjuIK1q_8ugA:10 a=yMhMjlubAAAA:8 a=SSmOFEACAAAA:8 a=dN7_XCuEdbbXKyEBup0A:9 a=t7f5fdtflfth2PO-:21 a=gKO2Hq4RSVkA:10 a=UiCQ7L4-1S4A:10 a=frz4AuCg-hUA:10 a=6WyKbYZvIJXfZpAThF6I:22 a=BKKCjISod1eDJeS0ORpz:22 a=zjWhRoSqWz9hl55Hdlzg:22",
"appendheaders" : [
{
"header_field" : "X-CM-Analysis",
"body" : "v=2.1 cv=SrfHkq60 c=1 sm=1 tr=0 p=DaXQsabPAAAA:8 a=bU0v77bwGRf84Jv5xUgO5A==:17 a=ZWCH5VE3ewwA:10 a=7z1cN_iqozsA:10 a=DAwyPP_o2Byb1YXLmDAA:9 a=gvNmmiocNOB2Wkj2abEA:9 a=CjuIK1q_8ugA:10 a=yMhMjlubAAAA:8 a=SSmOFEACAAAA:8 a=dN7_XCuEdbbXKyEBup0A:9 a=t7f5fdtflfth2PO-:21 a=gKO2Hq4RSVkA:10 a=UiCQ7L4-1S4A:10 a=frz4AuCg-hUA:10 a=6WyKbYZvIJXfZpAThF6I:22 a=BKKCjISod1eDJeS0ORpz:22 a=zjWhRoSqWz9hl55Hdlzg:22"
}
]
}
HTTP status code 400
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"properties": {
"required" : ["code", "message"],
"code": {
"type": "integer",
"description": "Code corresponding to the error"
},
"message": {
"type": "string",
"description": "Generic message describing the error"
},
"description": {
"type": "string",
"description": "Detailed Message describing the error"
}
}
}
HTTP status code 500
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"required": ["code", "message"],
"properties": {
"code": {
"type": "integer",
"description": "Code corresponding to the error"
},
"message": {
"type": "string",
"description": "Generic message describing the error"
},
"description": {
"type": "string",
"description": "Detailed Message describing the error"
}
}
}
/content
post
post /content
Body
Type: multipart/form-data
Form Parameters- rfc822: required (string)
The text of the message to be scored.
- heloDomain: (string)
The domain field from the envelope's HELP message
- mailFrom: (string)
The MAIL FROM field from the envelope
- fromHost: (string)
The reverse DNS of the connecting IP address
- rcptTo: (string)
The list of from the RCPT TO field in the envelope
- connIp: (string)
The connecting IP address
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"properties": {
"rfc822": {
"type": "string",
"description": "The text of the message to be scored"
},
"heloDomain": {
"type": "string",
"description": "The domain field from the envelope's HELO message"
},
"mailFrom": {
"type": "string",
"description": "The MAIL FROM field from the envelope"
},
"fromHost": {
"type": "string",
"description": "The reverse DNS of the connecting IP address"
},
"rcptTo": {
"type": "string",
"description": "The list of from the RCPT TO field in the envelope"
},
"connIp": {
"type": "string",
"description": "The connecting IP address"
}
},
"required": ["rfc822"]
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"properties": {
"required": ["score", "analysis"],
"score": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The score returned by the cartridge"
},
"analysis": {
"type": "string",
"description": "The analysis string returned by the cartridge"
},
"appendHeaders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"headerField": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": ["headerField", "body"]
}
},
"resultAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": ["attribute", "value"]
}
}
}
}
Example:
{
"score" : 100,
"analysis" : "v=2.1 cv=SrfHkq60 c=1 sm=1 tr=0 p=DaXQsabPAAAA:8 a=bU0v77bwGRf84Jv5xUgO5A==:17 a=ZWCH5VE3ewwA:10 a=7z1cN_iqozsA:10 a=DAwyPP_o2Byb1YXLmDAA:9 a=gvNmmiocNOB2Wkj2abEA:9 a=CjuIK1q_8ugA:10 a=yMhMjlubAAAA:8 a=SSmOFEACAAAA:8 a=dN7_XCuEdbbXKyEBup0A:9 a=t7f5fdtflfth2PO-:21 a=gKO2Hq4RSVkA:10 a=UiCQ7L4-1S4A:10 a=frz4AuCg-hUA:10 a=6WyKbYZvIJXfZpAThF6I:22 a=BKKCjISod1eDJeS0ORpz:22 a=zjWhRoSqWz9hl55Hdlzg:22",
"appendheaders" : [
{
"header_field" : "X-CM-Analysis",
"body" : "v=2.1 cv=SrfHkq60 c=1 sm=1 tr=0 p=DaXQsabPAAAA:8 a=bU0v77bwGRf84Jv5xUgO5A==:17 a=ZWCH5VE3ewwA:10 a=7z1cN_iqozsA:10 a=DAwyPP_o2Byb1YXLmDAA:9 a=gvNmmiocNOB2Wkj2abEA:9 a=CjuIK1q_8ugA:10 a=yMhMjlubAAAA:8 a=SSmOFEACAAAA:8 a=dN7_XCuEdbbXKyEBup0A:9 a=t7f5fdtflfth2PO-:21 a=gKO2Hq4RSVkA:10 a=UiCQ7L4-1S4A:10 a=frz4AuCg-hUA:10 a=6WyKbYZvIJXfZpAThF6I:22 a=BKKCjISod1eDJeS0ORpz:22 a=zjWhRoSqWz9hl55Hdlzg:22"
}
]
}
HTTP status code 400
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"properties": {
"required" : ["code", "message"],
"code": {
"type": "integer",
"description": "Code corresponding to the error"
},
"message": {
"type": "string",
"description": "Generic message describing the error"
},
"description": {
"type": "string",
"description": "Detailed Message describing the error"
}
}
}
HTTP status code 500
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"required": ["code", "message"],
"properties": {
"code": {
"type": "integer",
"description": "Code corresponding to the error"
},
"message": {
"type": "string",
"description": "Generic message describing the error"
},
"description": {
"type": "string",
"description": "Detailed Message describing the error"
}
}
}
/sender
post
post /sender
Body
Type: multipart/form-data
Form Parameters- rfc822: required (string)
The text of the message to be scored.
- heloDomain: (string)
The domain field from the envelope's HELP message
- mailFrom: (string)
The MAIL FROM field from the envelope
- fromHost: (string)
The reverse DNS of the connecting IP address
- rcptTo: (string)
The list of from the RCPT TO field in the envelope
- connip: (string)
The connecting IP address
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"properties": {
"rfc822": {
"type": "string",
"description": "The text of the message to be scored"
},
"heloDomain": {
"type": "string",
"description": "The domain field from the envelope's HELO message"
},
"mailFrom": {
"type": "string",
"description": "The MAIL FROM field from the envelope"
},
"fromHost": {
"type": "string",
"description": "The reverse DNS of the connecting IP address"
},
"rcptTo": {
"type": "string",
"description": "The list of from the RCPT TO field in the envelope"
},
"connIp": {
"type": "string",
"description": "The connecting IP address"
}
},
"required": ["rfc822"]
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"properties": {
"required": ["score", "analysis"],
"score": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The score returned by the cartridge"
},
"analysis": {
"type": "string",
"description": "The analysis string returned by the cartridge"
},
"appendHeaders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"headerField": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": ["headerField", "body"]
}
},
"resultAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": ["attribute", "value"]
}
}
}
}
Example:
{
"score" : 100,
"analysis" : "v=2.1 cv=SrfHkq60 c=1 sm=1 tr=0 p=DaXQsabPAAAA:8 a=bU0v77bwGRf84Jv5xUgO5A==:17 a=ZWCH5VE3ewwA:10 a=7z1cN_iqozsA:10 a=DAwyPP_o2Byb1YXLmDAA:9 a=gvNmmiocNOB2Wkj2abEA:9 a=CjuIK1q_8ugA:10 a=yMhMjlubAAAA:8 a=SSmOFEACAAAA:8 a=dN7_XCuEdbbXKyEBup0A:9 a=t7f5fdtflfth2PO-:21 a=gKO2Hq4RSVkA:10 a=UiCQ7L4-1S4A:10 a=frz4AuCg-hUA:10 a=6WyKbYZvIJXfZpAThF6I:22 a=BKKCjISod1eDJeS0ORpz:22 a=zjWhRoSqWz9hl55Hdlzg:22",
"appendheaders" : [
{
"header_field" : "X-CM-Analysis",
"body" : "v=2.1 cv=SrfHkq60 c=1 sm=1 tr=0 p=DaXQsabPAAAA:8 a=bU0v77bwGRf84Jv5xUgO5A==:17 a=ZWCH5VE3ewwA:10 a=7z1cN_iqozsA:10 a=DAwyPP_o2Byb1YXLmDAA:9 a=gvNmmiocNOB2Wkj2abEA:9 a=CjuIK1q_8ugA:10 a=yMhMjlubAAAA:8 a=SSmOFEACAAAA:8 a=dN7_XCuEdbbXKyEBup0A:9 a=t7f5fdtflfth2PO-:21 a=gKO2Hq4RSVkA:10 a=UiCQ7L4-1S4A:10 a=frz4AuCg-hUA:10 a=6WyKbYZvIJXfZpAThF6I:22 a=BKKCjISod1eDJeS0ORpz:22 a=zjWhRoSqWz9hl55Hdlzg:22"
}
]
}
HTTP status code 400
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"properties": {
"required" : ["code", "message"],
"code": {
"type": "integer",
"description": "Code corresponding to the error"
},
"message": {
"type": "string",
"description": "Generic message describing the error"
},
"description": {
"type": "string",
"description": "Detailed Message describing the error"
}
}
}
HTTP status code 500
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"required": ["code", "message"],
"properties": {
"code": {
"type": "integer",
"description": "Code corresponding to the error"
},
"message": {
"type": "string",
"description": "Generic message describing the error"
},
"description": {
"type": "string",
"description": "Detailed Message describing the error"
}
}
}
/analysis
post
post /analysis
Body
Type: multipart/form-data
Form Parameters- analysis: required (string)
An analysis string
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"properties": {
"analysis": {
"type": "string",
"description": "An analysis string to score"
}
},
"required": ["analysis"]
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"properties": {
"required": ["score", "analysis"],
"score": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The score returned by the cartridge"
},
"analysis": {
"type": "string",
"description": "The analysis string returned by the cartridge"
}
}
}
Example:
{
"score" : 0,
"analysis" : "v=2.1 cv=O9huxkJW c=1 sm=1 tr=0 a=r4aQarv16AMDNKYCb71t+Q==:117 a=3m/8aREqtgHtTqhz+haZzQ==:17 a=4OSor8vjAAAA:8 a=C_IRinGWAAAA:8 a=GGcpBh7Jt_oA:10 a=XZD7Vk-23T0A:10 a=yKDDtKz0AAAA:8 a=7SYJ5Se-AAAA:8 a=1arZ8hPc3XyAcgx6l88A:9 a=x9CqGQOSTHgA:10 a=LKs0p8p7roEA:10 a=8pXzyOyUtmkA:10 a=84mpMTfVynIA:10 a=7fIlhRQJKHYA:10"
}
HTTP status code 400
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"properties": {
"required" : ["code", "message"],
"code": {
"type": "integer",
"description": "Code corresponding to the error"
},
"message": {
"type": "string",
"description": "Generic message describing the error"
},
"description": {
"type": "string",
"description": "Detailed Message describing the error"
}
}
}
HTTP status code 500
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"required": ["code", "message"],
"properties": {
"code": {
"type": "integer",
"description": "Code corresponding to the error"
},
"message": {
"type": "string",
"description": "Generic message describing the error"
},
"description": {
"type": "string",
"description": "Detailed Message describing the error"
}
}
}
/ip
get
get /ip/{ip}
URI Parameters
- ip: required (string)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"properties": {
"required": ["score"],
"score": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The score returned by the cartridge"
},
"resultAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": ["attribute", "value"]
}
}
}
}
Example:
{
"score" : 0
}
HTTP status code 400
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"properties": {
"required" : ["code", "message"],
"code": {
"type": "integer",
"description": "Code corresponding to the error"
},
"message": {
"type": "string",
"description": "Generic message describing the error"
},
"description": {
"type": "string",
"description": "Detailed Message describing the error"
}
}
}
HTTP status code 500
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"required": ["code", "message"],
"properties": {
"code": {
"type": "integer",
"description": "Code corresponding to the error"
},
"message": {
"type": "string",
"description": "Generic message describing the error"
},
"description": {
"type": "string",
"description": "Detailed Message describing the error"
}
}
}