Sign inGet Started

bird esim update

Usage

Contoh kode
bird esim update <esim-id> [flags]

Description

Update an eSIM

Updates the eSIM's display name, tags, or metadata. Lifecycle and connectivity are managed through the dedicated endpoints.

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

Contoh kode
# print the body shape (no credentials needed)
bird esim update --example

# the body it prints:
Contoh kode
{
  "tags": [
    {
      "name": "category",
      "value": "welcome"
    }
  ]
}

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
--display-nameFree-text label for your own reference. Null clears it.
--tags <key=value>Replaces the eSIM's tags.
--metadataReplaces the eSIM's metadata. Maximum 2 KB serialized.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird esim compatible-offersList offers an eSIM can take
bird esim getGet an eSIM
bird esim listList eSIMs
bird esim releaseRelease an eSIM
bird esim resumeResume an eSIM
bird esim suspendSuspend an eSIM