AccountIPWhitelist

IP whitelist management

Get all whitelist IP ranges

get
Authorizations
PRIVATE-TOKENstringRequired
Header parameters
RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses
get
/v3/account/whitelist

Add IP range to the whitelist

post
Authorizations
PRIVATE-TOKENstringRequired
Body
idinteger · integerRead-onlyRequired

IP whitelist ID

ipStartstring · nullableOptional

First IP in range

ipEndstring · nullableOptional

Last IP in range

ipRangestring · nullableOptional

IP range with network suffix such as /24, /32, etc.

descriptionstringOptional

Description of whitelisted IP or range

activeinteger · integerRequired

Whether or not this whitelist entry is active

createdAtinteger · integerRead-onlyRequired

Unix timestamp of when the IP whitelisting was created

Responses
post
/v3/account/whitelist

Update whitelisted IP range

put
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
whitelistIdintegerRequired

Whitelisted IP range ID

Body
idinteger · integerRead-onlyRequired

IP whitelist ID

ipStartstring · nullableOptional

First IP in range

ipEndstring · nullableOptional

Last IP in range

ipRangestring · nullableOptional

IP range with network suffix such as /24, /32, etc.

descriptionstringOptional

Description of whitelisted IP or range

activeinteger · integerRequired

Whether or not this whitelist entry is active

createdAtinteger · integerRead-onlyRequired

Unix timestamp of when the IP whitelisting was created

Responses
put
/v3/account/whitelist/{whitelistId}

Delete whitelisted IP range

delete
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
whitelistIdintegerRequired

Whitelisted IP range ID

Responses
chevron-right
204

No Content

No content

delete
/v3/account/whitelist/{whitelistId}

No content

Check user whitelist

post
Authorizations
PRIVATE-TOKENstringRequired
Responses
chevron-right
204

No Content

No content

post
/v3/account/whitelist/check

No content

Last updated

Was this helpful?