Update Whitelisted IP Description

Updates the description of an existing whitelisted IP.

Update the description or label associated with a whitelisted IP address.

Request

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

Request Body Parameters

FieldTypeRequiredDescription
ipstringYesThe IP address to update
descriptionstringYesThe new description for the whitelisted IP

Example Request Body

{
  "ip": "161.142.148.150",
  "description": "updated-description"
}

Response

200 Success

The IP description has been successfully updated.

Response Fields

FieldTypeDescription
dataarrayA list of updated whitelisted IPs
data[].ipstringThe IP address that was updated
data[].descriptionstringThe updated description for the whitelisted IP
data[]._idstringA unique identifier assigned to the whitelisted IP
messageobjectProvides status details about the update operation
message.titlestringA short message indicating the status of the update
message.bodystringA detailed message about the update operation
message.variantstringThe status variant indicating success or failure

Example Response

{
  "data": [
    {
      "ip": "161.142.148.150",
      "description": "just update",
      "_id": "67a0a5bbb412ddaf6f139b3b"
    }
  ],
  "message": {
    "title": "Updated",
    "body": "Whitelisted IPs updated.",
    "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