Skip to main content

Releases API

API endpoints for managing releases.

List Releases​

Get all releases for a product.

GET /projects/{projectId}/products/{productId}/releases

Query Parameters​

  • skip (integer): Number of records to skip (default: 0)
  • size (integer): Number of records per page (default: 50)
  • name (string): Filter by release name
  • status (string): Filter by status
  • version (string): Filter by version

Response​

{
  "result": [
    {
      "_id": "release-id",
      "name": "Release Name",
      "version": "1.0.0",
      "status": "created",
      "plannedReleaseDate": "2025-09-30",
      "productId": "product-id"
    }
  ],
  "totalCount": 10
}

Create Release​

Create a new release.

POST /projects/{projectId}/products/{productId}/releases

Request Body​

{
  "name": "Release Name",
  "version": "1.0.0",
  "description": "Release description",
  "plannedReleaseDate": "2025-09-30",
  "status": "created"
}

Response​

{
  "_id": "release-id",
  "name": "Release Name",
  "version": "1.0.0",
  "status": "created"
}

Get Release​

Get a specific release.

GET /projects/{projectId}/products/{productId}/releases/{releaseId}

Response​

{
  "_id": "release-id",
  "name": "Release Name",
  "version": "1.0.0",
  "status": "created",
  "plannedReleaseDate": "2025-09-30"
}

Update Release​

Update a release.

PATCH /projects/{projectId}/products/{productId}/releases/{releaseId}

Request Body​

{
  "name": "Updated Name",
  "status": "in-progress"
}

Delete Release​

Delete a release.

DELETE /projects/{projectId}/products/{productId}/releases/{releaseId}