Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
count
number
required

Count

Required range: 1 <= x <= 1000
version
enum<string>

IP Version

Available options:
ipv4,
ipv6
rangeV4
enum<string>

Range Type

Available options:
any,
public,
private,
loopback,
cgnat,
linklocal,
multicast,
documentation
rangeV6
enum<string>

Range Type

Available options:
global,
ula,
linklocal,
multicast,
loopback,
documentation
withCidr
boolean

Append CIDR suffix (host /32 or /128)

unique
boolean

Unique addresses (no duplicates)

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.