Sign inGet Started

bird email ip-pools create

Usage

Codebeispiel
bird email ip-pools create <name> [flags]

Description

Create an IP pool

Create an IP pool that belongs to the organization. The pool is available immediately. Pass workspace_id to also assign it to that workspace without changing the workspace's default.

Build the request from the <name> argument and flags, a JSON IPPoolCreate body via --body-file ("-" reads stdin), or both — an inline value 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

Codebeispiel
# print the body shape (no credentials needed)
bird email ip-pools create --example

# the body it prints:
Codebeispiel
{
  "name": "Transactional"
}

Options

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--workspace-idA workspace to assign the new pool to, in the same request. The pool does not become the workspace's default, so its current sending does not change. Where workspaces can still send through every organization pool, the pool is created without an assignment. Returns IPPoolAssignmentsNotAvailable (E11012) while workspace assignments can be read but not changed.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird email ip-pools deleteDelete an IP pool
bird email ip-pools getGet an IP pool
bird email ip-pools listList IP pools
bird email ip-pools updateUpdate an IP pool