Get the full information of the source list given as argument.

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

What

Obtain the full meta information of the source list given as argument. 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.

Each source list groups several collections of resource by the lapse of time or time range that they are related to according to their age. Each group by time range has a score and a risk.

Parameters

The endpoint accepts only the following parameter 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.

Result

The result is a JSON object with the following fields: - self: the URI to individual source list information. - dataset: the URI to the dataset that aggregates the resources of this list. - name: the unique name of the source list. Must be uppercase letters, numbers and underscores. - description: a human readable long description of the source list. - source: Origin of the list. - url: The URL where the source list was found. - refresh: The refresh period of the source list. - minimum_score: The minimum score found in the different source list time ranges. Is in the range 0-99. - maximum_score: The maximum score found in the different source list time ranges. Is in the range 0-99. - minimum_risk: The minimum human readable risk score found in the different source list time ranges. Can be UNKNOWN, LOW, MEDIUM or HIGH. - maximum_risk: The maximum human readable risk score found in the different source list time ranges. Can be UNKNOWN, LOW, MEDIUM or HIGH. - time_range: the list of URIs pointing to the different source list time ranges information. - 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 422 Unprocessable Entity error if source list code name does not follow the naming convention.

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

HEADERS

RESPONSES

status: OK

{"self":"enim in velit cupidatat Excepteur","dataset":"et laborum in","name":"aliquip proident occaecat mollit Ut","description":"pariatur in voluptate","source":"reprehenderit ad","url":"laboris et ea exercitation","refresh":"12H","minimum_score":9463508,"maximum_score":3730766,"minimum_risk":"HIGH","maximum_risk":"UNKNOWN","time_ranges":["commodo cupidatat eiusmod aliqua aliquip","cillum proident et quis"],"updated_at":34403878}