uip aops pipelines

Syntax and options for `uip aops pipeline` and `uip aops execution`, which manage CICD pipelines and inspect or control their runs.

uip aops pipeline manages CI/CD pipelines — list, fetch, create, update, run, delete. uip aops execution inspects and controls one pipeline run — fetch metadata, stream logs, fetch job details, or stop it. Both call the CICD service, a separate identifier namespace from the SourceControl commands on the connections/projects pages. See the uip aops overview for shared concepts.

Observação:

pipeline update <id> --file is full-replace (HTTP PUT semantics) and expects the EditPipelineDto shape, not the PipelineDto that pipeline get returns by default. Don't pipe pipeline get <id> > p.json straight into update --file p.json — use pipeline get <id> --for-update --output-file <path> instead, which writes the already-transformed shape.

Resumo

uip aops pipeline list [--repository-ids <csv>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops pipeline state
uip aops pipeline processes
uip aops pipeline process <process-id>
uip aops pipeline repos
uip aops pipeline get <pipeline-id> [--for-update] [--output-file <path>]
uip aops pipeline search [--name <name> | --prefix <prefix>]
uip aops pipeline create --file <path> [--telemetry-flow-id <id>]
uip aops pipeline update <pipeline-id> --file <path>
uip aops pipeline delete <pipeline-id> -y
uip aops pipeline run <pipeline-id>
uip aops pipeline save-and-run --file <path> [--telemetry-flow-id <id>]
uip aops pipeline executions <pipeline-id> [--offset <n>] [--limit <n>]
uip aops pipeline executions-bulk --ids <csv>

uip aops execution get <execution-id> [--with-arguments]
uip aops execution logs [execution-id] [--job-key <key>] [--follow] [--limit <n>] [--poll-interval <ms>] [--timeout <ms>]
uip aops execution details [execution-id] [--job-key <key>]
uip aops execution stop [execution-id] [--job-key <key>] [--wait] [--poll-interval <ms>] [--timeout <ms>]

uip aops pipeline list

List pipelines visible in the active runtime environment (set via the StudioAdmin UI — switch tenants/folders there if you don't see what you expect).

Opções

Long	Valor	Description
--repository-ids <csv>	comma-separated	Narrow to one or more SC repository UUIDs (from connection repos).
--offset <n>	Número inteiro	Number to skip. Must be a multiple of --limit. Default 0.
--limit <n>	Número inteiro	Maximum to return. Default 20.
--search <term>	String	Server-side substring filter on pipeline name.

Formato dos dados (--output json)

{
  "Code": "PipelineList",
  "Data": [
    { "PipelineId": "11111111-2222-3333-4444-555555555555", "Name": "release-main", "Repository": "automation-hub", "LastRunState": "Successful", "LastRunEnd": "2026-05-05T14:23:00.000Z" }
  ]
}

A curated row per pipeline — use pipeline get <id> for the full DTO, including branch and project binding.

uip aops pipeline state

Fetch a runtime-environment-wide snapshot of pipelines state — counts and roll-up state used by the StudioAdmin dashboard. A cheap way to confirm the runtime environment is reachable before listing or mutating.

Formato dos dados (--output json)

{ "Code": "PipelinesState", "Data": {} }

uip aops pipeline processes

List automation processes that pipelines can be bound to.

Formato dos dados (--output json)

{
  "Code": "PipelineProcesses",
  "Data": [ { "ProcessId": "33333333-4444-5555-6666-777777777777", "Name": "InvoiceProcessing", "Description": "Daily invoice ingest", "Package": "MyOrg.Invoice.Processing", "Version": "1.2.0" } ]
}

A curated row per process — use the returned ProcessId as PipelineDto's processIdentifier when authoring a pipeline. Drill into one with pipeline process <process-id> for the full DTO including arguments.

uip aops pipeline process

Resolve a single automation process by identifier.

Argumentos

Name	Required	Finalidade
<process-id>	sim	Process identifier from pipeline processes.

Formato dos dados (--output json)

{ "Code": "PipelineProcess", "Data": {} }

uip aops pipeline repos

List SourceControl repositories that have at least one pipeline.

Formato dos dados (--output json)

{ "Code": "PipelineRepos", "Data": [] }

uip aops pipeline get

Fetch a pipeline by identifier.

Argumentos

Name	Required	Finalidade
<pipeline-id>	sim	Pipeline identifier from pipeline list.

Opções

Long	Valor	Description
--for-update	Bandeira	Return the EditPipelineDto shape instead of the full PipelineDto, with server-only fields stripped — feed the result straight into pipeline update --file without manual transformation.
--output-file <path>	Path	Also write the payload to this file as JSON (UTF-8, 2-space indent). Stdout still emits the full structured envelope.

--for-update keeps the DTO's own key casing in Data (not PascalCased). --output-filter runs against Data as printed and is case-sensitive — with --for-update, match the DTO's own field names.

Exemplos

uip aops pipeline get 11111111-2222-3333-4444-555555555555

uip aops pipeline get 11111111-2222-3333-4444-555555555555 --for-update --output-file ./pipeline.json

Formato dos dados (--output json)

{ "Code": "PipelineGet", "Data": { "identifier": "11111111-2222-3333-4444-555555555555", "name": "release-main" } }

uip aops pipeline search

Find a pipeline by name.

Opções

Long	Valor	Description
--name <name>	String	Exact-match lookup. Returns a single PipelineDto.
--prefix <prefix>	String	Startswith query. Returns an array.

Exactly one of --name/--prefix is required — passing both, or neither, fails client-side before any network call.

Exemplos

uip aops pipeline search --name "release-main"

uip aops pipeline search --prefix "release-"

Formato dos dados (--output json)

{ "Code": "PipelineSearch", "Data": {} }

No match fails with Pipeline '<name>' not found. (for --name) or No pipelines matched prefix '<prefix>'. (for --prefix) rather than an empty success.

uip aops pipeline create

Create a new pipeline from a JSON file conforming to PipelineDto.

Opções

Long	Valor	Required	Description
--file <path>	Path	sim	JSON file containing the PipelineDto to create. Do not include a server-assigned identifier.
--telemetry-flow-id <id>	String	não	Telemetry flow id for server-side correlation.

Formato dos dados (--output json)

{ "Code": "PipelineCreated", "Data": { "identifier": "11111111-2222-3333-4444-555555555555" } }

Capture the returned identifier for follow-up run/update/delete calls. A conflict error usually means a pipeline with the same name already exists.

uip aops pipeline update

Update an existing pipeline. Full replace (HTTP PUT) — any field the file omits is cleared server-side.

Argumentos

Name	Required	Finalidade
<pipeline-id>	sim	Pipeline to update. Must match the file's identifier field if that field is set.

Opções

Long	Valor	Required	Description
--file <path>	Path	sim	JSON file containing the EditPipelineDto to apply.

Only EditPipelineDto's own keys are sent — a file carrying an unrecognized key (including one that's merely miscased) is rejected outright rather than silently dropped as a partial wipe.

Formato dos dados (--output json)

{ "Code": "PipelineUpdated", "Data": { "Pipeline": { "identifier": "11111111-2222-3333-4444-555555555555", "name": "release-main" } } }

Data.Pipeline echoes the request that was sent, not the file as read from disk.

uip aops pipeline delete

Delete a pipeline by identifier. Permanent — running executions are not auto-stopped, but new runs are rejected immediately.

Argumentos

Name	Required	Finalidade
<pipeline-id>	sim	Pipeline identifier from pipeline list.

Opções

Long	Description
-y, --yes	Required. Confirms this irreversible operation.

Formato dos dados (--output json)

{ "Code": "PipelineDeleted", "Data": { "PipelineId": "11111111-2222-3333-4444-555555555555" } }

uip aops pipeline run

Trigger a pipeline run. Returns 202 immediately — the run is queued asynchronously.

Argumentos

Name	Required	Finalidade
<pipeline-id>	sim	Pipeline identifier from pipeline list.

Formato dos dados (--output json)

{ "Code": "PipelineRunStarted", "Data": { "PipelineId": "11111111-2222-3333-4444-555555555555" } }

Use pipeline executions <pipeline-id> to discover the new execution id, then execution logs --follow to track it.

uip aops pipeline save-and-run

Persist a pipeline DTO from JSON and immediately run it.

Opções

Long	Valor	Required	Description
--file <path>	Path	sim	JSON file containing the PipelineDto to save and run.
--telemetry-flow-id <id>	String	não	Telemetry flow id for server-side correlation.

Formato dos dados (--output json)

{
  "Code": "PipelineSavedAndRunStarted",
  "Data": { "pipeline": { "identifier": "11111111-2222-3333-4444-555555555555" }, "executionId": "22222222-3333-4444-5555-666666666666" }
}

executionId is lifted out of the persisted pipeline's latestPipelineExecution for immediate chaining into execution logs --follow; it's null if the field is absent.

uip aops pipeline executions

List executions for a pipeline.

Argumentos

Name	Required	Finalidade
<pipeline-id>	sim	Pipeline identifier from pipeline list.

Opções

Long	Valor	Description
--offset <n>	Número inteiro	Number to skip. Must be a multiple of --limit. Default 0.
--limit <n>	Número inteiro	Maximum to return. Default 20.

Formato dos dados (--output json)

{
  "Code": "PipelineExecutions",
  "Data": [ { "ExecutionId": "22222222-3333-4444-5555-666666666666", "BuildNumber": "42", "CommitRef": "0123456789abcdef0123456789abcdef01234567", "State": "Successful", "EnqueuedAt": "2026-05-05T14:21:00.000Z", "EndedAt": "2026-05-05T14:23:00.000Z" } ]
}

Drill into one with execution get <execution-id> for the full DTO (run mode, triggering user, jobExecutionIdentifier, failure code).

uip aops pipeline executions-bulk

Fetch metadata for several pipeline executions in one round-trip.

Opções

Long	Valor	Required	Description
--ids <csv>	comma-separated	sim	Pipeline execution identifiers (from pipeline executions) — not pipeline ids.

Formato dos dados (--output json)

{ "Code": "PipelineExecutionsBulk", "Data": [] }

uip aops execution

Inspect and control pipeline executions. All verbs except get accept either an <execution-id> positional (the CLI looks up the underlying jobKey for you) or --job-key <key> to skip that lookup when you already have it. get is keyed by execution id only.

uip aops execution get

Fetch a pipeline execution's metadata by execution id.

Argumentos

Name	Required	Finalidade
<execution-id>	sim	From pipeline executions <pipeline-id>.

Opções

Long	Description
--with-arguments	Also fetch the runtime input arguments the pipeline ran with (parsed JSON, or the raw string if parsing fails). One extra round-trip.

Formato dos dados (--output json)

{ "Code": "ExecutionGet", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Successful", "inputArguments": { "ArgumentName": "value" } } }

Use the returned jobExecutionIdentifier as --job-key for logs/details/stop to skip their auto-lookup.

uip aops execution logs

Fetch logs for an execution.

Argumentos

Name	Required	Finalidade
[execution-id]	conditionally	Required unless --job-key is set; required regardless if --follow is set (state polling is execution-id-keyed).

Opções

Long	Valor	Description
--job-key <key>	String	Use this job key directly, skipping the execution-id lookup.
--follow	Bandeira	Stream logs until the execution reaches a terminal state (Successful/Faulted/Stopped).
--limit <n>	Número inteiro	Page size per log fetch. Default 200.
--poll-interval <ms>	Número inteiro	Interval between polls when --follow is set. Default 2000.
--timeout <ms>	Número inteiro	Maximum time to follow before giving up. Default 1800000 (30 minutes).

Without --follow: prints the current log slice and exits (Code: "ExecutionLogs"). With --follow: log lines stream to stderr as they arrive (not subject to --log-level, not captured by --log-file — redirect stderr explicitly to keep them), and stdout emits a final envelope with the terminal state and line count (Code: "ExecutionLogsFollowed").

Exemplos

uip aops execution logs 22222222-3333-4444-5555-666666666666

uip aops execution logs 22222222-3333-4444-5555-666666666666 --follow 2> build.log

Formato dos dados (--output json)

{ "Code": "ExecutionLogsFollowed", "Data": { "state": "Successful", "lineCount": 42 } }

uip aops execution details

Fetch the underlying job-execution detail document — robot, machine, release, and host context. Useful when triaging a failure to see which runner it ran on.

Argumentos

Name	Required	Finalidade
[execution-id]	conditionally	Required unless --job-key is set.

Opções

Long	Valor	Description
--job-key <key>	String	Use this job key directly, skipping the execution-id lookup.

Formato dos dados (--output json)

{ "Code": "ExecutionDetails", "Data": {} }

uip aops execution stop

Request a stop on a pipeline execution. Idempotent — calling it on an already-terminal execution returns the current state without erroring.

Argumentos

Name	Required	Finalidade
[execution-id]	conditionally	Required unless --job-key is set; required regardless if --wait is set.

Opções

Long	Valor	Description
--job-key <key>	String	Use this job key directly, skipping the execution-id lookup.
--wait	Bandeira	Poll until the execution settles to terminal instead of returning immediately.
--poll-interval <ms>	Número inteiro	Interval between polls when --wait is set. Default 2000.
--timeout <ms>	Número inteiro	Maximum time to wait when --wait is set. Default 300000 (5 minutes).

Exemplos

uip aops execution stop 22222222-3333-4444-5555-666666666666

uip aops execution stop 22222222-3333-4444-5555-666666666666 --wait

Formato dos dados (--output json)

{ "Code": "ExecutionStopRequested", "Data": { "identifier": "22222222-3333-4444-5555-666666666666", "state": "Stopping" } }

With --wait, the final envelope is Code: "ExecutionStopped" with the settled state. Calling stop on an execution that's already terminal returns Code: "ExecutionAlreadyTerminal" instead of re-issuing the stop.

Relacionado

• uip aops — overview and concepts.
• connections — discover the repository a pipeline builds from.
• projects — discover the process a pipeline binds to.

Veja também

• Opções globais
• Códigos de saída