Get the information of the source list given for a specific time range.

GET {{baseUrl}}/v1/source/ip/:source/range/:time_range

What

Obtain the meta information of the source list and the time range given as arguments. A source list is a collection of resources combined together with other sources to create a dataset. A source list has some unique properties. The most relevant ones are the score and risk. The score is a number between 0 and 99 describing the probability of the IP address being a malicious one, being 0 means that the IP address is not malicious and is not a threat. Being 99 means that the service behind the IP address is probably malicious an certainly a threat.

The time ranges or lapse of time of each source are how the resources are stored according to their age. Each group by time range has a score and a risk.

Parameters

The endpoint accepts the following two parameters in the path: - source: (Mandatory) The code name that identifies uniquely the source list in the platform. It must be composed of uppercase letters, numbers and underscores. - time_range: (Mandatory) The code name that identifies uniquely the time ranges. Must be: 1H, 6H, 12H, 1D, 7D, 30D, 90D, 180D y 365D.

Result

The result is a JSON object with the following fields: - self: the URI to individual source list and time range information. - source: the URI to individual source list information. - items: Number of elements in the source list in the time range given. - lapse: The lapse of time or time range of the specific source list. Can be 1H, 6H, 12H, 1D, 7D, 30D, 90D, 180D or 365D. - score: The score found in the source list time range. Is in the range 0-99. - risk: The human readable risk score found in the source list time range. Can be UNKNOWN, LOW, MEDIUM or HIGH. - updated_at: The UNIX timestamp in milliseconds of last update of the source list.

Errors

• a 404 Not Found error if the source list code name was not found.
• a 404 Not Found error if the time range was not found.
• a 422 Unprocessable Entity error if source list code name or time ranges does not follow the naming convention.

It will return the API Global errors described in the API description.

HEADERS

RESPONSES

status: OK

{"self":"cillum commodo cupidatat","source":"adipisicing","lapse":"1D","items":32378297,"score":53256408,"risk":"UNKNOWN","updated_at":86644424}