Skip to main content
POST

Query Parameters

key
string

Your Pulsedive API key.

API key authentication is optional. However, requests without a key have stricter rate limits. We recommend including an API key for better performance and reliability.

value
string

Value of the indicator to scan. May be:

  • a domain name (e.g., microsoft.com)
  • an IP address (e.g., 8.8.8.8)
  • a URL (e.g., https://pulsedive.com/explore)

To use a base64-encoded indicator, use the ioc parameter instead.

ioc
string

Base64-encoded value of the indicator to scan.

Useful for safely transmitting indicators that contain special characters or when the indicator is not being processed correctly through the indicator parameter. (If this is happening, please let us know.)

Use this parameter instead of indicator when submitting base64-encoded data.

probe
enum<integer>
default:0

Scan type for the indicator.

Passive scans collect data without direct contact, such as through WHOIS and DNS requests. Active scans include port scanning and web browser analysis, which are more detectable.

For active scanning, set to 1. For passive scanning, set to 0.

Available options:
0,
1
submit
enum<integer>
default:0

Controls whether to save the scanned indicator to Pulsedive's database.

To store the indicator and make it searchable in future queries, set to 1. To scan and enrich without storing, set to 0.

If you scan an indicator that already exists in the database, Pulsedive updates it with fresh scan results regardless of this parameter's value.

Available options:
0,
1
pretty
enum<integer>
default:0

Indicates whether to format returned JSON results.

For pretty-printed output, set to 1. For compact output, set to 0.

Available options:
0,
1

Response

Successful request. Returns scan queue information in JSON format.

qid
integer

Unique identifier of the scan request (Queue ID).

Example:

"2100254203"

{key}
string

Dynamic key-value pair representing the outcome of your request.

Each {key} represents the overall outcome of your request. The {value} string provides additional context for the outcome. Until your request is complete, the {key} will be error.

Example: