Application

This documentation is currently outdated and in the process of being updated. This documentation is provided as a temporary reference to various API endpoints and output. This warning will be at the top of each outdated page. As the documentation is updated, this warning will be removed.

Creating an Application

Create an application for the designated client.

API Call: POST/client/{clientId}/application

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user role that can create an application is:

  • Manager

API Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token

cURL

cURL Sample create_application Snippet

Copy 

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: application/json"
  -d "{  \"name\": \"<NAME>\",  \"url\": \"<URL>\",  \"groupId\": <GROUPID>,  \"networkId\": <NETWORKID>,  \"hostId\": <HOSTID>,  \"ports\": [    <PORT>, <PORT>  ],  \"manufacturedBy\": \"<MANUFACTURER>\",  \"model\": \"<MODEL>\",  \"macAddress\": \"<MACADDRESS>\",  \"location\": \"<LOCATION>\",  \"managedBy\": \"<MANAGEDBY>\",  \"ownedBy\": \"<OWNEDBY>\",  \"supportedBy\": \"<SUPPORTEDBY\",  \"supportGroup\": \"<SUPPORTGROUP>\",  \"sysId\": \"<SYSID>\",  \"operatingSystem\": \"<OPERATINGSYSTEM>\",  \"lastScanDate\": \"<LASTSCANDATE>\",  \"ferpaComplianceAsset\": \"<FERPACOMPLIANCEASSET>\",  \"hipaaComplianceAsset\": \"<HIPAACOMPLIANCEASSET>\",  \"pciComplianceAsset\": \"<PCICOMPLIANCEASSET>\"}"


Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number. Yes
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token
NAME Application name.
URL Application URL.
GROUPID Group ID number. integer
NETWORKID Network ID number. integer
HOSTID Host ID number. integer
PORT Application's port.
MANUFACTURER Application manufacturer.
MODEL Application model.
MACADDRESS Application MAC address. Format: AA-00-04-00-XX-YY
LOCATION Application location.
MANAGEDBY Application manager.
OWNEDBY Application owner.
SUPPORTEDBY Supported by.
SUPPORTGROUP Support group.
SYSID Application SYSID.
OPERATINGSYSTEM Application operating system.
LASTSCANDATE Host last scan date.
FERPACOMPLIANCEASSET FERPA compliance asset. Options: Yes = True, No = False
HIPAACOMPLIANCEASSET HIPAA compliance asset. Options: Yes = True, No = False
PCICOMPLIANCEASSET PCI compliance asset. Options: Yes = True, No = False

Response Parameters

Sample Response

Copy 

{
  "id": <ID>,
  "created": "<CREATED>"
}

Name Description Additional Information
ID Job ID number. integer
Created Date/Time job created. string($date-time)

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Copy 

{
  "id": 0,
  "created": "2019-09-23T18:05:24.443Z"
}

Code Description
400 User Error

400 Sample Response

Copy 

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}

Code Description
401 Unauthorized
404 Not Found

Listing Application Projections and Their Models

List projections and their models that can be requested from the search endpoint.

API Call: GET/client/{clientId}/application/model

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/model

###URL Parameters###

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can list application projections and their models are:

  • Manager
  • Group Manager
  • User

API Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token

cURL

cURL Sample application_projections Snippet

Copy 

curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/model"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token

Response Parameters

Sample Response

