Get Pipeline

Get Pipeline

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 
"Pipeline Object"
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

Version of the releaseable built by the pipeline.

string
product_version
Required

Version of the product built by the pipeline.

string
revision
Optional

Revision of the releaseable built by the pipeline

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 
"ConstraintsViolationsError Object"
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 
"Error403 Object"

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 
"Error404 Object"

500

An internal server error object

Returns Error500 of type(s) application/problem+json
This response body class contains all of the following: InlineError5000 
"Error500 Object"

503

The server is temporarily unavailable

Returns Error503 of type(s) application/problem+json
This response body class contains all of the following: InlineError5030 
"Error503 Object"

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