ThreatJammer.com User API

Get the risk score of all IP address uploaded and other data signals. ### What Obtain a numerical score and a risk assessment of all the IP addresses uploaded with a text file. ### Parameters - A text file with a list of public IPv4 or IPv6 addresses. - A header `Content-Type: multipart/form-data` is required. - (optional) in the query string the parameeter `strict_parse`: If set to `true`, no malformed IP addresses allowed, returning an error. If set to `false`, malformed IP addresses will be ignored. Example: ``` curl -X 'POST' \ 'https://dublin.api.threatjammer.com/v1/asses/ip/csv[?strict_parse=true|false]' \ -H 'accept: application/json' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: multipart/form-data' \ -F 'csv_file=@YOUR_TEXT_FILE;type=text/csv' ``` ### Result The result contains a list of the result for each IP address, with two main sets of data: - 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 list of information gathered from the IP address to obtain the score. The result is a JSON object with the following structure: - ``self``: the URI of the API call - ``score``: The score of the IP address. It ranges from 0 to 99. - ``risk``: The risk of the IP address. The allowed values are: LOW, MEDIUM, HIGH. It's a human readable representation of the score. - ``reason``: It's a human readable representation of the reason of the risk. - ``datasets``: The IP address was found in the these lists of datasets used to obtain the risk score. Datasets are described as a list of URIs. - ``sources``: The IP address was found in the these source lists at an specific time with a specific risk score. Sources are described as a list of URIs. - ``log``: The activity of the IP address in the different datasets used to obtain the risk score. The log is a URI reference. - ``asn``: The information about the Autonomous System (AS) of the IP address. The AS is described as an URI. - ``asn_prefix``: The information about the Autonomous System (AS) network prefix of the IP address. The prefix is described as an URI. - ``datacenter``: If the IP address is part of a datacenter pool, the information about the datacenter is described as an URI. - ``datacenter_prefix``: The information about the Datacenter network prefix of the IP address. The `asn_prefix` and `datacenter_prefix` can be the same, but it is not mandatory. The prefix is described as an URI. - ``denylisted``: If the IP address was denylisted by the user, the information about the denylisted IP address is described as an URI. - ``first_appearence``: URI to the first appearance of the IP address in the different datasets used to obtain the risk score. - ``last_appearence``: URI to the last appearance of the IP address in the different datasets used to obtain the risk score. ### Errors The endpoint will return the following errors: - a `422 Unprocessable Entity` error if the IP address is malformed. The private IP addresses will be ignored, if any. When the `strict_parse` parameter is set to `true`, the endpoint will return the following errors: - a `400 Bad Request`. It will also return the API Global errors described in the API description.

Get the geolocation data of all the IP addresses uploaded. ### What Get the geo location data of all the IP addresses uploaded in a text file. This information includes: - Latitude and longitude - Time zone - Accuracy radius - Postal code - City name - Region - Country - Country of the service provider - Continent - Reverse PTR hostnames ### Parameters - A text file with a list of public IPv4 or IPv6 addresses. - A header `Content-Type: multipart/form-data` is required. - (optional) in the query string the parameeter `strict_parse`: If set to `true`, no malformed IP addresses allowed, returning an error. If set to `false`, malformed IP addresses will be ignored. Example: ``` curl -X 'POST' \ 'https://dublin.api.threatjammer.com/v1/geo/csv[?strict_parse=true|false]' \ -H 'accept: application/json' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: multipart/form-data' \ -F 'csv_file=@YOUR_TEXT_FILE;type=text/csv' ``` ### Result The result contains a list of the result for each IP address, with the following data set: The result is a JSON object with the following structure: - ``self``: the URI of the API call - ``accuracy_radius``: The radius in kilometers around the specified location where the IP address is likely to be. - ``asn_country_iso_code``: The ISO code of the country of the Autonomous System (AS) owner of the IP address. - ``city_geoname_code``:``: City geoname code. The geoname code by [GeoNames](https://en.wikipedia.org/wiki/GeoNames) is a unique identifier assigned to each geographical point on the globe. - ``city_name``:``: City name, in english. The developer can use the geoname code to localize the name of the city. - ``continent_code``: The continent code. It can be any of the following: AF, AN, AS, EU, NA, OC, SA. - ``country_iso_code``: The country ISO 3166-1 alpha-2 code. - ``hostnames``: The list of hostnames associated with the IP address obtained from the reverse DNS lookup. - ``latitude``: The latitude of the geolocation. - ``longitude``: The longitude of the geolocation. - ``postal_code``:``: The postal code of the city. - ``region_geoname_code``:``: The geoname code of the region. - ``region_name``:``: The region name, in english. The developer can use the geoname code to localize the name of the region. - ``time_zone``: The name of the time zone. ### Errors The endpoint will return the following errors: - a `422 Unprocessable Entity` error if the IP address is malformed. The private IP addresses will be ignored, if any. When the `strict_parse` parameter is set to `true`, the endpoint will return the following errors: - a `400 Bad Request`. It will also return the API Global errors described in the API description.