Copy 
{
  "subject": "application",
  "projections": [
    {
      "name": "basic",
      "fields": [
        {
          "field": "id",
          "type": "int",
          "nested": []
        },
        {
          "field": "groupId",
          "type": "int",
          "nested": []
        },
        {
          "field": "groupName",
          "type": "string",
          "nested": []
        },
        {
          "field": "networkId",
          "type": "int",
          "nested": []
        },
        {
          "field": "networkName",
          "type": "string",
          "nested": []
        },
        {
          "field": "clientId",
          "type": "int",
          "nested": []
        },
        {
          "field": "hostId",
          "type": "int",
          "nested": []
        },
        {
          "field": "applicationPortInfo",
          "type": "EmbeddedPort",
          "nested": [
            {
              "field": "portId",
              "type": "int",
              "nested": []
            },
            {
              "field": "port",
              "type": "int",
              "nested": []
            }
          ]
        },
        {
          "field": "uri",
          "type": "string",
          "nested": []
        },
        {
          "field": "name",
          "type": "string",
          "nested": []
        },
        {
          "field": "description",
          "type": "string",
          "nested": []
        },
        {
          "field": "noteCount",
          "type": "int",
          "nested": []
        },
        {
          "field": "discoveredOn",
          "type": "string",
          "nested": []
        },
        {
          "field": "lastFoundOn",
          "type": "string",
          "nested": []
        },
        {
          "field": "findingsDistribution",
          "type": "FindingsDistribution",
          "nested": [
            {
              "field": "total",
              "type": "EmbeddedSeverityGroup",
              "nested": [
                {
                  "field": "value",
                  "type": "int",
                  "nested": []
                },
                {
                  "field": "subject",
                  "type": "string",
                  "nested": []
                },
                {
                  "field": "filter",
                  "type": "string",
                  "nested": []
                }
              ]
            },
            {
              "field": "critical",
              "type": "EmbeddedSeverityGroup",
              "nested": [
                {
                  "field": "value",
                  "type": "int",
                  "nested": []
                },
                {
                  "field": "subject",
                  "type": "string",
                  "nested": []
                },
                {
                  "field": "filter",
                  "type": "string",
                  "nested": []
                }
              ]
            },
            {
              "field": "high",
              "type": "EmbeddedSeverityGroup",
              "nested": [
                {
                  "field": "value",
                  "type": "int",
                  "nested": []
                },
                {
                  "field": "subject",
                  "type": "string",
                  "nested": []
                },
                {
                  "field": "filter",
                  "type": "string",
                  "nested": []
                }
              ]
            },
            {
              "field": "medium",
              "type": "EmbeddedSeverityGroup",
              "nested": [
                {
                  "field": "value",
                  "type": "int",
                  "nested": []
                },
                {
                  "field": "subject",
                  "type": "string",
                  "nested": []
                },
                {
                  "field": "filter",
                  "type": "string",
                  "nested": []
                }
              ]
            },
            {
              "field": "low",
              "type": "EmbeddedSeverityGroup",
              "nested": [
                {
                  "field": "value",
                  "type": "int",
                  "nested": []
                },
                {
                  "field": "subject",
                  "type": "string",
                  "nested": []
                },
                {
                  "field": "filter",
                  "type": "string",
                  "nested": []
                }
              ]
            },
            {
              "field": "info",
              "type": "EmbeddedSeverityGroup",
              "nested": [
                {
                  "field": "value",
                  "type": "int",
                  "nested": []
                },
                {
                  "field": "subject",
                  "type": "string",
                  "nested": []
                },
                {
                  "field": "filter",
                  "type": "string",
                  "nested": []
                }
              ]
            }
          ]
        },
        {
          "field": "hasTickets",
          "type": "boolean",
          "nested": []
        },
        {
          "field": "tickets",
          "type": "EmbeddedTicket",
          "nested": [
            {
              "field": "ticketNumber",
              "type": "string",
              "nested": []
            },
            {
              "field": "ticketStatus",
              "type": "string",
              "nested": []
            },
            {
              "field": "deepLink",
              "type": "string",
              "nested": []
            },
            {
              "field": "type",
              "type": "string",
              "nested": []
            },
            {
              "field": "connectorName",
              "type": "string",
              "nested": []
            },
            {
              "field": "detailedStatus",
              "type": "string",
              "nested": []
            }
          ]
        },
        {
          "field": "icons",
          "type": "EmbeddedIcon",
          "nested": [
            {
              "field": "type",
              "type": "string",
              "nested": []
            },
            {
              "field": "overlayText",
              "type": "string",
              "nested": []
            }
          ]
        },
        {
          "field": "tagCount",
          "type": "int",
          "nested": []
        },
        {
          "field": "tags",
          "type": "EmbeddedTag",
          "nested": [
            {
              "field": "id",
              "type": "int",
              "nested": []
            },
            {
              "field": "name",
              "type": "string",
              "nested": []
            },
            {
              "field": "category",
              "type": "string",
              "nested": []
            },
            {
              "field": "description",
              "type": "string",
              "nested": []
            },
            {
              "field": "created",
              "type": "string",
              "nested": []
            },
            {
              "field": "updated",
              "type": "string",
              "nested": []
            },
            {
              "field": "color",
              "type": "string",
              "nested": []
            }
          ]
        },
        {
          "field": "sourceIds",
          "type": "String[]",
          "nested": []
        },
        {
          "field": "urlCount",
          "type": "int",
          "nested": []
        },
        {
          "field": "configurationManagementDB",
          "type": "ConfigurationManagementDB",
          "nested": [
            {
              "field": "manufacturedBy",
              "type": "string",
              "nested": []
            },
            {
              "field": "model",
              "type": "string",
              "nested": []
            },
            {
              "field": "macAddress",
              "type": "string",
              "nested": []
            },
            {
              "field": "location",
              "type": "string",
              "nested": []
            },
            {
              "field": "managedBy",
              "type": "string",
              "nested": []
            },
            {
              "field": "ownedBy",
              "type": "string",
              "nested": []
            },
            {
              "field": "supportedBy",
              "type": "string",
              "nested": []
            },
            {
              "field": "supportGroup",
              "type": "string",
              "nested": []
            },
            {
              "field": "sysId",
              "type": "string",
              "nested": []
            },
            {
              "field": "operatingSystem",
              "type": "string",
              "nested": []
            },
            {
              "field": "lastScanDate",
              "type": "string",
              "nested": []
            },
            {
              "field": "ferpaComplianceAsset",
              "type": "boolean",
              "nested": []
            },
            {
              "field": "hipaaComplianceAsset",
              "type": "boolean",
              "nested": []
            },
            {
              "field": "pciComplianceAsset",
              "type": "boolean",
              "nested": []
            }
          ]
        },
        {
          "field": "scannerName",
          "type": "string",
          "nested": []
        }
      ]
    },
    {
      "name": "detail",
      "fields": [
        {
          "field": "id",
          "type": "int",
          "nested": []
        },
        {
          "field": "group",
          "type": "EmbeddedGroup",
          "nested": [
            {
              "field": "id",
              "type": "int",
              "nested": []
            },
            {
              "field": "name",
              "type": "string",
              "nested": []
            }
          ]
        },
        {
          "field": "network",
          "type": "EmbeddedNetwork",
          "nested": [
            {
              "field": "id",
              "type": "int",
              "nested": []
            },
            {
              "field": "name",
              "type": "string",
              "nested": []
            },
            {
              "field": "type",
              "type": "string",
              "nested": []
            }
          ]
        },
        {
          "field": "clientId",
          "type": "int",
          "nested": []
        },
        {
          "field": "hostId",
          "type": "int",
          "nested": []
        },
        {
          "field": "applicationPortInfo",
          "type": "EmbeddedPort",
          "nested": [
            {
              "field": "portId",
              "type": "int",
              "nested": []
            },
            {
              "field": "port",
              "type": "int",
              "nested": []
            }
          ]
        },
        {
          "field": "uri",
          "type": "string",
          "nested": []
        },
        {
          "field": "name",
          "type": "string",
          "nested": []
        },
        {
          "field": "description",
          "type": "string",
          "nested": []
        },
        {
          "field": "notes",
          "type": "EmbeddedNote[]",
          "nested": []
        },
        {
          "field": "discoveredOn",
          "type": "string",
          "nested": []
        },
        {
          "field": "lastFoundOn",
          "type": "string",
          "nested": []
        },
        {
          "field": "findingsDistribution",
          "type": "FindingsDistribution",
          "nested": [
            {
              "field": "total",
              "type": "EmbeddedSeverityGroup",
              "nested": [
                {
                  "field": "value",
                  "type": "int",
                  "nested": []
                },
                {
                  "field": "subject",
                  "type": "string",
                  "nested": []
                },
                {
                  "field": "filter",
                  "type": "string",
                  "nested": []
                }
              ]
            },
            {
              "field": "critical",
              "type": "EmbeddedSeverityGroup",
              "nested": [
                {
                  "field": "value",
                  "type": "int",
                  "nested": []
                },
                {
                  "field": "subject",
                  "type": "string",
                  "nested": []
                },
                {
                  "field": "filter",
                  "type": "string",
                  "nested": []
                }
              ]
            },
            {
              "field": "high",
              "type": "EmbeddedSeverityGroup",
              "nested": [
                {
                  "field": "value",
                  "type": "int",
                  "nested": []
                },
                {
                  "field": "subject",
                  "type": "string",
                  "nested": []
                },
                {
                  "field": "filter",
                  "type": "string",
                  "nested": []
                }
              ]
            },
            {
              "field": "medium",
              "type": "EmbeddedSeverityGroup",
              "nested": [
                {
                  "field": "value",
                  "type": "int",
                  "nested": []
                },
                {
                  "field": "subject",
                  "type": "string",
                  "nested": []
                },
                {
                  "field": "filter",
                  "type": "string",
                  "nested": []
                }
              ]
            },
            {
              "field": "low",
              "type": "EmbeddedSeverityGroup",
              "nested": [
                {
                  "field": "value",
                  "type": "int",
                  "nested": []
                },
                {
                  "field": "subject",
                  "type": "string",
                  "nested": []
                },
                {
                  "field": "filter",
                  "type": "string",
                  "nested": []
                }
              ]
            },
            {
              "field": "info",
              "type": "EmbeddedSeverityGroup",
              "nested": [
                {
                  "field": "value",
                  "type": "int",
                  "nested": []
                },
                {
                  "field": "subject",
                  "type": "string",
                  "nested": []
                },
                {
                  "field": "filter",
                  "type": "string",
                  "nested": []
                }
              ]
            }
          ]
        },
        {
          "field": "tags",
          "type": "EmbeddedTag",
          "nested": [
            {
              "field": "id",
              "type": "int",
              "nested": []
            },
            {
              "field": "name",
              "type": "string",
              "nested": []
            },
            {
              "field": "category",
              "type": "string",
              "nested": []
            },
            {
              "field": "description",
              "type": "string",
              "nested": []
            },
            {
              "field": "created",
              "type": "string",
              "nested": []
            },
            {
              "field": "updated",
              "type": "string",
              "nested": []
            },
            {
              "field": "color",
              "type": "string",
              "nested": []
            }
          ]
        },
        {
          "field": "tickets",
          "type": "EmbeddedTicket",
          "nested": [
            {
              "field": "ticketNumber",
              "type": "string",
              "nested": []
            },
            {
              "field": "ticketStatus",
              "type": "string",
              "nested": []
            },
            {
              "field": "deepLink",
              "type": "string",
              "nested": []
            },
            {
              "field": "type",
              "type": "string",
              "nested": []
            },
            {
              "field": "connectorName",
              "type": "string",
              "nested": []
            },
            {
              "field": "detailedStatus",
              "type": "string",
              "nested": []
            }
          ]
        },
        {
          "field": "icons",
          "type": "EmbeddedIcon",
          "nested": [
            {
              "field": "type",
              "type": "string",
              "nested": []
            },
            {
              "field": "overlayText",
              "type": "string",
              "nested": []
            }
          ]
        },
        {
          "field": "owasps",
          "type": "EmbeddedOWASPApplication[]",
          "nested": []
        },
        {
          "field": "wascs",
          "type": "EmbeddedWASC[]",
          "nested": []
        },
        {
          "field": "aggregateServices",
          "type": "EmbeddedService[]",
          "nested": []
        },
        {
          "field": "urlCount",
          "type": "int",
          "nested": []
        },
        {
          "field": "configurationManagementDB",
          "type": "ConfigurationManagementDB",
          "nested": [
            {
              "field": "manufacturedBy",
              "type": "string",
              "nested": []
            },
            {
              "field": "model",
              "type": "string",
              "nested": []
            },
            {
              "field": "macAddress",
              "type": "string",
              "nested": []
            },
            {
              "field": "location",
              "type": "string",
              "nested": []
            },
            {
              "field": "managedBy",
              "type": "string",
              "nested": []
            },
            {
              "field": "ownedBy",
              "type": "string",
              "nested": []
            },
            {
              "field": "supportedBy",
              "type": "string",
              "nested": []
            },
            {
              "field": "supportGroup",
              "type": "string",
              "nested": []
            },
            {
              "field": "sysId",
              "type": "string",
              "nested": []
            },
            {
              "field": "operatingSystem",
              "type": "string",
              "nested": []
            },
            {
              "field": "lastScanDate",
              "type": "string",
              "nested": []
            },
            {
              "field": "ferpaComplianceAsset",
              "type": "boolean",
              "nested": []
            },
            {
              "field": "hipaaComplianceAsset",
              "type": "boolean",
              "nested": []
            },
            {
              "field": "pciComplianceAsset",
              "type": "boolean",
              "nested": []
            }
          ]
        },
        {
          "field": "sources",
          "type": "ScannerDetail[]",
          "nested": []
        }
      ]
    }
  ]
}

