Skip to content

Create an IP allow-list entry

Settings module

POST/org-ip-allowlistorgIpAllowlistEntries.create

An allowed network for Atlas and the API. Creates an IP allow-list entry. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability org.security.write.
  • OAuth scopes: org.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: OrgIpAllowlistEntryCreate

orgIpAllowlistEntries.create: OrgIpAllowlistEntryCreate
FieldTypeRequiredDescription
cidrstringYesCIDR block.Constraints: length 1 to 300
labelstringYesLabel.Constraints: length 1 to 300
{
  "cidr": "203.0.113.0/24",
  "label": "Office"
}

Response 201: OrgIpAllowlistEntry

orgIpAllowlistEntries.create: OrgIpAllowlistEntry
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the org ip allowlist entry.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
cidrstringYesCIDR block.Constraints: length 1 to 300
labelstringYesLabel.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 POST "$XOS_BASE_URL/org-ip-allowlist" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"cidr":"203.0.113.0/24","label":"Office"}'
const { data } = await xos.orgIpAllowlistEntries.create({
    "cidr": "203.0.113.0/24",
    "label": "Office"
  });
response = xos.org_ip_allowlist_entries.create({"cidr": "203.0.113.0/24", "label": "Office"})
xos org-ip-allowlist-entries create --data '{"cidr":"203.0.113.0/24","label":"Office"}'