Get the risk score of all IP address passed in the body and other data signals. ### What Obtain a numerical score and a risk assessment of all the IP addresses passed as argument. ### Parameters A list of public IPv4 or IPv6 addresses is required in the body of the request. ### Result The result contains a list of the result for each IP address, with two main sets of data: - 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 list of information gathered from the IP address to obtain the score. The result is a JSON object with the following structure: - ``self``: the URI of the API call - ``score``: The score of the IP address. It ranges from 0 to 99. - ``risk``: The risk of the IP address. The allowed values are: LOW, MEDIUM, HIGH. It's a human readable representation of the score. - ``reason``: It's a human readable representation of the reason of the risk. - ``datasets``: The IP address was found in the these lists of datasets used to obtain the risk score. Datasets are described as a list of URIs. - ``sources``: The IP address was found in the these source lists at an specific time with a specific risk score. Sources are described as a list of URIs. - ``log``: The activity of the IP address in the different datasets used to obtain the risk score. The log is a URI reference. - ``asn``: The information about the Autonomous System (AS) of the IP address. The AS is described as an URI. - ``asn_prefix``: The information about the Autonomous System (AS) network prefix of the IP address. The prefix is described as an URI. - ``datacenter``: If the IP address is part of a datacenter pool, the information about the datacenter is described as an URI. - ``datacenter_prefix``: The information about the Datacenter network prefix of the IP address. The `asn_prefix` and `datacenter_prefix` can be the same, but it is not mandatory. The prefix is described as an URI. - ``denylisted``: If the IP address was denylisted by the user, the information about the denylisted IP address is described as an URI. - ``first_appearence``: URI to the first appearance of the IP address in the different datasets used to obtain the risk score. - ``last_appearence``: URI to the last appearance of the IP address in the different datasets used to obtain the risk score. ### Errors The endpoint will return the following errors: - a `422 Unprocessable Entity` error if the IP address is malformed. The private IP addresses will be ignored, if any. It will also return the API Global errors described in the API description.

Get a risk score of the IP address and different data signals. ### What Obtain a numerical score and a risk assessment of the IP address passed as argument. ### Parameters The only argument accepted in the query string is a public IPv4 or IPv6 addresses. ### Result The result contains two main sets of data: - 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 list of information gathered from the IP address to obtain the score. The result is a JSON object with the following structure: - ``self``: the URI of the API call - ``score``: The score of the IP address. It ranges from 0 to 99. - ``risk``: The risk of the IP address. The allowed values are: LOW, MEDIUM, HIGH. It's a human readable representation of the score. - ``reason``: It's a human readable representation of the reason of the risk. - ``datasets``: The IP address was found in the these lists of datasets used to obtain the risk score. Datasets are described as a list of URIs. - ``sources``: The IP address was found in the these source lists at an specific time with a specific risk score. Sources are described as a list of URIs. - ``log``: The activity of the IP address in the different datasets used to obtain the risk score. The log is a URI reference. - ``asn``: The information about the Autonomous System (AS) of the IP address. The AS is described as an URI. - ``asn_prefix``: The information about the Autonomous System (AS) network prefix of the IP address. The prefix is described as an URI. - ``datacenter``: If the IP address is part of a datacenter pool, the information about the datacenter is described as an URI. - ``datacenter_prefix``: The information about the Datacenter network prefix of the IP address. The `asn_prefix` and `datacenter_prefix` can be the same, but it is not mandatory. The prefix is described as an URI. - ``denylisted``: If the IP address was denylisted by the user, the information about the denylisted IP address is described as an URI. - ``first_appearence``: URI to the first appearance of the IP address in the different datasets used to obtain the risk score. - ``last_appearence``: URI to the last appearance of the IP address in the different datasets used to obtain the risk score. ### Errors The endpoint will return the following errors: - a `400 Bad Request` error if the IP address is not public. - a `422 Unprocessable Entity` error if the IP address is malformed. It will also return the API Global errors described in the API description.

Toogle the status of an allow list. ### What Change the status of an allow list to ``ACTIVE`` or ``INACTIVE``. An ``INACTIVE`` list will not be used by the service. An ``ACTIVE`` list will be used by the service. As an optional parameter it can be provided an ``expiry`` date in seconds since epoch. If not provided, the list will never expire. This is an asynchronous operation. It can take several seconds until the operation completes, but the request will immediately return a 202 Accepted response. ### Parameters In the query string the ID of the allow list to change the status. In the body the JSON object with the following fields: - ``status``: The status of the list. It can be ``ACTIVE`` or ``INACTIVE``. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. ### Result It should always return a 202 Accepted response with an empty body. ### Errors If the list does not exist, it will return a 404 error. If the status is not ``ACTIVE`` or ``INACTIVE``, it will return a 422 error. If the expiry is not a valid timestamp, it will return a 422 error. If the allow list is not a valid UUID, it will return a 422 error. It will return the API Global errors described in the API description.

Toogle the status of an deny list. ### What Change the status of an deny list to ``ACTIVE`` or ``INACTIVE``. An ``INACTIVE`` list will not be used by the service. An ``ACTIVE`` list will be used by the service. As an optional parameter it can be provided an ``expiry`` date in seconds since epoch. If not provided, the list will never expire. This is an asynchronous operation. It can take several seconds until the operation completes, but the request will immediately return a 202 Accepted response. ### Parameters In the query string the ID of the deny list to change the status. In the body the JSON object with the following fields: - ``status``: The status of the list. It can be ``ACTIVE`` or ``INACTIVE``. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. ### Result It should always return a 202 Accepted response with an empty body. ### Errors If the list does not exist, it will return a 404 error. If the status is not ``ACTIVE`` or ``INACTIVE``, it will return a 422 error. If the expiry is not a valid timestamp, it will return a 422 error. If the deny list is not a valid UUID, it will return a 422 error. It will return the API Global errors described in the API description.