HTTP Status Codes

Code Description
200 OK

200 Sample Response

Copy 
{
  "projections": [
    {
      "name": "basic",
      "fields": [
        {
          "field": "id",
          "type": "integer"
        },
        {
          "field": "name",
          "type": "string"
        }
      ]
    }
  ]
}
Code Description
401 Unauthorized
404 Not Found

Listing Filterable Application Fields

Displays the fields that the search endpoint can filter by.

API Call: GET/client/{clientId}/application/filter

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/filter

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can list application fields that can be filtered by are:

  • Manager
  • Group Manager
  • User

API Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token

cURL

cURL Sample list_applicationfields Snippet

Copy 

curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/filter"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"

Make sure to replace the option values here with your own option values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token

Response Parameters

Sample Response

Copy 

[
  {
    "name": "Assessment",
    "legacyUid": "assessment_labels",
    "uid": "assessment_labels",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Filters web applications by one or more assessments."
  },
  {
    "name": "Asset Owner",
    "legacyUid": "asset_owner",
    "uid": "asset_owner",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Filters web applications by asset owner."
  },
  {
    "name": "Assigned To",
    "legacyUid": "assignments",
    "uid": "assignments",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Filters web applications by assigned user."
  },
  {
    "name": "CWE",
    "legacyUid": "cwes",
    "uid": "cwes",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Filters web applications by CWE reference(s)."
  },
  {
    "name": "Clear-text Credentials or Weak Encryption",
    "legacyUid": "has_owasp_a6",
    "uid": "has_owasp_a6",
    "operators": [
      "EXACT"
    ],
    "type": "boolean",
    "description": "Filters web applications by CWEs associated with clear-text credentials or weak encyrption."
  },
  {
    "name": "Critical Count",
    "legacyUid": "critical_count",
    "uid": "findingsDistribution.critical",
    "operators": [
      "EXACT",
      "IN",
      "RANGE"
    ],
    "type": "string",
    "description": "Filters hosts by the count of critical web applications findings."
  },
  {
    "name": "Cross-Site Scripting",
    "legacyUid": "has_xss",
    "uid": "has_xss",
    "operators": [
      "EXACT"
    ],
    "type": "boolean",
    "description": "Filters web applications by CWEs associated with cross-site scripting"
  },
  {
    "name": "Description",
    "legacyUid": "description",
    "uid": "description",
    "operators": [
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Filters web applications by description."
  },
  {
    "name": "Discovered On",
    "legacyUid": "discovered_on",
    "uid": "discovered_on",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD",
      "RANGE"
    ],
    "type": "date",
    "description": "Filters hosts by the asset's discovered date."
  },
  {
    "name": "Group",
    "legacyUid": "group_name",
    "uid": "groupName",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Filters web applications by selected group(s)."
  },
  {
    "name": "Group ID",
    "legacyUid": "groups_id",
    "uid": "groupIds",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Filters web applications within selected group IDs."
  },
  {
    "name": "Has Note",
    "legacyUid": "has_note",
    "uid": "has_note",
    "operators": [
      "EXACT"
    ],
    "type": "boolean",
    "description": "Filters web applications that have an associated note."
  },
  {
    "name": "Has SQL Injection",
    "legacyUid": "has_sql_injection",
    "uid": "has_sql_injection",
    "operators": [
      "EXACT"
    ],
    "type": "boolean",
    "description": "Filters web applications by CWEs associated with SQL Injection."
  },
  {
    "name": "Has Ticket",
    "legacyUid": "HAS_CONNECTOR_TICKET",
    "uid": "HAS_CONNECTOR_TICKET",
    "operators": [
      "EXACT"
    ],
    "type": "boolean",
    "description": "Does the tag have a ticket"
  },
  {
    "name": "Has Vulnerabilities",
    "legacyUid": "has_vulnerabilities",
    "uid": "has_vulnerabilities",
    "operators": [
      "EXACT"
    ],
    "type": "boolean",
    "description": "Filters web applications by attached web applications."
  },
  {
    "name": "High Count",
    "legacyUid": "high_count",
    "uid": "findingsDistribution.high",
    "operators": [
      "EXACT",
      "IN",
      "RANGE"
    ],
    "type": "string",
    "description": "Filters hosts by the count of high web applications findings."
  },
  {
    "name": "Id",
    "legacyUid": "id",
    "uid": "id",
    "operators": [
      "EXACT",
      "IN"
    ],
    "type": "string",
    "description": ""
  },
  {
    "name": "Info Count",
    "legacyUid": "info_count",
    "uid": "findingsDistribution.info",
    "operators": [
      "EXACT",
      "IN",
      "RANGE"
    ],
    "type": "string",
    "description": "Filters hosts by the count of info web applications findings."
  },
  {
    "name": "Last Found On",
    "legacyUid": "last_found_on",
    "uid": "last_found_on",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD",
      "RANGE"
    ],
    "type": "date",
    "description": "Filters hosts by the asset's last found date."
  },
  {
    "name": "Low Count",
    "legacyUid": "low_count",
    "uid": "findingsDistribution.low",
    "operators": [
      "EXACT",
      "IN",
      "RANGE"
    ],
    "type": "string",
    "description": "Filters hosts by the count of low web applications findings."
  },
  {
    "name": "Manual Exploit",
    "legacyUid": "manual_exploits",
    "uid": "manual_exploits",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Filters web applications by manual exploits added by a penetration tester."
  },
  {
    "name": "Medium Count",
    "legacyUid": "medium_count",
    "uid": "findingsDistribution.medium",
    "operators": [
      "EXACT",
      "IN",
      "RANGE"
    ],
    "type": "string",
    "description": "Filters hosts by the count of medium web applications findings."
  },
  {
    "name": "Name",
    "legacyUid": "name",
    "uid": "name",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Filters web applications by application name."
  },
  {
    "name": "Network",
    "legacyUid": "network_partition_name",
    "uid": "network.name",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Filters web applications by the name of the network partition they belong to."
  },
  {
    "name": "Network Type",
    "legacyUid": "network_partition_type",
    "uid": "network_partition_type",
    "operators": [
      "EXACT",
      "IN"
    ],
    "type": "string",
    "description": "Filters web applications by the type of network partition they belong to."
  },
  {
    "name": "Newly Created Web Application",
    "legacyUid": "newly_created_webapp",
    "uid": "newly_created_webapp",
    "operators": [
      "EXACT"
    ],
    "type": "boolean",
    "description": "Filters web applications that have been created in the last 30 days."
  },
  {
    "name": "OWASP",
    "legacyUid": "owasps",
    "uid": "owasps",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Filters web applications by OWASP security risks."
  },
  {
    "name": "Reported Scan Date",
    "legacyUid": "reported_scan_time",
    "uid": "lastScanTime",
    "operators": [
      "EXACT",
      "RANGE"
    ],
    "type": "string",
    "description": "Filters web applications by reported scan date."
  },
  {
    "name": "Scanner Name",
    "legacyUid": "scanner_names",
    "uid": "scanner_names",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Filters applications by scanner name(s)."
  },
  {
    "name": "Scanner UUID",
    "legacyUid": "source",
    "uid": "source",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Filters applications by scanner uuid(s)."
  },
  {
    "name": "Tag",
    "legacyUid": "tags",
    "uid": "tags",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Filters web applications by applied tags."
  },
  {
    "name": "Tag Connector ID",
    "legacyUid": "TAG_CONNECTOR_ID",
    "uid": "TAG_CONNECTOR_ID",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Tag Connector ID"
  },
  {
    "name": "Tag Connector Name",
    "legacyUid": "TAG_CONNECTOR_NAME",
    "uid": "TAG_CONNECTOR_NAME",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Name of the Connector associated with the tag"
  },
  {
    "name": "Ticket ID",
    "legacyUid": "TICKET_ID",
    "uid": "TICKET_ID",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Ticket ID"
  },
  {
    "name": "Ticket Status",
    "legacyUid": "TICKET_STATUS",
    "uid": "TICKET_STATUS",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "status of ticket"
  },
  {
    "name": "Total Count",
    "legacyUid": "total_count",
    "uid": "findingsDistribution.total",
    "operators": [
      "EXACT",
      "IN",
      "RANGE"
    ],
    "type": "string",
    "description": "Filters hosts by the count of total web applications findings."
  },
  {
    "name": "URL",
    "legacyUid": "url",
    "uid": "url",
    "operators": [
      "EXACT",
      "IN",
      "LIKE",
      "WILDCARD"
    ],
    "type": "string",
    "description": "Filters web applications by particular URLs."
  }
]

