Add Whitelisted IPs

Adds up to 10 IP addresses per request.

Limit

You can add up to 10 IP addresses per request.

Add IP addresses to your whitelist to allow them to access your Geonode proxy services without authentication.

Request

curl -X POST "https://app-api.geonode.com/api/configuration/active/whitelisted-ips" \
     -H "Authorization: Basic base64(username:password)" \
     -H "Content-Type: application/json" \
     -d '{"ips": [{"ip": "161.142.148.140", "description": "mac-m1"}]}'

Request Body Parameters

FieldTypeRequiredDescription
ipsarrayYesList of IP objects to add to the whitelist
ips[].ipstringYesThe IP address being added to the whitelist
ips[].descriptionstringNoA user-defined label or identifier for the IP

Example Request Body

{
  "ips": [
    {
      "ip": "161.142.148.140",
      "description": "mac-m1"
    }
  ]
}

Response

200 Success

The IP addresses have been successfully added to your whitelist.

Response Fields

FieldTypeDescription
dataarrayA list of successfully whitelisted IP addresses
data[].ipstringThe IP address that was whitelisted
data[].descriptionstringA user-defined label or identifier for the IP
data[]._idstringA unique identifier assigned to the whitelisted IP
messageobjectDetails about the status of the whitelist update
message.titlestringA short title summarizing the update status
message.bodystringA message detailing the outcome of the operation
message.variantstringThe status variant indicating success or failure

Example Response

{
  "data": [
    {
      "ip": "161.142.148.150",
      "description": "updated-description",
      "_id": "67a0a5bbb412ddaf6f139b3b"
    }
  ],
  "message": {
    "title": "Updated",
    "body": "Whitelisted IPs saved.",
    "variant": "success"
  }
}

Error Responses

400 Bad Request

Invalid input data provided.

FieldTypeDescription
errorstringError message
{
  "error": "Invalid input data."
}

401 Unauthorized

Invalid API credentials provided.

FieldTypeDescription
errorstringError message
{
  "error": "Unauthorized - Invalid API key or credentials."
}

On this page