---
title: "run pipeline"
method: POST
path: "/api/v1/projects/{projectName}/pipelines/{pipelineName}/run"
tags: ["pipeline"]
---

# run pipeline

`POST /api/v1/projects/{projectName}/pipelines/{pipelineName}/run`

## Path parameters

- `projectName` string, required
- `pipelineName` string, required

## Request body

- V1RunPipelineRequest
  - `contextName` string, required
  - `mode` V1alpha1WorkflowExecuteMode
    - `steps` string
    - `subSteps` string

## Response `200`

OK

- V1PipelineRun
  - `contextName` string, required
  - `contextValues` ModelValue[], required
    - `key` string, required
    - `value` string, required
  - `pipelineName` string, required
  - `pipelineRunName` string, required
  - `project` V1NameAlias, required
    - `alias` string, required
    - `name` string, required
  - `record` integer, required
  - `spec` V1alpha1WorkflowRunSpec, required
    - `context` string
    - `mode` V1alpha1WorkflowExecuteMode
      - `steps` string
      - `subSteps` string
    - `workflowRef` string
    - `workflowSpec` V1alpha1WorkflowSpec
      - `steps` V1alpha1WorkflowStep[]
        - `dependsOn` string[]
        - `if` string
        - `inputs` V1alpha1InputItem[]
          - `from` string, required
          - `parameterKey` string
        - `meta` V1alpha1WorkflowStepMeta
          - `alias` string
        - `mode` string
        - `name` string
        - `outputs` V1alpha1OutputItem[]
          - `name` string, required
          - `valueFrom` string, required
        - `properties` string
        - `subSteps` V1alpha1WorkflowStepBase[]
          - `dependsOn` string[]
          - `if` string
          - `inputs` V1alpha1InputItem[]
            - `from` string, required
            - `parameterKey` string
          - `meta` V1alpha1WorkflowStepMeta
            - `alias` string
          - `name` string
          - `outputs` V1alpha1OutputItem[]
            - `name` string, required
            - `valueFrom` string, required
          - `properties` string
          - `timeout` string
          - `type` string, required
        - `timeout` string
        - `type` string, required
  - `status` V1alpha1WorkflowRunStatus, required
    - `conditions` ConditionCondition[]
      - `lastTransitionTime` string, required
      - `message` string
      - `reason` string, required
      - `status` string, required
      - `type` string, required
    - `contextBackend` V1ObjectReference — ObjectReference contains enough information to let you inspect or modify the referred object.
      - `apiVersion` string — API version of the referent.
      - `fieldPath` string — If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
      - `kind` string — Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
      - `name` string — Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
      - `namespace` string — Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
      - `resourceVersion` string — Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
      - `uid` string — UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
    - `endTime` string
    - `finished` boolean, required
    - `message` string
    - `mode` V1alpha1WorkflowExecuteMode, required
      - `steps` string
      - `subSteps` string
    - `startTime` string
    - `status` string, required
    - `steps` V1alpha1WorkflowStepStatus[]
      - `firstExecuteTime` string
      - `id` string, required
      - `lastExecuteTime` string
      - `message` string
      - `name` string
      - `phase` string
      - `reason` string
      - `subSteps` V1alpha1StepStatus[]
        - `firstExecuteTime` string
        - `id` string, required
        - `lastExecuteTime` string
        - `message` string
        - `name` string
        - `phase` string
        - `reason` string
        - `type` string
      - `type` string
    - `suspend` boolean, required
    - `suspendState` string
    - `terminated` boolean, required

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/kubevela/apis/kubevela-api-doc.md) · [All operations](https://skmtc.net/kubevela/apis/kubevela-api-doc/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kubevela/kubevela-api-doc/revisions/8e41615b25d5/schema)