Sign inGet Started

bird email seeding address rotate

Usage

Code example
bird email seeding address rotate [flags]

Description

Rotate the automatic seeding address

Requires initialized settings. Invalidates the previous trigger and permanently stops existing runs' ungranted copies; granted copies may still send. Returns the workspace trigger_address. A successful idempotent replay returns its saved snapshot, which can be older than bird email seeding settings get.

Build the request from flags, a JSON AutomaticSeedingRotate 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.

Browser confirmation: the review link goes to stderr, not stdout, as next[].url in a JSON line that also carries confirmation_id. The command then waits and prints the result on stdout; --confirmation-id waits on an existing one.

This is destructive and cannot be undone; pass --yes to confirm.

Procedure

Step 2 of 3 of "Rotate the Automatic Email Seeding trigger". Previous: bird email seeding settings get. Next: bird email seeding settings get.

Examples

Code example
# print the body shape (no credentials needed)
bird email seeding address rotate --example

# the body it prints:
Code example
{
  "expected_revision": 1
}

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

Safety

NameDescription
--yesConfirm the action (required; the CLI never prompts)

Options

NameDescription
--expected-revision <n>Revision from the latest settings read after initial setup. Revision zero from an unconfigured workspace cannot be used to rotate an address. (required; or in --body-file)
--response-schemaPrint the fields this command returns, then exit
--confirmation-idWait for an existing confirmation of this exact request

Continue with the documentation, guides and examples for this topic.