bird email dedicated-ips create

Usage

Code example

bird email dedicated-ips create [flags]

Purchase one or more dedicated IPs into an IP pool. Set quantity to the number of IPs; ip_pool_id is required once the organization has pools, and is created automatically on the first purchase. This is a paid, org-level action. Returns the purchase result, or a top-up-required result when the wallet balance is insufficient.

Build the request from flags, a JSON DedicatedIPCreate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Code example

# print the body shape (no credentials needed)
bird email dedicated-ips create --example

# the body it prints:

Code example

{
  "ip_pool_id": "ipp_01krdgeqcxet5s7t44vh8rt9mg",
  "quantity": 2
}

Options

Purchase

Name	Description
--quantity <n>	Number of IPs to provision. Defaults to 1 when omitted.
--ip-pool-id	The pool to provision the new IPs into. Required when the organization already has IP pools; omit it on the first purchase to create one automatically.

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--response-schema	Print the fields this command returns, then exit

Name	Description
bird email dedicated-ips assign	Move a dedicated IP to a pool
bird email dedicated-ips delete	Cancel a dedicated IP
bird email dedicated-ips get	Get a dedicated IP
bird email dedicated-ips list	List dedicated IPs