bird email ip-pools list

Usage

Code example

bird email ip-pools list [flags]

List the IP pools available to the workspace as a cursor page. Pools group dedicated IPs for sending and belong to the organization. Read-only view.

Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Code example

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

Name	Description
--ending-before	Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
--include-total	When 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.
--order	Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field. Possible values: asc, desc.
--sort	Sort by created_at or name. Defaults to created_at. Possible values: created_at, name.
--starting-after	Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

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

Continue with the documentation, guides and examples for this topic. Resources are in English.