Remove From Whitelist API

Remove IP addresses from the whitelist to revoke special access privileges

IP Management

Remove From Whitelist API

Remove IP addresses from the system whitelist. Revoke special access privileges and restore standard security checks.

Revoke Access

Remove special IP privileges.

Restore Checks

Resume normal security validation.

Clean Up

Remove outdated whitelist entries.


Endpoint Overview

MUTATION/graphql

Remove an IP address from the system whitelist. The IP will no longer receive special access privileges and will be subject to normal security checks.

Authentication:Bearer Token
Required scopes:admin

Request Parameters

ipString!Required

The IP address or CIDR range to remove from the whitelist.


GraphQL Mutation

mutation removeFromWhitelist($ip: String!) {
  removeFromWhitelist(ip: $ip)
}

Variables:

{
  "ip": "203.0.113.50"
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ADMIN_TOKEN" \
  -d '{
    "query": "mutation removeFromWhitelist($ip: String!) { removeFromWhitelist(ip: $ip) }",
    "variables": {
      "ip": "203.0.113.50"
    }
  }'

Response

200IP Removed Successfully
{
  "data": {
    "removeFromWhitelist": true
  }
}
400IP Not Found
{
  "errors": [
    {
      "message": "IP not found in whitelist",
      "path": ["removeFromWhitelist"],
      "extensions": {
        "code": "NOT_FOUND"
      }
    }
  ],
  "data": null
}

When to Remove

Contract End

Remove when partner relationship ends.

IP Change

Remove old IPs when addresses change.

Security Concern

Remove if IP is compromised.

Cleanup

Remove expired or unused entries.



Immediate Effect

Removal takes effect immediately. The IP will be subject to normal security checks on the next request.

View Whitelist

Review current whitelist entries to identify IPs for removal.

Get Whitelisted IPs