Export Release

GET 
/api/v1/catalog/releases/project/:projectIdentifier/version/:version/export

Exports a release configuration and its associated delivery metadata into a JSON format for backup, migration, or integration purposes.

Request

Path Parameters

projectIdentifier stringrequired

Project identifier (ID or name)

version stringrequired

Header Parameters

X-Project-Token string

Responses

200

Exported release data in JSON format

application/json

Schema

Schema

name stringrequired

Release name

version stringrequired

Release version

tag string

Release tag

createdAt stringrequired

Creation timestamp

project stringrequired

Project identifier

status stringrequired

Release status

releaseNotes string

Release notes

author stringrequired

Author email

metadata objectrequired

Release metadata

artifacts

object[]

required

List of artifacts

Array [

name stringrequired

Artifact file name

size int64required

File size in bytes

sha256 stringrequired

SHA256 hash for integrity verification

downloadUrl stringrequired

Download URL for the artifact

metadata object

Additional metadata

]

dockerImages

object[]

List of docker images

Array [

name stringrequired

Docker image name

imageUrl stringrequired

Docker image URL

metadata object

Additional metadata

]

dependencies

object[]

List of dependencies

Array [

catalogId stringrequired

Dependency catalog ID

name stringrequired

Dependency name

version stringrequired

Dependency version

]

Example (from schema)

{
  "name": "string",
  "version": "string",
  "tag": "string",
  "createdAt": "string",
  "project": "string",
  "status": "string",
  "releaseNotes": "string",
  "author": "string",
  "metadata": {},
  "artifacts": [
    {
      "name": "string",
      "size": 0,
      "sha256": "string",
      "downloadUrl": "string",
      "metadata": {}
    }
  ],
  "dockerImages": [
    {
      "name": "string",
      "imageUrl": "string",
      "metadata": {}
    }
  ],
  "dependencies": [
    {
      "catalogId": "string",
      "name": "string",
      "version": "string"
    }
  ]
}

Loading...