Pipelines

List Pipelines

get

Gets a list of pipelines.

Args: pipeline_filter_model: Filter model used for pagination, sorting, filtering. project_name_or_id: Optional name or ID of the project to filter by. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: List of pipeline objects matching the filter criteria.

Authorizations

OAuth2passwordRequired

Token URL:

Query parameters

project_name_or_idany ofOptional

stringOptional

string · uuidOptional

nullOptional

hydratebooleanOptionalDefault: false

sort_bystringOptionalDefault: created

logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:

pageinteger · min: 1OptionalDefault: 1

sizeinteger · min: 1 · max: 10000OptionalDefault: 20

idany ofOptional

string · uuidOptional

stringOptional

nullOptional

createdany ofOptional

string · date-timeOptional

stringOptional

nullOptional

updatedany ofOptional

string · date-timeOptional

stringOptional

nullOptional

tagany ofOptional

stringOptional

nullOptional

tagsany ofOptional

string[]Optional

nullOptional

scope_userany ofOptional

string · uuidOptional

nullOptional

userany ofOptional

string · uuidOptional

stringOptional

nullOptional

projectany ofOptional

string · uuidOptional

stringOptional

nullOptional

nameany ofOptional

stringOptional

nullOptional

latest_run_statusany ofOptional

stringOptional

nullOptional

latest_run_userany ofOptional

string · uuidOptional

stringOptional

nullOptional

Responses

200

Successful Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

get

/api/v1/pipelines