Toogle the status of the origin in an allow list. ### What Change the status of the origin of an allow list to ``ACTIVE``, ``INACTIVE`` or ``DELETED``. An ``ACTIVE`` origin will apply the allow list to the protocol and domain of the origin. An origin can be created and activated simply toogling the ``ACTIVE`` status. As an optional parameter it can be provided an ``ttl`` or Time To Live parameter of the origin in the list in seconds. After the TTL expires, the origin will be removed from the list. If the TTL is not provided, the origin will never expire. An ``INACTIVE`` origin will not apply the allow list to the protocol and domain of the origin. A ``DELETED`` origin will be removed from the list. It will not be used by the service anymore. The user can activate it again with the ``ACTIVE`` status. This is an asynchronous operation. It can take several seconds until the operation completes, but the request will immediately return a 202 Accepted response. *This operation is not available in the Freemium plan.* ### Parameters In the query string the ID of the allow list to change the status. In the body the JSON object with the following fields: - ``origin``: The protocol and domain of the origin. It can be ``http://example.com`` or ``https://example.com``. - ``status``: The status of the list. It can be ``ACTIVE``, ``INACTIVE`` or ``DELETED``. ### Result It should always return a 202 Accepted response with an empty body. ### Errors If the list does not exist, it will return a 404 error. If the status is not ``ACTIVE`` or ``INACTIVE``, it will return a 422 error. If the TTL is negative in the past, it will return a 422 error. If the allow list is not a valid UUID, it will return a 422 error. If the origin is not a valid URL, it will return a 400 error. If the allowlist is not active, it will returna 409 error. If the origin is not found in the set owned by the user, it will return a 404 error. It will return the API Global errors described in the API description.

Toogle the status of the origin in an allow list. ### What Change the status of the origin of an allow list to ``ACTIVE``, ``INACTIVE`` or ``DELETED``. An ``ACTIVE`` origin will apply the allow list to the protocol and domain of the origin. An origin can be created and activated simply toogling the ``ACTIVE`` status. As an optional parameter it can be provided an ``ttl`` or Time To Live parameter of the origin in the list in seconds. After the TTL expires, the origin will be removed from the list. If the TTL is not provided, the origin will never expire. An ``INACTIVE`` origin will not apply the allow list to the protocol and domain of the origin. A ``DELETED`` origin will be removed from the list. It will not be used by the service anymore. The user can activate it again with the ``ACTIVE`` status. This is an asynchronous operation. It can take several seconds until the operation completes, but the request will immediately return a 202 Accepted response. *This operation is not available in the Freemium plan.* ### Parameters In the query string the ID of the allow list to change the status. In the body the JSON object with the following fields: - ``origin``: The protocol and domain of the origin. It can be ``http://example.com`` or ``https://example.com``. - ``status``: The status of the list. It can be ``ACTIVE``, ``INACTIVE`` or ``DELETED``. ### Result It should always return a 202 Accepted response with an empty body. ### Errors If the list does not exist, it will return a 404 error. If the status is not ``ACTIVE`` or ``INACTIVE``, it will return a 422 error. If the TTL is negative in the past, it will return a 422 error. If the allow list is not a valid UUID, it will return a 422 error. If the origin is not a valid URL, it will return a 400 error. If the allowlist is not active, it will returna 409 error. If the origin is not found in the set owned by the user, it will return a 404 error. It will return the API Global errors described in the API description.

Toogle the status of the origin in a deny list. ### What Change the status of the origin of a deny list to ``ACTIVE``, ``INACTIVE`` or ``DELETED``. An ``ACTIVE`` origin will apply the deny list to the protocol and domain of the origin. An origin can be created and activated simply toogling the ``ACTIVE`` status. As an optional parameter it can be provided an ``ttl`` or Time To Live parameter of the origin in the list in seconds. After the TTL expires, the origin will be removed from the list. If the TTL is not provided, the origin will never expire. An ``INACTIVE`` origin will not apply the deny list to the protocol and domain of the origin. A ``DELETED`` origin will be removed from the list. It will not be used by the service anymore. The user can activate it again with the ``ACTIVE`` status. This is an asynchronous operation. It can take several seconds until the operation completes, but the request will immediately return a 202 Accepted response. *This operation is not available in the Freemium plan.* ### Parameters In the query string the ID of the deny list to change the status. In the body the JSON object with the following fields: - ``origin``: The protocol and domain of the origin. It can be ``http://example.com`` or ``https://example.com``. - ``status``: The status of the list. It can be ``ACTIVE``, ``INACTIVE`` or ``DELETED``. ### Result It should always return a 202 Accepted response with an empty body. ### Errors If the list does not exist, it will return a 404 error. If the status is not ``ACTIVE`` or ``INACTIVE``, it will return a 422 error. If the TTL is negative in the past, it will return a 422 error. If the deny list is not a valid UUID, it will return a 422 error. If the origin is not a valid URL, it will return a 400 error. If the denylist is not active, it will returna 409 error. If the origin is not found in the set owned by the user, it will return a 404 error. It will return the API Global errors described in the API description.

