Releases

Get unified view of releases across environments

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

domainstringOptional

Filter by domain (e.g., core, auth, origination)

releaseNamestringOptional

Filter by specific release name

includeChangelogbooleanOptional

Include changelog information (default: false)

activeOnlybooleanOptional

Only show active releases (default: true)

limitnumberOptional

Number of releases to fetch (1-200, default: 50)

offsetnumberOptional

Offset for pagination (default: 0)

forcebooleanOptional

Force refresh cache (default: false)

skipLockStatusbooleanOptional

Skip fetching lock status for performance (default: true)

Responses

200

List of releases

application/json

repositoryIdentifierstringRequired

Repository identifier

Example: myorg/myrepo

totalCountnumberRequired

Total number of releases found

Example: 10

retrievedAtstringRequired

ISO timestamp when the data was retrieved

Example: 2024-01-15T10:30:00.000Z

filtersobjectOptional

Filter parameters applied

Example: {"domain":"core","includeChangelog":true}

400

Bad request - Invalid repository identifier format

403

Forbidden - Requires role: member, owner, application

404

Repository not found

500

Internal server error

get

/sfp/api/releases

HTTPcURLJavaScriptPython

GET /sfp/api/releases?repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "repositoryIdentifier": "myorg/myrepo",
  "releases": [
    {
      "name": "v1.2.3",
      "domain": "core",
      "environments": [
        {
          "name": "staging",
          "environmentId": "123e4567-e89b-12d3-a456-426614174000",
          "deployedAt": "2024-01-15T10:30:00.000Z",
          "packages": {
            "core": "1.2.3",
            "ui": "2.0.1"
          },
          "packageDetails": [
            {
              "name": "core",
              "version": "1.2.3",
              "skipped": false,
              "status": "Success",
              "versionInOrg": "1.2.2",
              "isLeading": true,
              "error": null,
              "startTime": "2024-01-15T10:30:00.000Z",
              "endTime": "2024-01-15T10:35:00.000Z"
            }
          ],
          "changesFromPrevious": [
            {
              "packageName": "core",
              "fromVersion": "1.2.2",
              "toVersion": "1.2.3",
              "totalCommits": 5,
              "totalWorkItems": 3,
              "totalPullRequests": 2,
              "workItems": {
                "issues": {
                  "JIRA-123": [
                    "abc123",
                    "def456"
                  ],
                  "JIRA-124": [
                    "ghi789"
                  ]
                },
                "pullRequests": {
                  "456": [
                    "abc123"
                  ],
                  "789": [
                    "def456"
                  ]
                },
                "byType": {
                  "jira": {
                    "JIRA-123": [
                      "abc123"
                    ]
                  },
                  "github": {
                    "456": [
                      "def456"
                    ]
                  },
                  "other": {
                    "TASK-789": [
                      "ghi789"
                    ]
                  }
                }
              },
              "commitRange": {
                "from": "abc123",
                "to": "def456"
              }
            }
          ],
          "releaseChangelog": {},
          "orchestrationOrder": 1,
          "metadata": {},
          "deploymentCounts": {
            "deployed": 2,
            "skipped": 36,
            "failed": 0,
            "total": 38
          }
        }
      ],
      "firstDeployedAt": "2024-01-15T10:30:00.000Z",
      "lastDeployedAt": "2024-01-20T15:45:00.000Z",
      "deploymentCount": 4,
      "deploymentStatus": {
        "status": "in_progress",
        "totalPackages": 3,
        "packagesCompleted": [
          "core",
          "ui"
        ],
        "packagesInProgress": [
          "api"
        ],
        "packagesWithIssues": [
          {
            "packageName": "auth",
            "issue": "Package has been rolled back in staging"
          }
        ],
        "missingFromEnvironments": [
          "production"
        ],
        "recommendations": [
          "Consider marking this release as obsolete"
        ]
      },
      "packageStatuses": [
        {
          "packageName": "core",
          "releaseVersion": "1.2.3",
          "isFullyDeployed": false,
          "isAbandoned": false,
          "trajectory": "progressing"
        }
      ],
      "releaseDefinition": {
        "core": "1.2.3",
        "ui": "2.0.1"
      }
    }
  ],
  "totalCount": 10,
  "changelogStats": {
    "uniqueDiffsCalculated": 5,
    "totalEnvironments": 12,
    "cacheHits": 7,
    "processingTimeMs": 250
  },
  "retrievedAt": "2024-01-15T10:30:00.000Z",
  "filters": {
    "domain": "core",
    "includeChangelog": true
  }
}