Get Releases | VMware Tanzu Application Catalog

Get Releases

Return a paginated list of minimum information about the releases in a specific catalog for an organization order by release date descending. The id of the organization is fetched from CSP token

Request

URI

GET

https://{api_host}/v1/catalogs/{catalog_id}/releases

COPY

Path Parameters

CatalogId

catalog_id

Required

A string as the identifier of a catalog

Query Parameters

CatalogApplicationId

application_id

Optional

Application id of the releases Only one of application_id, content_digest and repo_digest should be used at the same time

RegistryId

registry_id

Optional

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

string

content_digest

Optional

Content digest of the artifact of the release. Only one of application_id, content_digest and repo_digest should be used at the same time

content_digest example

sha256:81a957b549848a7424eb434d3d10642dd29b6d0577757c27c09b0b9e967eb64b

string

repo_digest

Optional

Repo digest of the artifact of the release Only one of application_id, content_digest and repo_digest should be used at the same time.

repo_digest example

sha256:81a957b549848a7424eb434d3d10642dd29b6d0577757c27c09b0b9e967eb64b

boolean

minimal_info

Optional

Constraints: default: false

Return only the required properties of a release Mainly intended to be used in conjunction with the application_id query param

boolean

expand_relationships

Optional

Constraints: default: false

Include detailed release payload for the dependencies and dependants of the release

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.

BearerAuth

Responses

200

Paginated list of releases of an application in an specific catalog

Returns ReleasesPage of type(s) application/json

This response body class contains all of the following: InlineReleasesPage0 , InlineReleasesPage1

"ReleasesPage 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 releases

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}/releases

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

Releases Operations

Get Releases By Large Set Values

GET

Get Releases From All Catalogs

POST

Bulk Get Releases From All Catalogs