Docs Network

IP Range Scan

Scan a range of IP addresses for an open port.

GET /v1/ip-range-scan iprange.run

Scans every address between startIp and endIp for an open port (default port set per target if omitted).

Authentication

This endpoint requires a valid API key sent as a Bearer token, and the key must carry the scope listed above. See Authentication and Scopes for details.

Query Parameters

Name Type Required Description
startIp string Required First IP address in the range.
endIp string Required Last IP address in the range.
port int Optional Port to test on each address.

Headers

Header Required Description
Authorization Required Bearer token — Bearer pk_live_...

Request Example

Response Example

200 OK
{
  "success": true,
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "summary": "2 of 10 hosts responded",
    "durationMs": 1840,
    "results": [
      { "ip": "93.184.216.4", "isOpen": true }
    ]
  }
}

Error Responses

Status Code Meaning
401 API_KEY_INVALID The API key is missing, malformed, or doesn't match any active key.
401 API_KEY_REVOKED The API key was manually revoked and can never be reactivated.
401 API_KEY_EXPIRED The API key's expiration date has passed.
403 PLAN_EXPIRED Your Enterprise subscription is no longer active.
403 ENTERPRISE_REQUIRED The Public API is only available on the Enterprise plan.
403 SCOPE_REQUIRED The API key doesn't have the scope required for this endpoint.
429 RATE_LIMIT_EXCEEDED The API key has exceeded its request limit for the current window.
422 VALIDATION_ERROR One or more request parameters failed validation.
500 INTERNAL_ERROR An unexpected error occurred on Paqet's side.

Rate Limits

This endpoint counts against your API key's standard request limit. See Rate Limits for current limits, response headers, and retry guidance.

Notes

  • Large ranges take proportionally longer and count once against your rate limit, not once per address.

Try this endpoint

Run it live from the Playground using your own API key.

Open Playground