Static IP Validation¶
REST API V3
Use this endpoint to verify whether the current outbound IP matches the static IPs registered for the account.
The Python SDK performs this validation automatically. REST API users can verify static IP access using this API after authentication.
Endpoint¶
Method: GET
Endpoint: /ipaddress/validate
Base URLs¶
| Environment | Base URL |
|---|---|
| PROD | https://api.nubra.io |
| UAT | https://uatapi.nubra.io |
Headers¶
| Header | Required | Value |
|---|---|---|
Authorization |
yes | Bearer <session_token> |
x-device-id |
yes | <device_id> |
Accept |
recommended | application/json |
cURL¶
curl --location 'https://api.nubra.io/ipaddress/validate' \
--header 'Authorization: Bearer <session_token>' \
--header 'x-device-id: <device_id>' \
--header 'Accept: application/json'
Response¶
{
"current_ip_address": "203.0.113.10",
"primary_ip_address": "203.0.113.20",
"secondary_ip_address": "203.0.113.30",
"is_matched": false
}
Response Fields¶
| Field | Type | Description |
|---|---|---|
current_ip_address |
string | Current outbound IP detected by Nubra. |
primary_ip_address |
string | Primary static IP registered for the account. |
secondary_ip_address |
string | Secondary static IP registered for the account. |
is_matched |
boolean | true when the current IP matches either registered static IP; otherwise false. |
Usage Notes¶
- Call this API after completing authentication and receiving the
session_token. is_matched: truemeans the current outbound IP is valid for static IP access.is_matched: falsemeans the current outbound IP does not match the registered primary or secondary static IP.- If no static IPs are registered for the user, the API can return an error response instead of the match result.
Error Example¶
{
"error": "No IP addresses registered for user",
"nubra_error_code": ""
}