Get Release

Get Release
Get detailed information about a release in a specific catalog

Returns detailed information of a release 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}/releases/{release_id}
COPY
Path Parameters
catalog_id
Required

A string as the identifier of a catalog

release_id
Required

A string as the identifier of a release

Query Parameters
boolean
expand_relationships
Optional
Constraints: default: false

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


Authentication
This operation uses the following authentication methods.
Responses
200

A detailed release in a specific catalog

Returns Release of type(s) application/json
{
    "id": "64455e6bd3c480fd58546c75",
    "branch": "2",
    "end_of_life_at": "2023-03-03T00:00:00.000Z",
    "version": "2.6.7",
    "revision": "0",
    "released_at": "2023-03-03T00:59:52.762Z",
    "packaging_type": "HELM_CHART",
    "artifact": {
        "content_digest": "sha256:81a957b549848a7424eb434d3d10642dd29b6d0577757c27c09b0b9e967eb64b",
        "repo_digest": "sha256:37a957b541234a7424eb434d3d10642dd29b6d0577757c27c09b0b9e967eb23f",
        "name": "argo-cd",
        "version": "4.5.1",
        "repository": "us-east4-docker.pkg.dev/vmw-app-catalog/registry-03bc486b/charts/ubuntu-22",
        "url": "us-east4-docker.pkg.dev/vmw-app-catalog/registry-03bc486b/charts/ubuntu-22/argo-cd:4.5.1"
    },
    "latest_release": {
        "id": "64455e6bd3c480fd58546c75",
        "revision": "0",
        "released_at": "2023-03-03T00:59:52.762Z",
        "version": "2.6.7"
    },
    "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
    },
    "platforms": [
        {
            "os_family": "linux",
            "architecture": "amd64"
        }
    ],
    "platform_release_metadata": [
        {
            "platform": {
                "os_family": "linux",
                "architecture": "amd64"
            },
            "release_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"
                }
            ]
        }
    ],
    "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"
    },
    "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"
    },
    "catalog_id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
    "application_id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
    "customizations": [
        {
            "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"
            }
        }
    ],
    "pipeline_id": "94bd3a9b-ddfd-4b7e-ac56-200b8a73484d",
    "dependencies": [
        "Release Object"
    ],
    "dependants": [
        "Release Object"
    ],
    "trial": true,
    "_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"
        },
        "latest_release": {
            "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/releases/12sdfe6bd3c480fd58549c03"
        },
        "dependencies": [
            {
                "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/releases/2222e6bd3c480fd58549c03"
            }
        ],
        "dependants": [
            {
                "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/releases/2222e6bd3c480fd58549c03"
            }
        ],
        "self": {
            "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/releases/64455e6bd3c480fd58546c75"
        },
        "registry": {
            "href": "/v1/registries/64455e6bd3c480fd58546c75"
        },
        "product": {
            "href": "/v1/applications/product/wordpress/branch/7?packaging=CONTAINER_IMAGE&distro=photon-4"
        },
        "pipeline": {
            "href": "/v1/catalogs/351c1739-ca01-4a74-8124-1b99257cd7c9/pipelines/d16c7f4d-b38a-405b-a1ca-3ac0a79418c1"
        }
    }
}
string
id
Required
Constraints: maxLength: 255

Unique identifier of a release

string
branch
Optional
Constraints: maxLength: 32

Identifier of the branch

string As date As date
end_of_life_at
Optional

Date when the application offering will stop getting support from upstream project

string
version
Required
Constraints: maxLength: 64

A text identifier for the specific upstream software released

string
revision
Required
Constraints: maxLength: 64

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

string As date-time As date-time
released_at
Required

The date-time which the release was finished at

string
packaging_type
Optional

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

artifact
Required

artifact

object
latest_release
Optional

Information of latest release

object
product
Optional

It contains information about the software offered

array of object
platforms
Optional

The platform family an artifact was for

array of object
platform_release_metadata
Optional

Collection of release metadata. It can be related with a specific platform (e.g containers, virtual machines) or not (e.g chart metadata or common container metadata)

base_image
Optional

It contains information about the base image used for an application

object
registry
Optional

Registry where the artifacts of an application release are pushed to

string
catalog_id
Optional

Identifier of the catalog

string
application_id
Optional

Identifier of the application

array of object
customizations
Optional

It contains information about a customization in a catalog

string
pipeline_id
Optional

Identifier of the pipeline

array of Release
dependencies
Optional

Embebbed releases of the dependencies of the release. For example, for a Helm Chart release, the containers or the subcharts. Only informed when requesting a release by id with the expand_relationships=true query param.

array of Release
dependants
Optional

Embebbed releases of the dependants of the release. For example, for a container release, the Helm Charts that use it. Only informed when requesting a release by id with the expand_relationships=true query param.

boolean
trial
Optional

If this is a release of a trial application. Only in the context of the public catalog

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 releases

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 release cannot be 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}/releases/{release_id}