Skip to main content

phishings

Creates, updates, deletes, gets or lists a phishings resource.

Overview​

Namephishings
TypeResource
Idovh.ip.phishings

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
idintegerInternal ID of the phishing entry
creation_datestring (date-time)Date of the event (wire: creationDate)
ip_on_antiphishingstring (ipv4)IP address hosting the phishing URL (example: 192.0.2.0) (wire: ipOnAntiphishing)
statestringCurrent state of the phishing (blocked, blocking, unblocked, unblocking)
url_phishingstringPhishing URL (wire: urlPhishing)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectid, ipGet a phishing report. Returns the phishing URL, the address hosting it, the date of the event and its state.
listselectipip_on_antiphishing, state, x_pagination_modeList phishing reports. Returns the IDs of phishing URLs found on the block, filterable by address or state.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
api_hoststringThe OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
idintegerInternal ID of the phishing entry
ipstring (ip-block)
ip_on_antiphishingstring (ipv4)Filter the value of ipOnAntiphishing property (within or equals) (wire: ipOnAntiphishing)
statestringFilter the value of state property (=)
x_pagination_modestringSent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples​

Get a phishing report. Returns the phishing URL, the address hosting it, the date of the event and its state.

SELECT
id,
creation_date,
ip_on_antiphishing,
state,
url_phishing
FROM ovh.ip.phishings
WHERE id = '{{ id }}' -- required
AND ip = '{{ ip }}' -- required
;