Get Pipelines

Get Pipelines
Get pipelines in a specific catalog

Return a paginated list of pipelines in a specific catalog

Request
URI
GET
https://api.app-catalog.vmware.com/v1/catalogs/{catalog_id}/pipelines
COPY
Path Parameters
CatalogId
catalog_id
Required

A string as the identifier of a catalog

Query Parameters
CatalogApplicationId
application_id
Optional

Identifier of the application

ReleaseId
release_id
Optional

A string as the identifier of a release

string
status
Optional

Status of the pipeline (IN_PROGRESS, SUCCEEDED, FAILED)

status example
IN_PROGRESS
RegistryId
registry_id
Optional

A string as the identifier of a registry. It can only be used in conjunction with application_id

BaseImageId
base_image_id
Optional

A string as the identifier of a base image

PackagingType
packaging_type
Optional

Packaging type of an application

boolean
applications_only
Optional

Include results that apply to applications in the catalog (exclude dependencies)

applications_only example
true
string
order_field
Optional
Constraints: default: STARTED_AT

Name of the field to order the pipelines: STARTED_AT, STATUS, PACKAGING_TYPE, REGISTRY_NAME, BASE_IMAGE_NAME, PRODUCT_NAME, DISTRIBUTION_STARTED_AT

order_field example
STARTED_AT
string
order_direction
Optional
Constraints: default: DESC

Order to sort by the selected field: ASC or DESC (default)

integer
page
Optional
Constraints: minimum: 1 default: 1

An integer that identifies the page number for a paged response

integer
page_size
Optional
Constraints: minimum: 1 maximum: 100 default: 20

An integer that identifies the maximum page size for a paged response

Authentication
This operation uses the following authentication methods.
Responses
200

Paginated list of pipelines in a specific catalog

Returns PipelinesPage of type(s) application/json
This response body class contains all of the following: InlinePipelinesPage0 , InlinePipelinesPage1 
{
    "page": 1,
    "page_size": 5,
    "total_size": 10,
    "total_pages": 2,
    "items": [
        {
            "id": "94bd3a9b-ddfd-4b7e-ac56-200b8a73484d",
            "triggers": [
                {
                    "type": "CVE_PATCH",
                    "context": "CVE-25010-1312"
                }
            ],
            "status": "IN_PROGRESS",
            "started_at": "2023-03-03T00:59:52.762Z",
            "ended_at": "2023-03-03T00:59:52.762Z",
            "product": {
                "name": "Argo CD",
                "key": "argo-cd",
                "description": "Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes",
                "long_display_name": "Argo CD packaged by VMware",
                "disclaimer": "Trademarks: This software listing is packaged by VMware. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement",
                "category": "Developer Tools",
                "based_on_scratch": true,
                "latest_free": false
            },
            "base_image": {
                "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
                "name": "Debian 11",
                "description": "Debian 11 base image",
                "container_image": "docker.io/library/debian:11",
                "operating_system": {
                    "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
                    "name": "Centos 7",
                    "distro": "centos",
                    "version": "7"
                },
                "healthy": true,
                "last_checked_at": "2023-03-03T00:59:52.762Z"
            },
            "branch": "1",
            "packaging_type": "HELM_CHART",
            "version": "2.6.7",
            "product_version": "4.0.7",
            "revision": "0",
            "phases": [
                {
                    "type": "PACKAGING",
                    "status": "IN_PROGRESS",
                    "started_at": "2023-03-03T00:59:52.762Z",
                    "ended_at": "2023-03-03T00:59:52.762Z",
                    "failure": {
                        "error_message": "Error building the container",
                        "cause": "CUSTOMIZATION_BUILD_ERROR",
                        "pipeline_metadata": [
                            {
                                "id": "127e6fbfe24a750e72930c220a8e138275656b8e5d8f48a98c3c92df2caba935",
                                "mime_type": "trigger_info",
                                "url": "https://app-catalog.vmware.com/api/v1/artifacts/89a6380a7d010648bad74e4de1c2ef17481a7f4715ff62bb8924e5c0b907bf3d?filename=common-postgresql-15-15.2.0-r5-debian-11-amd64.ova&namespace=68c0f832-5169-4433-ab2f-40e939e3f1bc",
                                "filename": "result.json"
                            }
                        ]
                    }
                }
            ],
            "registry": {
                "id": "549cfa79-352c-4555-9d28-4442de551829",
                "name": "Harbor registry for my org",
                "url": "https://harbor.mydomain.com",
                "healthy": true,
                "last_checked_at": "2023-03-03T00:59:52.762Z"
            },
            "release_id": "64455e6bd3c480fd58546c75",
            "customization": {
                "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
                "version": "v4",
                "artifact": {
                    "id": "127e6fbfe24a750e72930c220a8e138275656b8e5d8f48a98c3c92df2caba935",
                    "url": "/v1/catalogs/46ba3c35-fb85-44a1-8336-694b4d4f4b91/files/81a957b549848a7424eb434d3d10642dd29b6d0577757c27c09b0b9e967eb64b?filename=custom-postgresql-15-15.2.0-r5-debian-11-amd64.ova",
                    "filename": "script.sh"
                }
            },
            "application_id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
            "_links": {
                "catalog": {
                    "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9"
                },
                "application": {
                    "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/applications/d16c7f4d-b38a-405b-a1ca-3ac0a79418c1"
                },
                "base_image": {
                    "href": "/v1/base-images/cc6c7f4d-405b-a1ca-3ac0a79418c1"
                },
                "release": {
                    "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/releases/12sdfe6bd3c480fd58549c03"
                },
                "registry": {
                    "href": "/v1/registries/64455e6bd3c480fd58546c75"
                },
                "product": {
                    "href": "/v1/applications/product/wordpress/branch/7?packaging=CONTAINER_IMAGE&distro=photon-4"
                },
                "customization": {
                    "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/customizations/d16c7f4d-b38a-405b-a1ca-3ac0a79418c1"
                }
            }
        }
    ]
}

400

An error related to the request

Returns ConstraintsViolationsError of type(s) application/problem+json
This response body class contains all of the following: InlineConstraintsViolationsError0 
{
    "type": "https://example.com/probs/validation-error",
    "title": "Validation error",
    "status": 400,
    "detail": "There was an error validating the request",
    "violations": [
        {
            "field": "amount",
            "message": "It should be greater than zero"
        }
    ]
}
array of object
violations
Required

It represents a constraints violation error


403

The requesting user is not authorized to get the pipelines

Returns Error403 of type(s) application/problem+json
This response body class contains all of the following: InlineError4030 
{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

404

The requested catalog is not found

Returns Error404 of type(s) application/problem+json
This response body class contains all of the following: InlineError4040 
{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

500

An internal server error object

Returns Error500 of type(s) application/problem+json
This response body class contains all of the following: InlineError5000 
{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

503

The server is temporarily unavailable

Returns Error503 of type(s) application/problem+json
This response body class contains all of the following: InlineError5030 
{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/catalogs/{catalog_id}/pipelines
On This Page
Pipelines Operations
GET
Get Pipelines
GET
Get Pipeline