Skip to content
Shortcut: /, ⌘K or Ctrl+K

polymorfa operation

Polymorfa CLI · CLI API requests

View as Markdown

polymorfa operation cancel

Request cancellation of a running campaign or production-enrollment operation. The operation moves to cancelling; follow it with operation wait.

Usage

polymorfa operation cancel OPERATION [flags]

Arguments

  • OPERATIONrequired

    Operation ID.

Flags

  • --idempotency-key <value>takes a value

    Use this key to identify retries; one is generated when omitted.

  • --yesboolean

    Confirm the external effect without prompting.

Also accepts the global flags.

polymorfa operation list

List asynchronous operations, newest first. Team owners see team and project operations; project owners see one project.

Usage

polymorfa operation list [flags]

Examples

polymorfa operation list --status running
polymorfa operation list --resource-type campaign --resource-id <campaign-id> --json

Flags

  • --cursor <value>takes a value

    Continue from this opaque cursor.

  • --kind <value>takes a value

    Filter by operation kind, for example campaign.

  • --limit <value>takes a value

    Request this many resources per page.

    Default 25
  • --max-items <value>takes a value

    Stop automatic pagination after this many resources.

  • --paginateboolean

    Request consecutive pages until --max-items resources are collected or no pages remain. Requires --max-items.

  • --resource-id <value>takes a value

    Filter by resource ID. Requires --resource-type.

  • --resource-type <value>takes a value

    Filter by resource type. Requires --resource-id.

  • --since <value>takes a value

    Include operations created at or after this RFC 3339 time.

  • --status <value>takes a value

    Filter by status.

    Allowed valuespendingrunningaction_requiredcancellingsucceededfailedcancelled
  • --until <value>takes a value

    Include operations created before this RFC 3339 time.

Also accepts the global flags.

polymorfa operation view

View one asynchronous operation: status, sequence, progress, error, and whether it can be cancelled.

Usage

polymorfa operation view OPERATION [flags]

Arguments

  • OPERATIONrequired

    Operation ID.

Flags

Also accepts the global flags.

polymorfa operation wait

Wait until an operation succeeds, fails, or is cancelled. Exits 0 on success, 1 on failure or cancellation, and 8 when --timeout ends first.

Usage

polymorfa operation wait OPERATION [flags]

Example

polymorfa operation wait <operation-id> --timeout 600

Arguments

  • OPERATIONrequired

    Operation ID.

Flags

  • --timeout <value>takes a value

    Stop waiting after this many seconds.

    Default 300

Also accepts the global flags.

polymorfa operation watch

Print each status change of an operation until it succeeds, fails, or is cancelled. With --json, prints one JSON document per change. Exits like operation wait.

Usage

polymorfa operation watch OPERATION [flags]

Arguments

  • OPERATIONrequired

    Operation ID.

Flags

  • --timeout <value>takes a value

    Stop waiting after this many seconds.

    Default 300

Also accepts the global flags.