Toogle the status of the origin in a deny list. ### What Change the status of the origin of a deny list to ``ACTIVE``, ``INACTIVE`` or ``DELETED``. An ``ACTIVE`` origin will apply the deny list to the protocol and domain of the origin. An origin can be created and activated simply toogling the ``ACTIVE`` status. As an optional parameter it can be provided an ``ttl`` or Time To Live parameter of the origin in the list in seconds. After the TTL expires, the origin will be removed from the list. If the TTL is not provided, the origin will never expire. An ``INACTIVE`` origin will not apply the deny list to the protocol and domain of the origin. A ``DELETED`` origin will be removed from the list. It will not be used by the service anymore. The user can activate it again with the ``ACTIVE`` status. This is an asynchronous operation. It can take several seconds until the operation completes, but the request will immediately return a 202 Accepted response. *This operation is not available in the Freemium plan.* ### Parameters In the query string the ID of the deny list to change the status. In the body the JSON object with the following fields: - ``origin``: The protocol and domain of the origin. It can be ``http://example.com`` or ``https://example.com``. - ``status``: The status of the list. It can be ``ACTIVE``, ``INACTIVE`` or ``DELETED``. ### Result It should always return a 202 Accepted response with an empty body. ### Errors If the list does not exist, it will return a 404 error. If the status is not ``ACTIVE`` or ``INACTIVE``, it will return a 422 error. If the TTL is negative in the past, it will return a 422 error. If the deny list is not a valid UUID, it will return a 422 error. If the origin is not a valid URL, it will return a 400 error. If the denylist is not active, it will returna 409 error. If the origin is not found in the set owned by the user, it will return a 404 error. It will return the API Global errors described in the API description.

Create an origin token of the user in the region. ### What Creates a new origin token for the user passing as argument the origin. The origin parameter is the protocol and the domain where the origin token is valid. The origin token is a special key used in conjunction with javascript library used for abuse detection. This key is owned by the user and is used to identify the origin of the request. Hence, the protocol and domain of the origin must be the one where the javascript is loaded. ### Parameters The origin with the protocol and domain is required in the body of the request in the parameter ``origin``. The allowed protocols are ``https://``, and ``http://``. ### Result The result is a JSON object with the new origin token and the following fields: - ``self``: the URI to individual origin token information. - ``region_id``: the name of the region where the origin token is valid. - ``origin``: the protocol and the domain where the origin token is valid. - ``status``: the status of the origin token. The only allowed values are ``ENABLED`` and ``DISABLED``. - ``created_at``: the date and time when the origin token was created in UNIX timestamp in milliseconds. - ``updated_at``: the date and time when the origin token was last updated in UNIX timestamp in milliseconds. ### Errors It will return the API Global errors described in the API description. It will also return the following errors: - a `400 Bad Request` error if the origin does not have the correct format. - a `409 Conflict` error if the origin token already exists.

Creates a new private allowlist binded to the user. ### What Creates a new allowlist with the information given and binded to the current user. The parameters are: - name - description - tags - expiry - Time to Live (TTL) - Resource Type (`CIDR`, `AS`, `COUNTRY`, `CONTINENT`, `DATACENTER_ID` and `USER AGENT`) This is an asynchronous operation. It can take several seconds until the operation completes, but the request will immediately return a 202 Accepted response. The operation will also return the UUID of the list. ### Parameters In the query string the ID of the private allow list to delete. In the body the following parameters: - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``tags``: A list of tags that describe the list. - ``ttl``: (Optional) The Time To Live of the list, in seconds. If it does not exist, it will never expire. - ``resource_type``: The type of resource that the list contains. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT``, ``DATACENTER_ID`` or ``USER AGENT``. ### Result It should always return a 202 Accepted response with the UUID of the new list in the body. ### Errors - If the information is not valid, it will return a `422` (Unprocessable Entity) error. - If the ttl is negative, it will return a `400` (Bad Request) error. It will return the API Global errors described in the API description.

Creates a new private denylist binded to the user. ### What Creates a new denylist with the information given and binded to the current user. The parameters are: - name - description - tags - expiry - Time to Live (TTL) - Resource Type (`CIDR`, `AS`, `COUNTRY`, `CONTINENT`, `DATACENTER_ID` and `USER AGENT`) This is an asynchronous operation. It can take several seconds until the operation completes, but the request will immediately return a 202 Accepted response. The operation will also return the UUID of the list. ### Parameters In the query string the ID of the private deny list to delete. In the body the following parameters: - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``tags``: A list of tags that describe the list. - ``ttl``: (Optional) The Time To Live of the list, in seconds. If it does not exist, it will never expire. - ``resource_type``: The type of resource that the list contains. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT``, ``DATACENTER_ID`` or ``USER AGENT``. ### Result It should always return a 202 Accepted response with the UUID of the new list in the body. ### Errors - If the information is not valid, it will return a `422` (Unprocessable Entity) error. - If the ttl is negative, it will return a `400` (Bad Request) error. It will return the API Global errors described in the API description.

Delete all the automatically reported IP addresses by the user. ### What Delete all the IP addresses that have been automatically reported by the user. This option cannot be reverted. ### Parameters No parameters are required. ### Result A successful result is an empty response with the the HTTP status code ``204 No Content``. ### Errors It will return the API Global errors described in the API description.

Delete the automatically reported IP address by the user. ### What Delete an IP address that was automatically reported by the user. This option cannot be reverted. ### Parameters The endpoint accepts the following parameters in the path: - ``ip_address``: (Mandatory) The public IPv4 or IPv6 addresses to be deleted. ### Result A successful result is an empty response with the the HTTP status code ``204 No Content``. ### Errors - a `422 Unprocessable Entity` error if the IP address is malformed. It will also return the API Global errors described in the API description.

Delete all the content of a private allowlist of the user. ### What Delete all the content of a private allowlist of the user. This will remove all the elements, and there is no way to recover them. ### Parameters Pass the private allowlist ID as query parameter. ### Result If successful, it will return a ``202`` (Accepted) response with an empty body. The operation is asynchronous,and can take several seconds to complete. ### Errors - If the allow list is not a valid UUID, it will return a ``422`` (Unprocessable Entity) error. - If the private allowlist ID does not exist, it will return a ``404`` (Not found) error. It will also return the API Global errors described in the API description.

