GET

/#Action=AllocateIpamPoolCidr

http://ec2.{region}.amazonaws.com/#Action=AllocateIpamPoolCidr

Allocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/allocate-cidrs-ipam.html">Allocate CIDRs</a> in the Amazon VPC IPAM User Guide. <note> This action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool. </note>

Access Token Required: API Key

Query Params

DryRunboolean

A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.

IpamPoolIdstringrequired

The ID of the IPAM pool from which you would like to allocate a CIDR.

Cidrstring

The CIDR you would like to allocate from the IPAM pool. Note the following: <ul> <li> If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR. </li> <li> If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored. </li> </ul> Possible values: Any available IPv4 or IPv6 CIDR.

NetmaskLengthinteger

The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following: <ul> <li> If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR. </li> <li> If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored. </li> </ul> Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

ClientTokenstring

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring Idempotency</a>.

Descriptionstring

A description for the allocation.

PreviewNextCidrboolean

A preview of the next available CIDR in a pool.

DisallowedCidrarray

Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://ec2.{region}.amazonaws.com/#Action=AllocateIpamPoolCidr' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}