Get an IP allow-list entry
Módulo Settings
GET/org-ip-allowlist/{id}orgIpAllowlistEntries.get
An allowed network for Atlas and the API. Returns one IP allow-list entry with its `ETag`. A IP allow-list entry the caller may not see returns 404.
- Requiere la capacidad org.settings.read.
- Alcances de OAuth: org.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the org ip allowlist entry. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: OrgIpAllowlistEntry
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the org ip allowlist entry. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| cidr | string | Sí | CIDR block.Restricciones: length 1 to 300 |
| label | string | Sí | Label.Restricciones: 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"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/org-ip-allowlist/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.orgIpAllowlistEntries.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.org_ip_allowlist_entries.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos org-ip-allowlist-entries get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f