Delete all the bindings between a user and a private allowlist. ### What Delete all the bindings between a user and a private allowlist. This will remove the content of the allowlist, the allowlist from the user and also all the origins that are using the allowlist. This is an asynchronous operation. It can take several seconds until the operation completes, but the request willimmediately return a 202 Accepted response. ### Parameters In the query string the ID of the private allow list to delete. ### Result It should always return a 202 Accepted response with an empty body. ### Errors - If the list does not exist, it will return a 404 error. - If the allow list is not a valid UUID, it will return a 422 error. It will return the API Global errors described in the API description.

Delete all the bindings between a user and an allowlist. ### What Delete all the bindings between a user and an allowlist. This will remove the allowlist from the user and also all the origins that are using the allowlist. This is an asynchronous operation. It can take several seconds until the operation completes, but the request will immediately return a 202 Accepted response. ### Parameters In the query string the ID of the allow list to change the status. ### Result It should always return a 202 Accepted response with an empty body. ### Errors If the list does not exist, it will return a 404 error. If the allow list is not a valid UUID, it will return a 422 error. It will return the API Global errors described in the API description.

Delete all the content of a private denylist of the user. ### What Delete all the content of a private denylist of the user. This will remove all the elements, and there is no way to recover them. ### Parameters Pass the private denylist ID as query parameter. ### Result If successful, it will return a ``202`` (Accepted) response with an empty body. The operation is asynchronous,and can take several seconds to complete. ### Errors - If the deny list is not a valid UUID, it will return a ``422`` (Unprocessable Entity) error. - If the private denylist ID does not exist, it will return a ``404`` (Not found) error. It will also return the API Global errors described in the API description.

Delete all the bindings between a user and a private denylist. ### What Delete all the bindings between a user and a private denylist. This will remove the content of the denylist, the denylist from the user and also all the origins that are using the denylist. This is an asynchronous operation. It can take several seconds until the operation completes, but the request willimmediately return a 202 Accepted response. The default lists ``External sources reported CIDRs`` and ``Default denylist`` cannot be deleted, but can be emptied. Please refer to the documentation to delete the content. ### Parameters In the query string the ID of the private deny list to delete. ### Result It should always return a 202 Accepted response with an empty body. ### Errors - If the list does not exist, it will return a `404` (Not found) error. - If the list is a default list, it will return a `403` (Forbidden) error. - If the deny list is not a valid UUID, it will return a `422` (Unprocessable Entity) error. It will return the API Global errors described in the API description.

Delete all the bindings between a user and an denylist. ### What Delete all the bindings between a user and an denylist. This will remove the denylist from the user and also all the origins that are using the denylist. This is an asynchronous operation. It can take several seconds until the operation completes, but the request will immediately return a 202 Accepted response. ### Parameters In the query string the ID of the deny list to change the status. ### Result It should always return a 202 Accepted response with an empty body. ### Errors If the list does not exist, it will return a 404 error. If the deny list is not a valid UUID, it will return a 422 error. It will return the API Global errors described in the API description.

Delete an origin token of the user in the region. ### What Deletes the origin token passed as argument of the user in the selected region. Once the token is deleted, it will no longer be valid and the protocol and domain of the origin will no longer be under protection. To delete an origin token, the user must be the owner and the token must be ``DISABLED`` first. ### Parameters The Origin Token is required in the body of the request in the parameter `origin_token_id`. ### Result If successful, the result will be an empty response with a status code of `204 No Content`. ### Errors It will return the API Global errors described in the API description. It will also return the following errors: - a `404 Not Found` error if the origin token is not found. - a `409 Conflict` error if the origin token is not disabled.

Disable a enabled origin token of the user in the region. ### What Disable an enabled origin token passed as argument of the user in the selected region. When a token is enabled, it will participate in the protection of the origin protocol and domain. If the token is disabled, it will not participate in the protection of the origin protocol and domain. To disable an origin token, the user must be the owner. If the token is already disabled, the function will not perform any action. If the token is enabled, it will be disabled. ### Parameters The Origin Token is required in the body of the request in the parameter `origin_token_id`. ### Result If successful, the result will be an empty response with a status code of `204 No Content`. ### Errors It will return the API Global errors described in the API description. It will also return the following errors: - a `404 Not Found` error if the origin token is not found.

Enable a disabled origin token of the user in the region. ### What Enable a disabled origin token passed as argument of the user in the selected region. When a token is enabled, it will participate in the protection of the origin protocol and domain. If the token is disabled, it will not participate in the protection of the origin protocol and domain. To enable an origin token, the user must be the owner. If the token is already enabled, the function will not perform any action. If the token is disabled, it will be enabled. ### Parameters The Origin Token is required in the body of the request in the parameter `origin_token_id`. ### Result If successful, the result will be an empty response with a status code of `204 No Content`. ### Errors It will return the API Global errors described in the API description. It will also return the following errors: - a `404 Not Found` error if the origin token is not found.

