Documentation
Sign inGet started

bird email ip-pools list

Usage

代码示例
bird email ip-pools list [flags]

Description

List the IP pools available to the workspace as a cursor page. Pools group dedicated IPs for sending; the result is shared across the organization. Read-only view.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

代码示例
bird email ip-pools list
bird email ip-pools list | jq -r '.data[].id'
bird email ip-pools list --limit 50 --starting-after <cursor>

Options

Pagination

NameDescription
--ending-beforeCursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
--include-totalWhen true, the response includes a total field with the total number of items matching the request's filters across all pages.
--limit <n>Maximum number of items to return per page.
--orderSort direction. Defaults to desc (newest/largest first).
--sortField to sort by.
--starting-afterCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

Filters

NameDescription
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird email ip-pools createCreate an IP pool
bird email ip-pools deleteDelete an IP pool
bird email ip-pools getGet an IP pool
bird email ip-pools updateUpdate an IP pool