Get Whitelisted IPs API

Retrieve the list of IP addresses that have been explicitly allowed access to the VPN service

Security

Get Whitelisted IPs API

Access the complete list of IP addresses that have been whitelisted for guaranteed VPN access. Manage your approved IP list for secure operations.

Allowed IPs

All approved addresses.

Trusted Access

Guaranteed connections.

Access List

View all entries.


Endpoint Overview

QUERY/graphql

Retrieve all IP addresses that have been added to the whitelist and are guaranteed access to VPN services.

Authentication:Bearer Token
Required scopes:admin

GraphQL Query

query getWhitelistedIPs {
  getWhitelistedIPs {
    id
    ipAddress
    description
    createdAt
    createdBy
  }
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "query": "query getWhitelistedIPs { getWhitelistedIPs { id ipAddress description createdAt } }"
  }'

Response

200Whitelist Retrieved Successfully
{
  "data": {
    "getWhitelistedIPs": [
      {
        "id": "1",
        "ipAddress": "203.0.113.50",
        "description": "Corporate headquarters",
        "createdAt": "2024-01-10T09:00:00Z",
        "createdBy": "admin"
      },
      {
        "id": "2",
        "ipAddress": "198.51.100.25",
        "description": "Remote office - NYC",
        "createdAt": "2024-01-08T14:30:00Z",
        "createdBy": "admin"
      },
      {
        "id": "3",
        "ipAddress": "192.0.2.100",
        "description": "Testing server",
        "createdAt": "2024-01-05T11:15:00Z",
        "createdBy": "admin"
      }
    ]
  }
}
200Empty Whitelist
{
  "data": {
    "getWhitelistedIPs": []
  }
}

Response Fields

idID!

Unique identifier for the whitelist entry.

ipAddressString!

The approved IP address.

descriptionString

Description or label for this IP entry.

createdAtDateTime

When the IP was whitelisted.

createdByString

Admin who added the entry.


Use Cases

Corporate Networks

Allow office IP ranges.

VIP Access

Guarantee critical connections.

Testing

Allow development IPs.

Partner Access

Trusted third-party IPs.



Whitelist Priority

Whitelisted IPs take priority over other access controls. If an IP is on both the whitelist and blacklist, the whitelist entry takes precedence.

Add Trusted IP

Add IP addresses to the whitelist for guaranteed access.

Add to Whitelist