Update an IP allow-list entry

Settings module

PATCH/org-ip-allowlist/{id}orgIpAllowlistEntries.update

An allowed network for Atlas and the API. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Requires the capability org.security.write.
OAuth scopes: org.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

orgIpAllowlistEntries.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the org ip allowlist entry.

Request body: OrgIpAllowlistEntryUpdate

orgIpAllowlistEntries.update: OrgIpAllowlistEntryUpdate
Field	Type	Required	Description
label	string	No	Label.Constraints: length 1 to 300

{
  "label": "Office"
}

Response 200: OrgIpAllowlistEntry

orgIpAllowlistEntries.update: OrgIpAllowlistEntry
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the org ip allowlist entry.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
cidr	string	Yes	CIDR block.Constraints: length 1 to 300
label	string	Yes	Label.Constraints: length 1 to 300

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "cidr": "203.0.113.0/24",
  "label": "Office"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/org-ip-allowlist/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"label":"Office"}'

const { data, etag } = await xos.orgIpAllowlistEntries.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "label": "Office"
  }, { ifMatch: etag });

response = xos.org_ip_allowlist_entries.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"label": "Office"}, if_match=etag)

xos org-ip-allowlist-entries update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"label":"Office"}' --if-match auto