Get Release
GET/api/v1/catalog/releases/project/:projectIdentifier/version/:version
This service message allows retrieval of a release.
Request
Path Parameters
Project identifier (ID or name)
Header Parameters
Responses
- 200
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
Array [
]
]
metadata
object
Enable automatic deployment of this release
postInstallAction
object
Post-installation action configuration
Possible values: [NONE, WEB, EXE]
Action type: NONE (no action), WEB (open URL), or EXE (run executable)
URL to open (required when type is WEB)
Executable path to run (required when type is EXE)
Installation size in bytes - disk space required after installation (user-specified)
Total size in bytes - automatically calculated as installationSize + artifactsSize
Hide this release from agents if the health check URL is not healthy
URL to check for health status. Required when hideIfNotHealthy is true.
Interval in seconds between health check requests. Required when healthCheckUrl is set.
Possible values: [draft, in_review, approved, released, archived, error]
draft: Release is still being prepared.
in_review: Submitted for review, not yet approved.
approved: Approved but not yet released.
released: Actively released and deployable.
archived: No longer active.
error: Release was previously released but one or more artifacts are missing from storage. Requires a user with edit-released-release permission to resolve.
Total number of required regulations
Total number of compliant regulations
Indicates if this release was imported from another system
Indicates if this release is read-only. A release is read-only when its status is released or error and the current user does not have the edit-released-release permission.
artifacts
object[]
Possible values: [file, docker_image, rpm, deb]
Default value: false
Possible values: [uploaded, pending, uploading, removed, error]
Possible values: <= 100
Upload/download progress percentage (0-100). Check status field for errors.
Error message when status indicates an error
SHA256 hash of the file
Default value: true
Whether SBOM scan is enabled for this artifact
SBOM scan ID associated with this artifact
Package version for RPM/DEB artifact types (e.g. "1.2.3-4")
dependencies
object[]
metadata
object
Enable automatic deployment of this release
postInstallAction
object
Post-installation action configuration
Possible values: [NONE, WEB, EXE]
Action type: NONE (no action), WEB (open URL), or EXE (run executable)
URL to open (required when type is WEB)
Executable path to run (required when type is EXE)
Installation size in bytes - disk space required after installation (user-specified)
Total size in bytes - automatically calculated as installationSize + artifactsSize
Hide this release from agents if the health check URL is not healthy
URL to check for health status. Required when hideIfNotHealthy is true.
Interval in seconds between health check requests. Required when healthCheckUrl is set.
Possible values: [draft, in_review, approved, released, archived, error]
draft: Release is still being prepared.
in_review: Submitted for review, not yet approved.
approved: Approved but not yet released.
released: Actively released and deployable.
archived: No longer active.
error: Release was previously released but one or more artifacts are missing from storage. Requires a user with edit-released-release permission to resolve.
Total number of required regulations
Total number of compliant regulations
Indicates if this release was imported from another system
Indicates if this release is read-only. A release is read-only when its status is released or error and the current user does not have the edit-released-release permission.
policies
object[]
Policies associated with this release
Policy rule ID
Policy name
Policy description
Possible values: [policy, restriction]
Policy type
association
object
releases
object[]
required
Releases for this policy
Project ID
Project name
Release version
Policy version number
Policy creation timestamp
Policy last update timestamp
Whether the policy is active
Default value: false
Whether this policy should be pushed to agents
The policy rule definition conforming to rule engine schema
{
"id": "string",
"version": "string",
"projectName": "string",
"projectId": 0,
"name": "string",
"releaseNotes": "string",
"metadata": {
"autoDeploy": true,
"postInstallAction": {
"type": "NONE",
"url": "string",
"exePath": "string"
},
"installationSize": 0,
"totalSize": 0,
"hideIfNotHealthy": true,
"healthCheckUrl": "string",
"healthCheckIntervalSeconds": 0
},
"status": "draft",
"createdAt": "2026-06-22T12:47:52.252Z",
"updatedAt": "2026-06-22T12:47:52.252Z",
"requiredRegulationsCount": 0,
"compliantRegulationsCount": 0,
"latest": true,
"releasedAt": "2026-06-22T12:47:52.252Z",
"createdBy": "string",
"updatedBy": "string",
"isImported": true,
"readonly": true,
"artifacts": [
{
"id": 0,
"artifactName": "string",
"type": "file",
"metadata": {},
"isInstallationFile": true,
"dockerImageUrl": "string",
"isExecutable": false,
"arguments": {},
"uploadId": 0,
"status": "uploaded",
"size": 0,
"progress": 0,
"error": "string",
"sha256": "string",
"enableSbomScan": true,
"sbomScanId": "string",
"packageVersion": "string"
}
],
"dependencies": [
{
"id": "string",
"version": "string",
"projectName": "string",
"projectId": 0,
"name": "string",
"releaseNotes": "string",
"metadata": {
"autoDeploy": true,
"postInstallAction": {
"type": "NONE",
"url": "string",
"exePath": "string"
},
"installationSize": 0,
"totalSize": 0,
"hideIfNotHealthy": true,
"healthCheckUrl": "string",
"healthCheckIntervalSeconds": 0
},
"status": "draft",
"createdAt": "2026-06-22T12:47:52.253Z",
"updatedAt": "2026-06-22T12:47:52.253Z",
"requiredRegulationsCount": 0,
"compliantRegulationsCount": 0,
"latest": true,
"releasedAt": "2026-06-22T12:47:52.253Z",
"createdBy": "string",
"updatedBy": "string",
"isImported": true,
"readonly": true
}
],
"policies": [
{
"id": "string",
"name": "string",
"description": "string",
"type": "policy",
"association": {
"releases": [
{
"projectId": "string",
"projectName": "string",
"version": "string"
}
]
},
"version": 0,
"createdAt": "string",
"updatedAt": "string",
"isActive": true,
"isPush": false,
"rule": {}
}
]
}