Get the geolocation data of the IP addresses set. ### What Get the geo location data of all the IP addresses passed as argument. This information includes: - Latitude and longitude - Time zone - Accuracy radius - Postal code - City name - Region - Country - Country of the service provider - Continent - Reverse PTR hostnames ### Parameters A list of public IPv4 or IPv6 addresses is required in the body of the request. ### Result The result contains a list of the result for each IP address, with the following data set: The result is a JSON object with the following structure: - ``self``: the URI of the API call - ``accuracy_radius``: The radius in kilometers around the specified location where the IP address is likely to be. - ``asn_country_iso_code``: The ISO code of the country of the Autonomous System (AS) owner of the IP address. - ``city_geoname_code``:``: City geoname code. The geoname code by [GeoNames](https://en.wikipedia.org/wiki/GeoNames) is a unique identifier assigned to each geographical point on the globe. - ``city_name``:``: City name, in english. The developer can use the geoname code to localize the name of the city. - ``continent_code``: The continent code. It can be any of the following: AF, AN, AS, EU, NA, OC, SA. - ``country_iso_code``: The country ISO 3166-1 alpha-2 code. - ``hostnames``: The list of hostnames associated with the IP address obtained from the reverse DNS lookup. - ``latitude``: The latitude of the geolocation. - ``longitude``: The longitude of the geolocation. - ``postal_code``:``: The postal code of the city. - ``region_geoname_code``:``: The geoname code of the region. - ``region_name``:``: The region name, in english. The developer can use the geoname code to localize the name of the region. - ``time_zone``: The name of the time zone. ### Errors The endpoint will return the following errors: - a `422 Unprocessable Entity` error if the IP address is malformed. The private IP addresses will be ignored, if any. It will also return the API Global errors described in the API description.

Get the geo location data of the IP address. ### What Get the geo location data of the IP address passed as argument. This information includes: - Latitude and longitude - Time zone - Accuracy radius - Postal code - City name - Region - Country - Country of the service provider - Continent - Reverse PTR hostnames ### Parameters The only argument accepted in the query string is a public IPv4 or IPv6 addresses. ### Result The result contains the following set of data: The result is a JSON object with the following structure: - ``self``: the URI of the API call - ``accuracy_radius``: The radius in kilometers around the specified location where the IP address is likely to be. - ``asn_country_iso_code``: The ISO code of the country of the Autonomous System (AS) owner of the IP address. - ``city_geoname_code``:``: City geoname code. The geoname code by [GeoNames](https://en.wikipedia.org/wiki/GeoNames) is a unique identifier assigned to each geographical point on the globe. - ``city_name``:``: City name, in english. The developer can use the geoname code to localize the name of the city. - ``continent_code``: The continent code. It can be any of the following: AF, AN, AS, EU, NA, OC, SA. - ``country_iso_code``: The country ISO 3166-1 alpha-2 code. - ``hostnames``: The list of hostnames associated with the IP address obtained from the reverse DNS lookup. - ``latitude``: The latitude of the geolocation. - ``longitude``: The longitude of the geolocation. - ``postal_code``:``: The postal code of the city. - ``region_geoname_code``:``: The geoname code of the region. - ``region_name``:``: The region name, in english. The developer can use the geoname code to localize the name of the region. - ``time_zone``: The name of the time zone. ### Errors The endpoint will return the following errors: - a `400 Bad Request` error if the IP address is not public. - a `422 Unprocessable Entity` error if the IP address is malformed. It will also return the API Global errors described in the API description.

Get the set of public allowlists of a user by resource type. ### What Obtain the set of public allow lists selected by the user and wich ones are not filtering by the resource type. ### Parameters The ``resource type`` to filter. The values can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. ### Result The result is a JSON object with a list of the following JSON objects: - ``self``: the URI to the status of all the lists. - ``lists``: a list of JSON objects with the available lists: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``status``: The status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as an allowlist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors It will return the API Global errors described in the API description.

Get the set of public denylists of a user by resource type. ### What Obtain the set of public deny lists selected by the user and wich ones are not filtering by the resource type. ### Parameters The ``resource type`` to filter. The values can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. ### Result The result is a JSON object with a list of the following JSON objects: - ``self``: the URI to the status of all the lists. - ``lists``: a list of JSON objects with the available lists: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``status``: The status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as an denylist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors It will return the API Global errors described in the API description.

Get the set of private allowlists of the user by resource type. ### What Obtain the set of private allow lists of the user available in the service filtering by resource type. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID`` ### Parameters The ``resource type`` to filter. The values can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. ### Result The result is a JSON object with a list of the following JSON objects: - ``self``: the URI to the status of all the lists. - ``lists``: a list of JSON objects with the available lists: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as a allowlist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors - If the resource type is not valid, it will return a ``400`` error. It will also return the API Global errors described in the API description.

Get the set of private allowlists of the user. ### What Obtain the set of private allow lists of the user available in the service. ### Parameters No parameters ### Result The result is a JSON object with a list of the following JSON objects: - ``self``: the URI to the status of all the lists. - ``lists``: a list of JSON objects with the available lists: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as a allowlist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors It will return the API Global errors described in the API description.

Get the set of private denylists of the user by resource type. ### What Obtain the set of private deny lists of the user available in the service filtering by resource type. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID`` These lists are different datasets: - Lists that are part of the automatically reported data from the Report IP, focused on honeypots and automaticreporting from external sources. The name is `External sources reported CIDRs`. The resource type is ``CIDR``. - Lists that are part of the automatically denylisted by the Threat Jammer service. The name is `Default denylist`. The resource type is ``CIDR``. - Lists that are created by the user. ### Parameters The ``resource type`` to filter. The values can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. ### Result The result is a JSON object with a list of the following JSON objects: - ``self``: the URI to the status of all the lists. - ``lists``: a list of JSON objects with the available lists: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as a denylist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors - If the resource type is not valid, it will return a ``422`` (Unprocessable Entity) error. It will also return the API Global errors described in the API description.

