Skip to main content

Release Planner API

API endpoints for Release Planner functionality.

Export Release Planner Data​

Export releases in Release Planner format.

GET /projects/{projectId}/customer-sites/{customerSiteId}/releases/export

Response​

Returns a JSON file in Release Planner format:

{
  "name": "Release Planner",
  "version": "R1.0",
  "description": "Track and manage your software releases efficiently.",
  "milestone_name": "M1",
  "release_date": "2025-09-30",
  "priority": "high",
  "releases": [
    {
      "name": "Service A",
      "repo_link": "http://github.com/users",
      "tag": "v1.0.0",
      "release_document": "http://example.com/document.pdf",
      "note": "Roll out in wave-1",
      "description": "Core authentication service",
      "deployment_version_url": "https://registry.example.com/auth/chart/1.0.0"
    }
  ]
}

Release Planner Schema​

The Release Planner format follows a standardized schema. See the Release Planner repository for details.