Sign in
API Keys

Set API Key IP Whitelist

Set or update IP whitelist for an API key.

post/v1/api_keys/{apiKeyID}/ip_whitelist

Path parameters

apiKeyIDstring required

Request body

ipstring required

IP address to whitelist

Example request

{
  "ip": "192.168.1.1"
}

Response

Updated

successboolean required

Whether the request was successful

errorstring

Error message, present only on failure

error_codestring

Semantic error code. See each endpoint's error responses for the specific codes it can return.

deprecatedstring

Deprecation notice, if applicable

Example response

{
  "success": true
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.