Get Pipeline

Get Pipeline
Get a pipeline in a catalog

Return a pipeline in a specific catalog for an organization. The id of the organization is fetched from CSP token

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

A string as the identifier of a catalog

string
pipeline_id
Required

Identifier of the pipeline

pipeline_id example
e5ba840a-c82f-4bae-9a0f-a0dc346a7fba
Authentication
This operation uses the following authentication methods.
Responses
200

Details of the pipeline

Returns Pipeline of type(s) application/json 
{
    "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"
        }
    }
}
string
id
Required

Identifier of the pipeline

array of object
triggers
Required

Represents a trigger for a pipeline

string
status
Required

Pipeline status (IN_PROGRESS, SUCCEEDED, FAILED, CANCELLED)

string As date-time As date-time
started_at
Required

Date of the start of the pipeline

string As date-time As date-time
ended_at
Optional

Date of the end of the pipeline

object
product
Required

It contains information about the software offered

base_image
Required

It contains information about the base image used for an application

string
branch
Required

Branch of the releaseable built by the pipeline

string
packaging_type
Required

Packaging type of the application (HELM_CHART, OVA, CONTAINER_IMAGE)

string
version
Required
Constraints: maxLength: 64

A text identifier for the specific upstream software released

string
product_version
Required

Version of the product built by the pipeline.

string
revision
Optional
Constraints: maxLength: 64

Revision of the pipeline for a specific combination of product and version

array of object
phases
Required

Represents a phase in a pipeline

object
registry
Optional

Registry where the artifacts of an application release are pushed to

string
release_id
Optional
Constraints: maxLength: 255

Unique identifier of a release

object
customization
Optional

It contains information about a customization in a catalog

string
application_id
Optional

Identifier of the application

object
_links
Required

Section to include hyperlinks based on Hypertext Application Language


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 pipeline

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 or pipeline 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/{pipeline_id}
On This Page
Pipelines Operations
GET
Get Pipelines
GET
Get Pipeline