Set a Release

POST 
/api/v1/catalog/releases/project/:projectIdentifier

This service message allows creation of a release.

Request

Path Parameters

projectIdentifier stringrequired

Project identifier (ID or name)

Header Parameters

X-Project-Token string

application/json

Body

required

version stringrequired
name string
releaseNotes string
metadata object
isDraft boolean

Default value: true

dependencies string[]

List of dependencies. Providing an empty array will remove all dependencies. Omitting this field or setting it to null will leave dependencies unchanged.

Responses

201

application/json

Schema

Schema

id stringrequired
version stringrequired
projectName stringrequired
projectId number
name stringrequired
releaseNotes stringrequired
metadata objectrequired
status stringrequired

Possible values: [draft, in_review, approved, released, archived]

createdAt date-timerequired
updatedAt date-timerequired
requiredRegulationsCount numberrequired

Total number of required regulations

compliantRegulationsCount numberrequired

Total number of compliant regulations

latest booleanrequired
releasedAt date-time

artifacts

object[]

Array [

id numberrequired

artifactName stringrequired

type stringrequired

Possible values: [file, docker_image]

metadata objectrequired

isInstallationFile booleanrequired

dockerImageUrl string

isExecutable boolean

Default value: false

arguments object

uploadId numberrequired

status string

Possible values: [uploaded, pending, removed]

size int64

]

dependencies

object[]

Array [

id stringrequired

version stringrequired

projectName stringrequired

projectId number

name stringrequired

releaseNotes stringrequired

metadata objectrequired

status stringrequired

Possible values: [draft, in_review, approved, released, archived]

createdAt date-timerequired

updatedAt date-timerequired

requiredRegulationsCount numberrequired

Total number of required regulations

compliantRegulationsCount numberrequired

Total number of compliant regulations

latest booleanrequired

releasedAt date-time

]

Example (from schema)

{
  "id": "string",
  "version": "string",
  "projectName": "string",
  "projectId": 0,
  "name": "string",
  "releaseNotes": "string",
  "metadata": {},
  "status": "draft",
  "createdAt": "2026-01-01T11:09:06.527Z",
  "updatedAt": "2026-01-01T11:09:06.527Z",
  "requiredRegulationsCount": 0,
  "compliantRegulationsCount": 0,
  "latest": true,
  "releasedAt": "2026-01-01T11:09:06.527Z",
  "artifacts": [
    {
      "id": 0,
      "artifactName": "string",
      "type": "file",
      "metadata": {},
      "isInstallationFile": true,
      "dockerImageUrl": "string",
      "isExecutable": false,
      "arguments": {},
      "uploadId": 0,
      "status": "uploaded",
      "size": 0
    }
  ],
  "dependencies": [
    {
      "id": "string",
      "version": "string",
      "projectName": "string",
      "projectId": 0,
      "name": "string",
      "releaseNotes": "string",
      "metadata": {},
      "status": "draft",
      "createdAt": "2026-01-01T11:09:06.528Z",
      "updatedAt": "2026-01-01T11:09:06.528Z",
      "requiredRegulationsCount": 0,
      "compliantRegulationsCount": 0,
      "latest": true,
      "releasedAt": "2026-01-01T11:09:06.528Z"
    }
  ]
}

Loading...