Service Methods

This page provides details regarding the service methods that are exposed by the URLVoid DXL Python Service. When a DXL Request message is received, each of these methods will invoke the corresponding URLVoid API method and return the result as a DXL Response message.

The URLVoid DXL Python Service uses JSON payloads for the DXL Request messages. The DXL Response message payload is in XML format (as it was received from the URLVoid API service).

Host Info

Displays information about the specified website (host).

• DXL Request Topic
  • /opendxl-urlvoid/service/urlvapi/host/info
• Request Fields
  • host : The host to report on (Required)
• Response
  • XML as received from URLVoid API Service (see URLVoid API documentation)

Host Rescan

Updates the report for the specified website (triggers a rescan).

• DXL Request Topic
  • /opendxl-urlvoid/service/urlvapi/host/rescan
• Request Fields
  • host : The host to rescan (Required)
• Response
  • XML as received from URLVoid API Service (see URLVoid API documentation)

Host Scan

Scans a new website (host) that does not currently exist in the URLVoid database.

• DXL Request Topic
  • /opendxl-urlvoid/service/urlvapi/host/scan
• Request Fields
  • host : The host to scan (Required)
• Response
  • XML as received from URLVoid API Service (see URLVoid API documentation)

Stats Remained

Retrieves and displays the number of queries that remain for the account associated with the URLVoid API key.

• DXL Request Topic
  • /opendxl-urlvoid/service/urlvapi/stats/remained
• Request Fields
  • (None)
• Response
  • XML as received from URLVoid API Service (see URLVoid API documentation)