HTTP Status Codes

Code Description
200 OK

200 Sample Response

Copy 
[
  {
    "name": "id",
    "uid": "id",
    "operator": [
      "EXACT",
      "IN"
    ],
    "type": "integer",
    "description": "The id"
  }
]
Code Description
401 Unauthorized
404 Not Found

Suggesting Filter Values for Application Filtering

Displays suggested filter values when filtering applications.

API Call: GET/client/{clientId}/application/filter

URL: https://platform<#>.risksense.com/api/v1/client/<CLIENTID>/application/filter

###URL Parameters###

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can view suggested filter values for applications are:

  • Manager
  • Group Manager
  • User

API Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token

cURL

cURL Sample filter_applicationvalues Snippet

Copy 

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/suggest"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: application/json"
  -d "{  \"filters\": [    {      \"field\": \"<FIELD>\",      \"exclusive\": <EXCLUSIVE>,      \"operator\": \"<OPERATOR>\",      \"value\": \"<VALUE>\"    }  ],  \"filter\": {    \"field\": \"<FIELD>\",    \"exclusive\": <EXCLUSIVE>,    \"operator\": \"<OPERATOR>\",    \"value\": \"<VALUE>\"  }}"

Make sure to replace the option values here with your own option values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token
FIELD Filter field. string
EXCLUSIVE Exclusive. boolean Options: True, False
OPERATOR Search operator. Depends on value.
VALUE Search value. string

