Get Releases From All Catalogs

Get Releases From All Catalogs

Return a list of releases that match the query params searching in all catalogs for an organization. The id of the organization is fetched from CSP token. One of content digest or repo digest must be sent in the request.

Request
URI
GET
https://{api_host}/v1/releases
COPY
Query Parameters
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
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

List of releases in all catalogs of an organization

Returns Array of Release of type(s) application/json
[
    {
        "id": "64455e6bd3c480fd58546c75",
        "branch": "2",
        "version": "2.6.7",
        "revision": "0",
        "released_at": "2023-03-03T00:59:52.762Z",
        "packaging_type": "HELM_CHART",
        "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"
        },
        "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"
            }
        },
        "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"
                }
            }
        ],
        "supports_customizations": false,
        "dependencies": [
            "Release Object"
        ],
        "dependants": [
            "Release Object"
        ],
        "_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"
            }
        }
    }
]

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

No catalogs found for the organization

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