> ## Documentation Index
> Fetch the complete documentation index at: https://datum-4926dda5-docs-api-reference-demo.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# IPAllocation

> IPAllocation records a CIDR carved out of an IPPool by an IPClaim.

<Note>
  API resource reference for **IPAllocation**, part of the [IPAM service](/api/ipam/overview). To create or change one, see [Changing resources](/datumctl/resources/changing); to inspect, see [Reading resources](/datumctl/resources/reading).
</Note>

<Warning>
  This resource is part of the `v1alpha1` API and is subject to change. Fields and behavior may change in future releases.
</Warning>

## Identity

|         |                     |
| ------- | ------------------- |
| Group   | `ipam.miloapis.com` |
| Version | `v1alpha1`          |
| Kind    | `IPAllocation`      |
| Scope   | Project             |

## Overview

An `IPAllocation` records a specific CIDR block that has been carved out of an IPPool to satisfy an IPClaim. It ties a requested IP family to a source pool and, once satisfied, reports the exact CIDR that was allocated. Use it within a Project to track and inspect the address ranges handed out from your IP pools.

## Spec fields

| Field               | Type   | Required | Description                                                                 |
| ------------------- | ------ | -------- | --------------------------------------------------------------------------- |
| `spec.ipFamily`     | string | Yes      | The IP family requested for the allocation (for example, `IPv4` or `IPv6`). |
| `spec.poolRef`      | Object | Yes      | References the IPPool the CIDR is allocated from.                           |
| `spec.poolRef.name` | string | Yes      | Name of the referenced IPPool in the same Project.                          |

## Status fields (read-only)

| Field                  | Type      | Description                                                 |
| ---------------------- | --------- | ----------------------------------------------------------- |
| `status.allocatedCIDR` | string    | The CIDR block that was allocated from the referenced pool. |
| `status.conditions`    | \[]Object | Tracks the state and readiness of the allocation.           |
| `status.phase`         | string    | The current lifecycle phase of the allocation.              |

## Usage

```yaml theme={null}
apiVersion: ipam.miloapis.com/v1alpha1
kind: IPAllocation
metadata:
  name: web-tier-allocation
spec:
  ipFamily: IPv4
  poolRef:
    name: web-tier-pool
```

```bash theme={null}
datumctl apply -f ipallocation.yaml --project my-project
datumctl get ipallocations --project my-project
datumctl describe ipallocation web-tier-allocation --project my-project
```

<Tip>
  Run `datumctl explain ipallocations --recursive` to see the full, live field tree for this resource.
</Tip>