APIKeyIPWhitelist

API key IP whitelist management

Get all whitelist IP ranges

get
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
apiKeyIdintegerRequired

ID of API key

Header parameters
RANGED-DATAstringOptional

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

Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

Whitelist ID

ipStartstring · nullableOptional

Start IP of API key IP whitelist range

ipEndstring · nullableOptional

End IP of API key IP whitelist range

ipRangestring · nullableOptional

CIDR IP range of API key whitelist

commentsstring · nullableOptional

IP whitelist range comments

activeinteger · integerRequired

Whether or not this IP whitelist range is active

updatedAtinteger · integerRead-onlyRequired

Last time this IP whitelist range was updated

get
/v3/account/apiKey/{apiKeyId}/whitelist

Add IP range to the whitelist

post
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
apiKeyIdintegerRequired

ID of API key

Body
idinteger · integerRead-onlyRequired

Whitelist ID

ipStartstring · nullableOptional

Start IP of API key IP whitelist range

ipEndstring · nullableOptional

End IP of API key IP whitelist range

ipRangestring · nullableOptional

CIDR IP range of API key whitelist

commentsstring · nullableOptional

IP whitelist range comments

activeinteger · integerRequired

Whether or not this IP whitelist range is active

updatedAtinteger · integerRead-onlyRequired

Last time this IP whitelist range was updated

Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

Whitelist ID

ipStartstring · nullableOptional

Start IP of API key IP whitelist range

ipEndstring · nullableOptional

End IP of API key IP whitelist range

ipRangestring · nullableOptional

CIDR IP range of API key whitelist

commentsstring · nullableOptional

IP whitelist range comments

activeinteger · integerRequired

Whether or not this IP whitelist range is active

updatedAtinteger · integerRead-onlyRequired

Last time this IP whitelist range was updated

post
/v3/account/apiKey/{apiKeyId}/whitelist

Update whitelisted IP range

put
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
apiKeyIdintegerRequired

ID of API key

apiKeyWhitelistIdintegerRequired

Whitelisted IP range ID

Body
idinteger · integerRead-onlyRequired

Whitelist ID

ipStartstring · nullableOptional

Start IP of API key IP whitelist range

ipEndstring · nullableOptional

End IP of API key IP whitelist range

ipRangestring · nullableOptional

CIDR IP range of API key whitelist

commentsstring · nullableOptional

IP whitelist range comments

activeinteger · integerRequired

Whether or not this IP whitelist range is active

updatedAtinteger · integerRead-onlyRequired

Last time this IP whitelist range was updated

Responses
chevron-right
200

OK

application/json
idinteger · integerRead-onlyRequired

Whitelist ID

ipStartstring · nullableOptional

Start IP of API key IP whitelist range

ipEndstring · nullableOptional

End IP of API key IP whitelist range

ipRangestring · nullableOptional

CIDR IP range of API key whitelist

commentsstring · nullableOptional

IP whitelist range comments

activeinteger · integerRequired

Whether or not this IP whitelist range is active

updatedAtinteger · integerRead-onlyRequired

Last time this IP whitelist range was updated

put
/v3/account/apiKey/{apiKeyId}/whitelist/{apiKeyWhitelistId}

Delete whitelisted IP range

delete
Authorizations
PRIVATE-TOKENstringRequired
Path parameters
apiKeyIdintegerRequired

ID of API key

apiKeyWhitelistIdintegerRequired

Whitelisted IP range ID

Responses
delete
/v3/account/apiKey/{apiKeyId}/whitelist/{apiKeyWhitelistId}

No content

Last updated

Was this helpful?