Get Pipelines

Get Pipelines

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

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

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 pipelines

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

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 
"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
On This Page
Pipelines Operations
GET
Get Pipelines
GET
Get Pipeline