Add To Whitelist API
Add IP addresses to the whitelist for guaranteed access to VPN services
Add To Whitelist API
Add IP addresses to the system whitelist for guaranteed access. Whitelisted IPs bypass certain security restrictions and rate limits.
Guaranteed Access
Whitelisted IPs always allowed.
Bypass Limits
Skip rate limiting and restrictions.
Trusted IPs
Mark trusted sources explicitly.
Endpoint Overview
/graphqlAdd an IP address or IP range to the system whitelist. Whitelisted addresses receive guaranteed access and bypass certain security restrictions.
Request Parameters
ipString!RequiredThe IP address or CIDR range to whitelist (e.g., "192.168.1.1" or "192.168.1.0/24").
descriptionStringDescription or reason for whitelisting.
expiresAtDateTimeOptional expiration date for the whitelist entry.
GraphQL Mutation
mutation addToWhitelist($ip: String!, $description: String) {
addToWhitelist(ip: $ip, description: $description) {
id
ip
description
createdAt
expiresAt
}
}Variables:
{
"ip": "203.0.113.50",
"description": "Corporate office VPN gateway"
}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ADMIN_TOKEN" \
-d '{
"query": "mutation addToWhitelist($ip: String!, $description: String) { addToWhitelist(ip: $ip, description: $description) { id ip description } }",
"variables": {
"ip": "203.0.113.50",
"description": "Corporate office"
}
}'Response
{
"data": {
"addToWhitelist": {
"id": "wl_123",
"ip": "203.0.113.50",
"description": "Corporate office VPN gateway",
"createdAt": "2024-01-15T10:30:00Z",
"expiresAt": null
}
}
}{
"errors": [
{
"message": "Invalid IP address format",
"path": ["addToWhitelist"],
"extensions": {
"code": "INVALID_IP"
}
}
],
"data": null
}Use Cases
Corporate Networks
Whitelist office IP ranges for guaranteed access.
Partner Systems
Allow trusted partner integration servers.
API Integrations
Whitelist external API consumer IPs.
Testing Servers
Allow QA and testing infrastructure.
Best Practices
Document Purpose
Always add descriptions for audit trails.
Use CIDR Wisely
Whitelist specific IPs when possible.
Set Expiration
Use expiration for temporary access.
Regular Review
Periodically audit whitelist entries.
Related Endpoints
Security Consideration
Whitelisted IPs bypass security restrictions. Only whitelist trusted, verified IP addresses to maintain system security.
View Current Whitelist
Check existing whitelist entries before adding new IPs to avoid duplicates.