Response Parameters

Sample Response

Copy 

[
  {
    "key": "<KEY>",
    "count": <COUNT>
  }
]


Name Description Additional Information
KEY Value for the field the suggestion was requested for. string
COUNT Count. integer($int64)

HTTP Status Codes

Code Description
200 OK

200 Sample Response

Copy 
[
  {
    "key": "string",
    "count": 0
  }
]
Code Description
400 Bad Request
401 Unauthorized
404 Not Found

Searching for an Application

Search for an application within the designated client.

API Call: POST/client/{clientId}/application/search

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/search

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can search for an application are:

  • Manager
  • Group Manager
  • User

API Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token

cURL

cURL Sample search_application Snippet

Copy 

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/search"
  -H "accept: application/json"
  -H "x-api-key: <APIKEY>"
  -H "Content-Type: application/json"
  -d "{ \"projection\": \"<PROJECTION>\", \"sort\": [ { \"field\": \"<SORTFIELD>\", \"direction\": \"<SORTDIRECTION>\" } ], \"page\": <PAGENUMBER>, \"size\": <PAGESIZE>}"

Make sure to replace the option values here with your own option values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token
ROJECTION Projection type. Options: basic, detailed
SORTFIELD Field to sort.
SORTDIRECTION Sort direction. Options: ASC, DESC
PAGENUMBER Page number to view.
PAGESIZE Number of entries per page.

