Skip to main content
GET
Check IP Whitelist
Call this from the server that uses your API key. It never blocks the request, so you can run it any time, including right after changing a key’s allowed IPs.
  • key_usage.allowed_server is true when the calling server can use the key.
  • key_usage.request_ip is the IP to whitelist if it isn’t the one you expected.
  • Add ?ip=<address> to test a server you haven’t deployed yet.
To add or change IPs, use Developers → API Keys in the dashboard. See IP whitelisting.

Authorizations

X-Api-Key
string
header
required

Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.

X-Api-Secret
string
header
required

Your API secret (yativo_sk_...), shown once when the key is created.

Query Parameters

ip
string

Check this IP against your whitelist instead of the detected one. key_usage still describes the calling server.

Example:

"198.51.100.7"

Response

Check result

status
string
Example:

"success"

status_code
integer
Example:

200

message
string
data
object