Get the set of private denylists of the user. ### What Obtain the set of private deny lists of the user available in the service. These lists are different datasets: - Lists that are part of the automatically reported data from the Report IP, focused on honeypots and automaticreporting from external sources. The name is `External sources reported CIDRs`. - Lists that are part of the automatically denylisted by the Threat Jammer service. The name is `Default denylist`. - Lists that are created by the user. ### Parameters No parameters ### Result The result is a JSON object with a list of the following JSON objects: - ``self``: the URI to the status of all the lists. - ``lists``: a list of JSON objects with the available lists: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as a denylist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors It will return the API Global errors described in the API description.

Get the set of public allowlists by resource type. ### What Obtain the set of public allow lists available in the service and also which ones are already selected by the user and wich ones are not filtering by the resource type. ### Parameters The ``resource type`` to filter. The values can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. ### Result The result is a JSON object with a list of the following JSON objects: - ``self``: the URI to the status of all the lists. - ``lists``: a list of JSON objects with the available lists: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``status``: The status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. If the list is already selected by the user, the JSON object will also contain the following fields: - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as an allowlist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors It will return the API Global errors described in the API description.

Get the set of public allowlists. ### What Obtain the set of public allow lists available in the service and also which ones are already selected by the user and wich ones are not. ### Parameters No parameters ### Result The result is a JSON object with a list of the following JSON objects: - ``self``: the URI to the status of all the lists. - ``lists``: a list of JSON objects with the available lists: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``status``: The status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. If the list is already selected by the user, the JSON object will also contain the following fields: - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as an allowlist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors It will return the API Global errors described in the API description.

Get the set of public denylists by resource type. ### What Obtain the set of public deny lists available in the service and also which ones are already selected by the user and wich ones are not filtering by the resource type. ### Parameters The ``resource type`` to filter. The values can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. ### Result The result is a JSON object with a list of the following JSON objects: - ``self``: the URI to the status of all the lists. - ``lists``: a list of JSON objects with the available lists: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``status``: The status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. If the list is already selected by the user, the JSON object will also contain the following fields: - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as an denylist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors It will return the API Global errors described in the API description.

Get the set of public denylists. ### What Obtain the set of public deny lists available in the service and also which ones are already selected by the user and wich ones are not. ### Parameters No parameters ### Result The result is a JSON object with a list of the following JSON objects: - ``self``: the URI to the status of all the lists. - ``lists``: a list of JSON objects with the available lists: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``status``: The status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. If the list is already selected by the user, the JSON object will also contain the following fields: - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as an denylist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors It will return the API Global errors described in the API description.

Get the full information of all the source lists for the subscription level given. ### 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.

Get the content of a private allowlist of the user. ### What Returns the content of the private allowlist of the user. The content can be CIDRs, ASNs, countries, continents or datacenter IDs. ### Parameters Pass the private allowlist ID as query parameter. ### Result The result is a JSON object with the following structure: - ``self``: the URI to the content of the list. - ``cidrs``: (Optional) list of CIDRs in the list. - ``asns``: (Optional) list of ASNs in the list. - ``countries``: (Optional) list of countries in the list. - ``continents``: (Optional) list of continents in the list. - ``datacenters``: (Optional) list of datacenters in the list. ### Errors - If the allow list is not a valid UUID, it will return a ``422`` (Unprocessable Entity) error. - If the private allowlist ID does not exist, it will return a ``404`` (Not found) error. It will also return the API Global errors described in the API description.

Get the content of a private denylist of the user. ### What Returns the content of the private denylist of the user. The content can be CIDRs, ASNs, countries, continents or datacenter IDs. ### Parameters Pass the private denylist ID as query parameter. ### Result The result is a JSON object with the following structure: - ``self``: the URI to the content of the list. - ``cidrs``: (Optional) list of CIDRs in the list. - ``asns``: (Optional) list of ASNs in the list. - ``countries``: (Optional) list of countries in the list. - ``continents``: (Optional) list of continents in the list. - ``datacenters``: (Optional) list of datacenters in the list. ### Errors - If the deny list is not a valid UUID, it will return a ``422`` (Unprocessable Entity) error. - If the private denylist ID does not exist, it will return a ``404`` (Not found) error. It will also return the API Global errors described in the API description.

Get the set of owned allowlists. ### What Obtain the set of public allow lists available in the service selected by the user. ### Parameters No parameters ### Result The result is a JSON object with a list of the following JSON objects: - ``self``: the URI to the status of all the lists. - ``lists``: a list of JSON objects with the available lists: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``status``: The status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as an allowlist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors It will return the API Global errors described in the API description.

Get the set of owned denylists. ### What Obtain the set of public deny lists available in the service selected by the user. ### Parameters No parameters ### Result The result is a JSON object with a list of the following JSON objects: - ``self``: the URI to the status of all the lists. - ``lists``: a list of JSON objects with the available lists: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``status``: The status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as an denylist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors It will return the API Global errors described in the API description.

Get the details of a specific private allowlist of the user. ### What Obtain the details of the private allow list of the user available in the service. ### Parameters Pass the private allowlist ID as query parameter. ### Result The result is a JSON object with the following structure: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as a allowlist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors - If the allow list is not a valid UUID, it will return a 422 error. - If the private allowlist ID does not exist, it will return a ``404`` error. It will also return the API Global errors described in the API description.

Get the details of the allowlist. ### What Obtain the details of an allow list available in the service. ### Parameters No parameters ### Result The result is a JSON object with a list of the following JSON objects: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``status``: The status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED``it means that the list is not available anymore if not renewed. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. If the list is already selected by the user, the JSON object will also contain the following fields: - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as an allowlist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors If the list does not exist, it will return a 404 error. It will return the API Global errors described in the API description.