GET /api/v1/pipelines HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2025-11-14T18:06:45.748Z",
        "updated": "2025-11-14T18:06:45.748Z",
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "description": "text"
      },
      "resources": {
        "user": {
          "body": {
            "created": "2025-11-14T18:06:45.748Z",
            "updated": "2025-11-14T18:06:45.748Z",
            "active": false,
            "activation_token": "text",
            "full_name": "",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
            "avatar_url": "text"
          },
          "metadata": {
            "email": "",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false,
          "name": "text"
        },
        "latest_run_user": {
          "body": {
            "created": "2025-11-14T18:06:45.748Z",
            "updated": "2025-11-14T18:06:45.748Z",
            "active": false,
            "activation_token": "text",
            "full_name": "",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
            "avatar_url": "text"
          },
          "metadata": {
            "email": "",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false,
          "name": "text"
        },
        "latest_run_id": "123e4567-e89b-12d3-a456-426614174000",
        "latest_run_status": "initializing",
        "tags": [
          {
            "body": {
              "created": "2025-11-14T18:06:45.748Z",
              "updated": "2025-11-14T18:06:45.748Z",
              "user_id": "123e4567-e89b-12d3-a456-426614174000",
              "color": "grey",
              "exclusive": true
            },
            "metadata": {
              "tagged_count": 1
            },
            "resources": {
              "user": {
                "body": {
                  "created": "2025-11-14T18:06:45.748Z",
                  "updated": "2025-11-14T18:06:45.748Z",
                  "active": false,
                  "activation_token": "text",
                  "full_name": "",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true,
                  "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                  "avatar_url": "text"
                },
                "metadata": {
                  "email": "",
                  "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                  "user_metadata": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  }
                },
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": false,
                "name": "text"
              },
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": false,
            "name": "text"
          }
        ],
        "visualizations": [
          "[Circular Reference]"
        ],
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    }
  ]
}

Get Pipeline

get

Gets a specific pipeline using its unique id.

Args: pipeline_id: ID of the pipeline to get. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: A specific pipeline object.

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

pipeline_idstring · uuidRequired

Query parameters

hydratebooleanOptionalDefault: true

Responses

200

Successful Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

get

/api/v1/pipelines/{pipeline_id}

GET /api/v1/pipelines/{pipeline_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "body": {
    "created": "2025-11-14T18:06:45.748Z",
    "updated": "2025-11-14T18:06:45.748Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "metadata": {
    "description": "text"
  },
  "resources": {
    "user": {
      "body": {
        "created": "2025-11-14T18:06:45.748Z",
        "updated": "2025-11-14T18:06:45.748Z",
        "active": false,
        "activation_token": "text",
        "full_name": "",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
        "avatar_url": "text"
      },
      "metadata": {
        "email": "",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    },
    "latest_run_user": {
      "body": {
        "created": "2025-11-14T18:06:45.748Z",
        "updated": "2025-11-14T18:06:45.748Z",
        "active": false,
        "activation_token": "text",
        "full_name": "",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
        "avatar_url": "text"
      },
      "metadata": {
        "email": "",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    },
    "latest_run_id": "123e4567-e89b-12d3-a456-426614174000",
    "latest_run_status": "initializing",
    "tags": [
      {
        "body": {
          "created": "2025-11-14T18:06:45.748Z",
          "updated": "2025-11-14T18:06:45.748Z",
          "user_id": "123e4567-e89b-12d3-a456-426614174000",
          "color": "grey",
          "exclusive": true
        },
        "metadata": {
          "tagged_count": 1
        },
        "resources": {
          "user": {
            "body": {
              "created": "2025-11-14T18:06:45.748Z",
              "updated": "2025-11-14T18:06:45.748Z",
              "active": false,
              "activation_token": "text",
              "full_name": "",
              "email_opted_in": true,
              "is_service_account": true,
              "is_admin": true,
              "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
              "avatar_url": "text"
            },
            "metadata": {
              "email": "",
              "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
              "user_metadata": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              }
            },
            "resources": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": false,
            "name": "text"
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": false,
        "name": "text"
      }
    ],
    "visualizations": [
      {
        "body": {
          "created": "2025-11-14T18:06:45.748Z",
          "updated": "2025-11-14T18:06:45.748Z",
          "user_id": "123e4567-e89b-12d3-a456-426614174000",
          "project_id": "123e4567-e89b-12d3-a456-426614174000",
          "artifact_visualization_id": "123e4567-e89b-12d3-a456-426614174000",
          "artifact_version_id": "123e4567-e89b-12d3-a456-426614174000",
          "display_name": "text",
          "display_order": 1,
          "layout_size": "full_width",
          "resource_id": "123e4567-e89b-12d3-a456-426614174000",
          "resource_type": "deployment"
        },
        "metadata": {},
        "resources": "[Circular Reference]",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": false
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": false,
  "name": "text"
}

Update Pipeline

put

Updates the attribute on a specific pipeline using its unique id.

Args: pipeline_id: ID of the pipeline to get. pipeline_update: the model containing the attributes to update.

Returns: The updated pipeline object.

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

pipeline_idstring · uuidRequired

Body

Update model for pipelines.

descriptionany ofOptional

string · max: 65535Optional

nullOptional

add_tagsany ofOptional

string[]Optional

nullOptional

remove_tagsany ofOptional

string[]Optional

nullOptional

Responses

200

Successful Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

put

/api/v1/pipelines/{pipeline_id}

PUT /api/v1/pipelines/{pipeline_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "description": "text",
  "add_tags": [
    "text"
  ],
  "remove_tags": [
    "text"
  ]
}

{
  "body": {
    "created": "2025-11-14T18:06:45.748Z",
    "updated": "2025-11-14T18:06:45.748Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "metadata": {
    "description": "text"
  },
  "resources": {
    "user": {
      "body": {
        "created": "2025-11-14T18:06:45.748Z",
        "updated": "2025-11-14T18:06:45.748Z",
        "active": false,
        "activation_token": "text",
        "full_name": "",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
        "avatar_url": "text"
      },
      "metadata": {
        "email": "",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    },
    "latest_run_user": {
      "body": {
        "created": "2025-11-14T18:06:45.748Z",
        "updated": "2025-11-14T18:06:45.748Z",
        "active": false,
        "activation_token": "text",
        "full_name": "",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
        "avatar_url": "text"
      },
      "metadata": {
        "email": "",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    },
    "latest_run_id": "123e4567-e89b-12d3-a456-426614174000",
    "latest_run_status": "initializing",
    "tags": [
      {
        "body": {
          "created": "2025-11-14T18:06:45.748Z",
          "updated": "2025-11-14T18:06:45.748Z",
          "user_id": "123e4567-e89b-12d3-a456-426614174000",
          "color": "grey",
          "exclusive": true
        },
        "metadata": {
          "tagged_count": 1
        },
        "resources": {
          "user": {
            "body": {
              "created": "2025-11-14T18:06:45.748Z",
              "updated": "2025-11-14T18:06:45.748Z",
              "active": false,
              "activation_token": "text",
              "full_name": "",
              "email_opted_in": true,
              "is_service_account": true,
              "is_admin": true,
              "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
              "avatar_url": "text"
            },
            "metadata": {
              "email": "",
              "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
              "user_metadata": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              }
            },
            "resources": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": false,
            "name": "text"
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": false,
        "name": "text"
      }
    ],
    "visualizations": [
      {
        "body": {
          "created": "2025-11-14T18:06:45.748Z",
          "updated": "2025-11-14T18:06:45.748Z",
          "user_id": "123e4567-e89b-12d3-a456-426614174000",
          "project_id": "123e4567-e89b-12d3-a456-426614174000",
          "artifact_visualization_id": "123e4567-e89b-12d3-a456-426614174000",
          "artifact_version_id": "123e4567-e89b-12d3-a456-426614174000",
          "display_name": "text",
          "display_order": 1,
          "layout_size": "full_width",
          "resource_id": "123e4567-e89b-12d3-a456-426614174000",
          "resource_type": "deployment"
        },
        "metadata": {},
        "resources": "[Circular Reference]",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": false
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": false,
  "name": "text"
}

Delete Pipeline

delete

Deletes a specific pipeline.

Args: pipeline_id: ID of the pipeline to delete.

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

pipeline_idstring · uuidRequired

Responses

200

Successful Response

application/json

Responseany

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

delete

/api/v1/pipelines/{pipeline_id}

DELETE /api/v1/pipelines/{pipeline_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

PreviousRuns NextRuns

Last updated 8 months ago

Was this helpful?

Good evening

List Pipelines

Get Pipeline

Update Pipeline

Delete Pipeline