Get the full information of all the source lists for the subscription level given.
GET {{baseUrl}}/v1/source/ip
What
Obtain the full meta information of all the source lists available for the subscription level of the user. 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 does not accept any parameter. The subscription level is obtained from the token provided in the header.
Result
The result is a JSON object with a self reference and a list of JSON objects 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
It will return the API Global errors described in the API description.
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"self":"exercitation","sources":[{"self":"ut exercitation amet nisi","dataset":"ea magna Duis velit nulla","name":"Duis fugiat","description":"vel","source":"id velit ipsum adipisicing","url":"id quis proident aute","refresh":"180D","minimum_score":45022889,"maximum_score":42972308,"minimum_risk":"LOW","maximum_risk":"UNKNOWN","time_ranges":["eli","sunt"],"updated_at":-60457442},{"self":"ut officia in aute","dataset":"in dolor elit aute esse","name":"fugiat nisi aliquip dolore","description":"sit eiusmod deserunt et Duis","source":"ipsum incididunt consequat sit","url":"enim","refresh":"180D","minimum_score":-58826,"maximum_score":-69240753,"minimum_risk":"MEDIUM","maximum_risk":"MEDIUM","time_ranges":["fugiat sed Lorem","lab"],"updated_at":-6364279}]}