Get the details of a specific private denylist of the user. ### What Obtain the details of the private deny list of the user available in the service. ### Parameters Pass the private denylist ID as query parameter. ### Result The result is a JSON object with the following structure: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as a denylist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors - If the deny list is not a valid UUID, it will return a ``422`` (Unprocessable Entity) error. - If the private denylist ID does not exist, it will return a ``404`` (Not found) error. It will also return the API Global errors described in the API description.

Get the details of the denylist. ### What Obtain the details of an deny list available in the service. ### Parameters No parameters ### Result The result is a JSON object with a list of the following JSON objects: - ``self``: the URI to individual information of the list. - ``name``: A human readable name of the list. - ``description``: A long detailed information about what the list contains and how it is used. - ``resource_type``: The type of the list. It can be ``CIDR``, ``AS``, ``COUNTRY``, ``CONTINENT`` or ``DATACENTER_ID``. - ``list_type``: The type of the list. It can be ``ALLOW`` or ``DENY``. - ``status``: The status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED``it means that the list is not available anymore if not renewed. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. If the list is already selected by the user, the JSON object will also contain the following fields: - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``origins``: list of websites that are using the list as an denylist. - ``self``: the URI to all the list of origins. - ``lists``: list of lists that the origin is using. - ``self``: the URI to the individual information of the list. - ``origin``: the protocol and domain of the website that is using the list. - ``status``: the status of the list. It can be ``ACTIVE`` or ``INACTIVE`` or ``EXPIRED``. If the list is ``EXPIRED`` it means that the list is not available anymore if not renewed. - ``expiry``: Unix timestamp in seconds when the list will expire. If it does not exist, it will never expire. - ``created_at``: Unix timestamp in seconds when the list was created. - ``updated_at``: Unix timestamp in seconds when the list was updated. ### Errors If the list does not exist, it will return a 404 error. It will return the API Global errors described in the API description.

Get the information of the source list given for a specific 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.

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

Get a log event. ### What Obtain the full detail of a specific log change. ### Parameters The endpoint accepts only the following parameters in the path: - ``logchange_id``: (Mandatory) A unique integer of the change event log. ### Result The result is a JSON object with the following structure: - ``self``: the URI of the API call - ``cidr``: The CIDR affected by the change. - ``score``: The score of the IP address when the event happened. It ranges from 0 to 99. - ``risk``: The risk of the IP address when the event happened. The allowed values are: LOW, MEDIUM, HIGH. It's a human readable representation of the score. - ``dataset``: The URI of the dataset where the change was logged. - ``source``: The URI of the data source where the change was found. - ``lapse``: The time elapsed between the event found and the moment the source was queried. The possible values are: 1H, 6H, 12H, 1D, 7D, 30D, 90D, 180D, 365D. - ``action``: The action that was performed on the IP address. The allowed values are: ADD, DELETE. - ``timestamp``: The UNIX timestamp in milliseconds when the change was logged. ### Errors The endpoint will return the following errors: - a `404 Not Found` error if there is no event in the log with the ``logchange_ID`` given. - a `422 Unprocessable Entity` error if the ``logchange_ID`` is malformed. It will also return the API Global errors described in the API description.

Get the changes logged in the different datasets of an IP address. ### What Obtain a list of changes logged in the different datasets of the IP address given. ### Parameters The endpoint accepts the following parameters in the path: - ``ip_address``: (Mandatory) The public IPv4 or IPv6 addresses to be queried. The endpoint accepts the following parameters in the query string: - ``dataset``: (Optional) Name of the dataset to filter the query. If not given, then all datasets are queried. If given, then only the changes logged in the given dataset are returned. The list of datasets is obtained from the ``/v1/dataset/ip`` endpoint. - ``logged_after``: (Optional) The UNIX timestamp in milliseconds of the earliest date to be included in the query. If not given, then the earliest date is the date of the first change logged in the dataset. ### Result The result is a JSON object with the following structure: - ``self``: the URI of the API call - ``logs``: The list of log changes. Each element of the list is a JSON object of a specific log change with the structure described in the endpoint ``/v1/log/ip/id/logchange_id``. ### Errors The endpoint will return the following errors: - a `400 Bad Request` error if the IP address is not public. - a `400 Bad Request` error if the timestamp is in the future. - a `400 Bad Request` error if the dataset is not a string that can have numbers, upper and lower case letters, and underscores. - a `404 Not Found` error if the dataset was not found. - a `422 Unprocessable Entity` error if the IP address is malformed. It will also return the API Global errors described in the API description.

Get the information found in an User Agent. ### What Get the information found in the User Agent passed as argument. This information includes: - Type - Render Engine - Version - Vendor - Operating System - Device - How common is the agent worldwide ### Parameters The only argument accepted in the query string is an URL encoded User Agent string. ### Result The result contains the following set of data: The result is a JSON object with the following structure: - ``self``: the URI of the API call - ``string``: The full user agent string passed as argument. - ``classification``: The classification of the user agent. It can be one of the following: ``CRAWLER``, ``CLIENT``, ``UNKNOWN``. - ``type``: An URI to the type of user agent used to identify the client (browser, bot, crawler, etc.). - ``agent``: Name of the agent and the version, if any. - ``engine``: Agent render engine. - ``version``: Version of the agent. - ``latest``: Latests known version of the agent. - ``family``: URI to the family of the agent. - ``vendor``: URI to the vendor or company that produces the agent. - ``os``: URI to the operating system used by the agent. - ``device``: URI to the device used by the agent. - ``frequent``: If the agent is frequently used worlwide or not. The values are ``COMMON``, ``RARE``, and ``UNKNOWN``. ### Errors The endpoint will return the API Global errors described in the API description.