Response Parameters

Sample Response

Copy 

{
  "errors": [],
  "page": {
    "size": <PAGESIZE>,
    "totalElements": <TOTALELEMENTS>,
    "totalPages": <TOTALPAGES>,
    "number": <PAGENUMBER>
  },
  "_links": {
    "self": {
      "href": "http://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/search?page=<PAGENUMBER>&size=<PAGESIZE>&sort=<SORT>,<SORTDIRECTION>"
    }
  }
}

Name Description Additional Information
PAGESIZE Page size requested. Shows how many items to display on the page.
TOTALELEMENTS Total elements on pages.
TOTALPAGES Total amount of pages.
PAGENUMBER Page to view. Note that 0 is the first page.
PLATFORM Platform number.
CLIENTID Client ID number.
SORT Field to sort by.
SORTDIRECTION Direction to sort. Options: ASC, DESC

HTTP Status Codes

Code Description
200 OK

200 Sample Response

Copy 
{
  "_embedded": {
    "strings": [
      {}
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  },
  "errors": [
    {
      "id": "string",
      "errorRefId": "string",
      "code": 0,
      "cause": "string"
    }
  ]
}
Code Description
400 Bad Request
401 Unauthorized
404 Not Found

Adding or Removing a Tag from an Application

Add or remove a tag from an application.

API Call: POST/client/{clientId}/application/tag

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/tag

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can add or remove a tag from an application are:

  • Group Manager
  • Manager
  • User

API Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token

cURL

cURL Sample tag_application Snippet

Copy 

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/tag"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: application/json"
  -d "{  \"tagId\":<TAGID>,  \"isRemove\": <ISREMOVE>,  \"filterRequest\": {    \"filters\": [      {        \"field\": \"<FIELD>\",        \"exclusive\": <EXCLUSIVE>,        \"operator\": \"<OPERATOR>\",        \"value\": <VALUE>      }    ]  }}"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token
TAGID Tag ID number. integer
ISREMOVE Remove tag? Options: True = Yes, False = No
FIELD Filter field. string
EXCLUSIVE Exclusive. boolean Options: True, False
OPERATOR Search operator. Depends on value.
VALUE Search value. string

Response Parameters

Sample Response

Copy 

{
  "id": <ID>,
  "created": "<CREATED>"
}

Name Description Additional Information
ID Job ID number. integer
Created Date/Time job created. string($date-time)

HTTP Status Codes

Code Description
200 Job Created

200 Sample Response

Copy 
{
  "id": 0,
  "created": "2019-09-23T17:54:19.121Z"
}
Code Description
400 Bad Request
401 Unauthorized
404 Not Found

Deleting Entities Based on Filters

Delete entities based on filters.

API Call: POST/client/{clientId}/application/delete

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/delete

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can delete entities based on filters are:

  • Group Manager
  • Manager

API Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token

cURL

cURL Sample delete_applicationByFilter Snippet

Copy 

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/delete"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: application/json"
  -d "{  \"filterRequest\": {    \"filters\": [      {        \"field\": \"<FIELD>\",        \"exclusive\": <EXCLUSIVE>,        \"operator\": \"<OPERATOR>\",        \"value\": \"<VALUE>\"      }    ]  }}"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token
FIELD Filter field. string
EXCLUSIVE Exclusive. boolean Options: True, False
OPERATOR Search operator. Depends on value.
VALUE Search value. string

Response Parameters

Sample Response

Copy 

{
  "id": <ID>,
  "created": "<CREATED>"
}

Name Description Additional Information
ID Job ID number. integer
Created Date/Time job created. string($date-time)

HTTP Status Codes

Code Description
200 Job Created

200 Sample Response

Copy 
{
  "id": 0,
  "created": "2019-09-23T17:45:18.407Z"
}
Code Description
400 User Error
401 Unauthorized
404 Not Found

Updating an Application

Update an application.

API Call: POST/client/{clientId}/application/update

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/update

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user role that can update an application is:

  • Manager

API Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token

cURL

cURL Sample application_update Snippet

Copy 

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/host/update"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: application/json"
  -d "{  \"filterRequest\": {    \"filters\": [      {        \"field\": \"<FIELD>\",        \"exclusive\": <EXCLUSIVE>,        \"operator\": \"<OPERATOR>\",        \"value\": \"<VALUE>\"      }    ]  },  \"name\": <NAME>,  \"url\": \"<URL>\"}"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token
FIELD Filter field. string
EXCLUSIVE Exclusive. boolean Options: True, False
OPERATOR Search operator. Depends on value.
VALUE Search value. string
NAME Application name.
URL Application URL.

Response Parameters

Sample Response

Copy 

{
  "id": <ID>,
  "created": "<CREATED>"
}

Name Description Additional Information
ID Job ID number. integer
Created Date/Time job created. string($date-time)

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Copy 
{
  "id": 0,
  "created": "2019-09-23T17:56:51.384Z"
}
Code Description
400 Bad Request
401 Unauthorized
404 Not Found

Initiate Application Export Job

Initiate application export job.

API Call: POST/client/{clientId}/application/export

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/export

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can initiate an application export job are:

  • Group Manager
  • Manager
  • User

API Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token

cURL

cURL Sample application_export Snippet

Copy 

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/export"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: application/json" -d "{  \"filterRequest\": {    \"filters\": [      {        \"field\": \"<FIELD>\",        \"exclusive\": <EXCLUSIVE>,        \"operator\": \"<OPERATOR>\",        \"value\": \"<VALUE>\"      }    ]  },  \"fileType\": \"<FILETYPE>\",  \"comment\": \"<COMMENT>\",  \"fileName\": \"<FILENAME>\"}"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token
FIELD Filter field. string
EXCLUSIVE Exclusive. boolean Options: True, False
OPERATOR Search operator. Depends on value.
VALUE Search value. string
FILETYPE Export file type. Options: XML, XLSX, CSV
COMMENT Exported file description. string
FILENAME Exported file's name. string

Response Parameters

Sample Response

Copy 

{
  "id": 0,
  "created": "2019-09-17T16:59:16.922Z"
}

Name Description Type
ID Application Export ID number. integer
CREATED Job creation date. string($date-time)

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Copy 
{
  "id": 0,
  "created": "2019-09-17T16:59:16.922Z"
}
Code Description
400 Bad Request
401 Unauthorized
404 Not Found

Moving Applications to a Different Group

Move applications to a different group.

API Call: POST/client/{clientId}/application/group/move

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/group/move

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can move applications to a different group are:

  • Group Manager
  • Manager

API Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token

cURL

cURL Sample move_applicationGroups Snippet

Copy 

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/group/move"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: application/json"
  -d "{  \"filterRequest\": {    \"filters\": [      {        \"field\": \"<FIELD>\",        \"exclusive\": <EXCLUSIVE>,        \"operator\": \"<OPERATOR>\",        \"value\": \"<VALUE>\"      }    ]  },  \"targetGroupId\": <TARGETGROUPID>}"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token
FIELD Filter field. string
EXCLUSIVE Exclusive. boolean Options: True, False
OPERATOR Search operator. Depends on value.
VALUE Search value. string
TARGETGROUPID Target group ID number. integer

Response Parameters

Sample Response

Copy 

{
  "id": <ID>,
  "created": "<CREATED>"
}

Name Description Additional Information
ID Job ID number. integer
Created Date/Time job created. string($date-time)

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Copy 
{
  "id": 0,
  "created": "2019-09-23T17:39:22.341Z"
}
Code Description
400 User Error
401 Unauthorized
404 Not Found

Moving Applications to a Different Network Based on Filters

Move applications to a different network based on filters.

API Call: POST/client/{clientId}/application/network/move

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/network/move

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can move applications to a different network based on filters are:

  • Group Manager
  • Manager

API Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token

cURL

cURL Sample move_applicationFilters Snippet

Copy 

curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/network/move"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: application/json"
  -d "{  \"filterRequest\": {    \"filters\": [      {        \"field\": \"<FIELD>\",        \"exclusive\": <EXCLUSIVE>,        \"operator\": \"<OPERATOR>\",        \"value\": \"<VALUE>\"      }    ]  },  \"targetNetworkId\": <TARGETNETWORKID>,  \"isForceMerge\": <FORCEMERGE>}"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token
FIELD Filter field. string
EXCLUSIVE Exclusive. boolean Options: True, False
OPERATOR Search operator. Depends on value.
VALUE Search value. string
TARGETNETWORKID Network ID to move applications into. integer
FORCEMERGE Force merge applications into network? boolean Options: True, False

Response Parameters

Sample Response

Copy 

{
  "id": <ID>,
  "created": "<CREATED>"
}

Name Description Additional Information
ID Job ID number. integer
Created Date/Time job created. string($date-time)

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Copy 
{
  "id": 0,
  "created": "2019-09-23T17:33:45.811Z"
}
Code Description
400 User Error
401 Unauthorized
404 Not Found

Remediate Findings by Assessment

Remediate findings by assessment.

API Call: POST/client/{clientId}/application/update-remediation-by-assessment

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/update-remediation-by-assessment

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can remediate findings by assessment are:

  • Group Manager
  • Manager

API Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token

cURL

cURL Sample application_remediationByAssessment Snippet

Copy 

curl -X POST https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/update-remediation-by-assessment"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: application/json"
  -d "{  \"filterRequest\": {    \"filters\": [      {        \"field\": \"<FIELD>\",        \"exclusive\": <EXCLUSIVE>,        \"operator\": \"<OPERATOR>\",        \"value\": \"<VALUE>\"      }    ]  }}"


Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token
FIELD Filter field. string
EXCLUSIVE Exclusive. boolean Options: True, False
OPERATOR Search operator. Depends on value.
VALUE Search value. string

Response Parameters

Sample Response

Copy 

{
  "id": <ID>,
  "created": "<CREATED>"
}

Name Description Additional Information
ID Job ID number. integer
Created Date/Time job created. string($date-time)

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Copy 
{
  "id": 0,
  "created": "2019-09-23T09:48:29.939Z"
}
Code Description
400 Bad Request
401 Unauthorized
404 Not Found

Adding Notes to an Application

Add a note to an application.

API Call: POST/client/{clientId}/application/note

URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/note

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can add a note to a application are:

  • Group Manager
  • Manager
  • User

API Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token

cURL

cURL Sample add_applicationNote Snippet

Copy 
curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/application/note"
  -H  "accept: application/json"
  -H  "x-api-key: <APIKEY>"
  -H  "Content-Type: application/json" -d "{  \"filterRequest\": {    \"filters\": [      {        \"field\": \"<FIELD>\",        \"exclusive\": <EXCLUSIVE>,        \"operator\": \"<OPERATOR>\",        \"value\": \"<VALUE>/"      }    ]  },  \"note\": \"<NOTE>\"}"

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your API key. Generating an API Token
FIELD Filter field.
EXCLUSIVE Exclusive. Options: True, False
OPERATOR Filter Operator.
VALUE Search value.
NOTE Note to add to application.

Response Parameters

Sample Response

Copy 

{
  "id": <ID>,
  "created": "<CREATED>"
}

Name Description Additional Information
ID Job ID number. integer
Created Date/Time job created. string($date-time)

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Copy 
{
  "id": 0,
  "created": "2019-09-17T10:47:52.725Z"
}
Code Description
400 Bad Request
401 Unauthorized
404 Not Found