Get Release

Get Release

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_host}/v1/catalogs/{catalog_id}/releases/{release_id}
COPY
Path Parameters
CatalogId
catalog_id
Required

A string as the identifier of a catalog

ReleaseId
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 
"Release Object"
string
id
Required
Constraints: maxLength: 255

Unique identifier of a release

string
branch
Optional
Constraints: maxLength: 32

Identifier of the branch

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

boolean
supports_customizations
Optional

Whether the release could have customizations or not.

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.

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 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 or release cannot be 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/{release_id}
On This Page
Releases Operations
GET
Get Release
GET
Get Releases
POST
Get Releases By Large Set Values
GET
Get Releases From All Catalogs
POST
Bulk Get Releases From All Catalogs
GET
Get Digests
GET
Get Release Failures