Release Candidates

List active release candidates (excludes finalized)

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier (e.g., flxbl-io/sf-core)

domainstringOptional

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

branchstringOptional

Filter by branch (e.g., main, develop)

limitnumberOptional

Limit results (1-200, default: 50)

offsetnumberOptional

Offset for pagination (default: 0)

statusstringOptional

Filter by status. Statuses: pending, in_progress, aborted. Note: finalized candidates are excluded by default.

Responses

200

List of release candidates

application/json

totalnumberRequired

Total count of release candidates

limitnumberRequired

Number of items returned

offsetnumberRequired

Offset for pagination

400

Bad request

403

Forbidden - Requires role: member, owner, application

get

/sfp/api/release-candidates

HTTPcURLJavaScriptPython

GET /sfp/api/release-candidates?repositoryIdentifier=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "text",
      "repositoryIdentifier": "text",
      "domain": "text",
      "releaseName": "text",
      "commitSha": "text",
      "branch": "text",
      "tag": "text",
      "value": {},
      "version": 1,
      "createdAt": "text",
      "updatedAt": "text",
      "createdBy": "text",
      "updatedBy": "text",
      "status": "pending",
      "statusChangedAt": "text",
      "statusChangedBy": "text"
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

Create or update a release candidate

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

repositoryIdentifierstringRequired

Repository identifier (e.g., "owner/repo")

domainstringRequired

Domain/release configuration name

releaseNamestringRequired

Release name

commitShastringRequired

Git commit SHA

branchstringOptional

Git branch name

tagstringOptional

Git tag

valueobjectRequired

Release definition and metadata

statusobjectOptional

Initial status for the release candidate. Reserved statuses: pending, in_progress, finalized, aborted. Custom statuses are also allowed (e.g., testing, staging).

Default: pendingExample: pending

Responses

201

Release candidate created/updated

application/json

400

Bad request

403

Forbidden - Requires role: member, owner, application

409

Conflict - version mismatch

post

/sfp/api/release-candidates

HTTPcURLJavaScriptPython

POST /sfp/api/release-candidates HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "repositoryIdentifier": "text",
  "domain": "text",
  "releaseName": "text",
  "commitSha": "text",
  "branch": "text",
  "tag": "text",
  "value": {},
  "status": "pending"
}

{
  "id": "text",
  "repositoryIdentifier": "text",
  "domain": "text",
  "releaseName": "text",
  "commitSha": "text",
  "branch": "text",
  "tag": "text",
  "value": {},
  "version": 1,
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "pending",
  "statusChangedAt": "text",
  "statusChangedBy": "text"
}

Get the latest release candidate for a domain

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier (e.g., flxbl-io/sf-core)

domainstringRequired

Domain name (e.g., core, auth, origination)

branchstringOptional

Filter by branch (e.g., main, develop)

Responses

200

Latest release candidate

application/json

idstringRequired

Unique identifier

repositoryIdentifierstringRequired

Repository identifier

domainstringRequired

Domain/release configuration name

releaseNamestringRequired

Release name

commitShastringRequired

Git commit SHA

branchstringOptional

Git branch name

tagstringOptional

Git tag

valueobjectRequired

Release definition and metadata

versionnumberRequired

Version number

createdAtstringRequired

Creation timestamp

updatedAtstringRequired

Last update timestamp

createdBystringRequired

Created by (email or "application")

updatedBystringRequired

Updated by (email or "application")

statusobjectRequired

Release candidate status. Reserved statuses: pending, in_progress, finalized, aborted. Custom statuses are also allowed.

Example: pending

statusChangedAtstringOptional

Timestamp when status was last changed

statusChangedBystringOptional

Who changed the status

403

Forbidden - Requires role: member, owner, application

404

No release candidates found

get

/sfp/api/release-candidates/latest

HTTPcURLJavaScriptPython

GET /sfp/api/release-candidates/latest?repositoryIdentifier=text&domain=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "repositoryIdentifier": "text",
  "domain": "text",
  "releaseName": "text",
  "commitSha": "text",
  "branch": "text",
  "tag": "text",
  "value": {},
  "version": 1,
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "pending",
  "statusChangedAt": "text",
  "statusChangedBy": "text"
}

Get release candidates for a specific commit, grouped by domain

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

commitShastringRequired

Git commit SHA

Query parameters

repositoryIdentifierstringRequired

Repository identifier (e.g., flxbl-io/sf-core)

Responses

200

Release candidates grouped by domain

No content

403

Forbidden - Requires role: member, owner, application

get

/sfp/api/release-candidates/by-commit/{commitSha}

HTTPcURLJavaScriptPython

GET /sfp/api/release-candidates/by-commit/{commitSha}?repositoryIdentifier=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get a specific release candidate

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Release candidate ID

Responses

200

Release candidate details

application/json

idstringRequired

Unique identifier

repositoryIdentifierstringRequired

Repository identifier

domainstringRequired

Domain/release configuration name

releaseNamestringRequired

Release name

commitShastringRequired

Git commit SHA

branchstringOptional

Git branch name

tagstringOptional

Git tag

valueobjectRequired

Release definition and metadata

versionnumberRequired

Version number

createdAtstringRequired

Creation timestamp

updatedAtstringRequired

Last update timestamp

createdBystringRequired

Created by (email or "application")

updatedBystringRequired

Updated by (email or "application")

statusobjectRequired

Release candidate status. Reserved statuses: pending, in_progress, finalized, aborted. Custom statuses are also allowed.

Example: pending

statusChangedAtstringOptional

Timestamp when status was last changed

statusChangedBystringOptional

Who changed the status

403

Forbidden - Requires role: member, owner, application

404

Release candidate not found

get

/sfp/api/release-candidates/{id}

HTTPcURLJavaScriptPython

GET /sfp/api/release-candidates/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "repositoryIdentifier": "text",
  "domain": "text",
  "releaseName": "text",
  "commitSha": "text",
  "branch": "text",
  "tag": "text",
  "value": {},
  "version": 1,
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "pending",
  "statusChangedAt": "text",
  "statusChangedBy": "text"
}

Delete a release candidate

delete

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Release candidate ID

Responses

204

Release candidate deleted

403

Forbidden - Requires role: owner, application

404

Release candidate not found

delete

/sfp/api/release-candidates/{id}

HTTPcURLJavaScriptPython

DELETE /sfp/api/release-candidates/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Compare release candidate with an environment

post

Compares the release candidate packages against packages installed in a registered environment. When includeChangelog=true, computes detailed changelog with commits and work items for changed packages.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Release candidate ID

Query parameters

includeChangelogbooleanOptional

Include detailed changelog with commits and work items (default: false)

Body

application/json

environmentIdstringOptional

Environment ID to compare against

environmentNamestringOptional

Environment name to compare against (alternative to environmentId)

Responses

200

Comparison results

application/json

environmentobjectRequired

Environment being compared against

estimatedDeploymentTimenumberRequired

Estimated deployment time in minutes

changelogobjectOptional

Changelog data if includeChangelog=true was specified

linkedCandidatesobjectRequired

Linked release candidates from other domains (non-finalized only)

403

Forbidden - Requires role: member, owner, application

404

Release candidate or environment not found

post

/sfp/api/release-candidates/{id}/compare

HTTPcURLJavaScriptPython

POST /sfp/api/release-candidates/{id}/compare HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "environmentId": "text",
  "environmentName": "text"
}

{
  "releaseCandidate": {
    "id": "text",
    "repositoryIdentifier": "text",
    "domain": "text",
    "releaseName": "text",
    "commitSha": "text",
    "branch": "text",
    "tag": "text",
    "value": {},
    "version": 1,
    "createdAt": "text",
    "updatedAt": "text",
    "createdBy": "text",
    "updatedBy": "text",
    "status": "pending",
    "statusChangedAt": "text",
    "statusChangedBy": "text"
  },
  "environment": {},
  "comparison": {
    "packagesToInstall": [
      {
        "name": "text",
        "type": "text",
        "isOutOfSync": true,
        "versions": {
          "ANY_ADDITIONAL_PROPERTY": null
        }
      }
    ],
    "packagesToUpdate": [
      {
        "name": "text",
        "type": "text",
        "isOutOfSync": true,
        "versions": {
          "ANY_ADDITIONAL_PROPERTY": null
        }
      }
    ],
    "unchanged": [
      {
        "name": "text",
        "type": "text",
        "isOutOfSync": true,
        "versions": {
          "ANY_ADDITIONAL_PROPERTY": null
        }
      }
    ],
    "totalChanges": 1
  },
  "estimatedDeploymentTime": 1,
  "changelog": {},
  "linkedCandidates": {}
}

Compare release candidate with provided package versions

post

Compares the release candidate packages against a provided set of package versions. Useful for comparing RC against local git state (from artifact tags at a specific ref). When includeChangelog=true, computes detailed changelog with commits and work items for changed packages.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Release candidate ID

Query parameters

includeChangelogbooleanOptional

Include detailed changelog with commits and work items (default: false)

Body

application/json

packagesobjectRequired

Package versions to compare against. Key is package name, value is version.

Example: {"sales-pkg":"1.4.44.10","core-pkg":"2.0.0"}

baseLabelstringOptional

Label for the comparison base (e.g., git ref, environment name)

Example: main

Responses

200

Comparison results

application/json

baseLabelstringRequired

Label for the comparison base

comparisonobjectRequired

Comparison results

changelogobjectOptional

Changelog data if available

linkedCandidatesobjectRequired

Linked release candidates from other domains (non-finalized only)

403

Forbidden - Requires role: member, owner, application

404

Release candidate not found

post

/sfp/api/release-candidates/{id}/compare-to-packages

HTTPcURLJavaScriptPython

POST /sfp/api/release-candidates/{id}/compare-to-packages HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "packages": {
    "sales-pkg": "1.4.44.10",
    "core-pkg": "2.0.0"
  },
  "baseLabel": "main"
}

{
  "releaseCandidate": {
    "id": "text",
    "repositoryIdentifier": "text",
    "domain": "text",
    "releaseName": "text",
    "commitSha": "text",
    "branch": "text",
    "tag": "text",
    "value": {},
    "version": 1,
    "createdAt": "text",
    "updatedAt": "text",
    "createdBy": "text",
    "updatedBy": "text",
    "status": "pending",
    "statusChangedAt": "text",
    "statusChangedBy": "text"
  },
  "baseLabel": "text",
  "comparison": {},
  "changelog": {},
  "linkedCandidates": {}
}

Get change analysis for a release candidate

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Release candidate ID

Query parameters

sincestringOptional

Compare changes since this commit SHA or date

Responses

200

Change analysis

application/json

packagesstring[]Required

Package changes

workItemsstring[]Required

Work items extracted from commits

commitsstring[]Required

Commit information

403

Forbidden - Requires role: member, owner, application

404

Release candidate not found

get

/sfp/api/release-candidates/{id}/changes

HTTPcURLJavaScriptPython

GET /sfp/api/release-candidates/{id}/changes HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "packages": [
    "text"
  ],
  "workItems": [
    "text"
  ],
  "commits": [
    "text"
  ]
}

Update release candidate status

patch

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Release candidate ID

Body

application/json

statusobjectRequired

New status for the release candidate. Reserved statuses: pending, in_progress, finalized, aborted. Custom statuses are also allowed (e.g., testing, staging). Note: aborted and finalized statuses are locked and cannot be changed once set.

Example: pending

Responses

200

Status updated

application/json

idstringRequired

Unique identifier

repositoryIdentifierstringRequired

Repository identifier

domainstringRequired

Domain/release configuration name

releaseNamestringRequired

Release name

commitShastringRequired

Git commit SHA

branchstringOptional

Git branch name

tagstringOptional

Git tag

valueobjectRequired

Release definition and metadata

versionnumberRequired

Version number

createdAtstringRequired

Creation timestamp

updatedAtstringRequired

Last update timestamp

createdBystringRequired

Created by (email or "application")

updatedBystringRequired

Updated by (email or "application")

statusobjectRequired

Release candidate status. Reserved statuses: pending, in_progress, finalized, aborted. Custom statuses are also allowed.

Example: pending

statusChangedAtstringOptional

Timestamp when status was last changed

statusChangedBystringOptional

Who changed the status

403

Forbidden - Requires role: member, owner, application

404

Release candidate not found

patch

/sfp/api/release-candidates/{id}/status

HTTPcURLJavaScriptPython

PATCH /sfp/api/release-candidates/{id}/status HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "status": "pending"
}

{
  "id": "text",
  "repositoryIdentifier": "text",
  "domain": "text",
  "releaseName": "text",
  "commitSha": "text",
  "branch": "text",
  "tag": "text",
  "value": {},
  "version": 1,
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "pending",
  "statusChangedAt": "text",
  "statusChangedBy": "text"
}

Find release candidate by repository, domain, and name

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

repositoryIdentifierstringRequired

Repository identifier

domainstringRequired

Domain name

releaseNamestringRequired

Release name

Responses

200

Release candidate found

application/json

idstringRequired

Unique identifier

repositoryIdentifierstringRequired

Repository identifier

domainstringRequired

Domain/release configuration name

releaseNamestringRequired

Release name

commitShastringRequired

Git commit SHA

branchstringOptional

Git branch name

tagstringOptional

Git tag

valueobjectRequired

Release definition and metadata

versionnumberRequired

Version number

createdAtstringRequired

Creation timestamp

updatedAtstringRequired

Last update timestamp

createdBystringRequired

Created by (email or "application")

updatedBystringRequired

Updated by (email or "application")

statusobjectRequired

Release candidate status. Reserved statuses: pending, in_progress, finalized, aborted. Custom statuses are also allowed.

Example: pending

statusChangedAtstringOptional

Timestamp when status was last changed

statusChangedBystringOptional

Who changed the status

403

Forbidden - Requires role: member, owner, application

404

Release candidate not found

post

/sfp/api/release-candidates/find

HTTPcURLJavaScriptPython

POST /sfp/api/release-candidates/find HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "repositoryIdentifier": "text",
  "domain": "text",
  "releaseName": "text"
}

{
  "id": "text",
  "repositoryIdentifier": "text",
  "domain": "text",
  "releaseName": "text",
  "commitSha": "text",
  "branch": "text",
  "tag": "text",
  "value": {},
  "version": 1,
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "pending",
  "statusChangedAt": "text",
  "statusChangedBy": "text"
}

Update release candidate status by repository, domain, and name

patch

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Status updated

application/json

idstringRequired

Unique identifier

repositoryIdentifierstringRequired

Repository identifier

domainstringRequired

Domain/release configuration name

releaseNamestringRequired

Release name

commitShastringRequired

Git commit SHA

branchstringOptional

Git branch name

tagstringOptional

Git tag

valueobjectRequired

Release definition and metadata

versionnumberRequired

Version number

createdAtstringRequired

Creation timestamp

updatedAtstringRequired

Last update timestamp

createdBystringRequired

Created by (email or "application")

updatedBystringRequired

Updated by (email or "application")

statusobjectRequired

Release candidate status. Reserved statuses: pending, in_progress, finalized, aborted. Custom statuses are also allowed.

Example: pending

statusChangedAtstringOptional

Timestamp when status was last changed

statusChangedBystringOptional

Who changed the status

403

Forbidden - Requires role: member, owner, application

404

Release candidate not found

patch

/sfp/api/release-candidates/status-by-name

HTTPcURLJavaScriptPython

PATCH /sfp/api/release-candidates/status-by-name HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "repositoryIdentifier": "text",
  "domain": "text",
  "releaseName": "text",
  "commitSha": "text",
  "branch": "text",
  "tag": "text",
  "value": {},
  "version": 1,
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "pending",
  "statusChangedAt": "text",
  "statusChangedBy": "text"
}

Abort a release candidate

post

Marks a release candidate as aborted. Once aborted, the release candidate's status cannot be changed. Note: Finalized release candidates cannot be aborted.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

repositoryIdentifierstringRequired

Repository identifier

domainstringRequired

Domain name

releaseNamestringRequired

Release name

reasonstringOptional

Reason for aborting the release candidate

Responses

200

Release candidate aborted

application/json

idstringRequired

Unique identifier

repositoryIdentifierstringRequired

Repository identifier

domainstringRequired

Domain/release configuration name

releaseNamestringRequired

Release name

commitShastringRequired

Git commit SHA

branchstringOptional

Git branch name

tagstringOptional

Git tag

valueobjectRequired

Release definition and metadata

versionnumberRequired

Version number

createdAtstringRequired

Creation timestamp

updatedAtstringRequired

Last update timestamp

createdBystringRequired

Created by (email or "application")

updatedBystringRequired

Updated by (email or "application")

statusobjectRequired

Release candidate status. Reserved statuses: pending, in_progress, finalized, aborted. Custom statuses are also allowed.

Example: pending

statusChangedAtstringOptional

Timestamp when status was last changed

statusChangedBystringOptional

Who changed the status

400

Cannot abort (already finalized)

403

Forbidden - Requires role: member, owner, application

404

Release candidate not found

post

/sfp/api/release-candidates/abort

HTTPcURLJavaScriptPython

POST /sfp/api/release-candidates/abort HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "repositoryIdentifier": "text",
  "domain": "text",
  "releaseName": "text",
  "reason": "text"
}

{
  "id": "text",
  "repositoryIdentifier": "text",
  "domain": "text",
  "releaseName": "text",
  "commitSha": "text",
  "branch": "text",
  "tag": "text",
  "value": {},
  "version": 1,
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "pending",
  "statusChangedAt": "text",
  "statusChangedBy": "text"
}

Update packages in a release candidate

patch

Allows excluding packages from a release candidate or overriding their versions. Note: Cannot update release candidates with locked statuses (finalized, aborted).

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

repositoryIdentifierstringRequired

Repository identifier

domainstringRequired

Domain name

releaseNamestringRequired

Release name

excludePackagesstring[]Optional

Package names to exclude from the release candidate

Example: ["package-a","package-b"]

overrideVersionsobjectOptional

Package versions to override. Key is package name, value is new version.

Example: {"package-a":"1.2.3","package-b":"2.0.0"}

Responses

200

Release candidate updated

application/json

idstringRequired

Unique identifier

repositoryIdentifierstringRequired

Repository identifier

domainstringRequired

Domain/release configuration name

releaseNamestringRequired

Release name

commitShastringRequired

Git commit SHA

branchstringOptional

Git branch name

tagstringOptional

Git tag

valueobjectRequired

Release definition and metadata

versionnumberRequired

Version number

createdAtstringRequired

Creation timestamp

updatedAtstringRequired

Last update timestamp

createdBystringRequired

Created by (email or "application")

updatedBystringRequired

Updated by (email or "application")

statusobjectRequired

Release candidate status. Reserved statuses: pending, in_progress, finalized, aborted. Custom statuses are also allowed.

Example: pending

statusChangedAtstringOptional

Timestamp when status was last changed

statusChangedBystringOptional

Who changed the status

400

Cannot update (status locked or invalid packages)

403

Forbidden - Requires role: member, owner, application

404

Release candidate not found

409

Conflict - concurrent modification

patch

/sfp/api/release-candidates/update-packages

HTTPcURLJavaScriptPython

PATCH /sfp/api/release-candidates/update-packages HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "repositoryIdentifier": "text",
  "domain": "text",
  "releaseName": "text",
  "excludePackages": [
    "package-a",
    "package-b"
  ],
  "overrideVersions": {
    "package-a": "1.2.3",
    "package-b": "2.0.0"
  }
}

{
  "id": "text",
  "repositoryIdentifier": "text",
  "domain": "text",
  "releaseName": "text",
  "commitSha": "text",
  "branch": "text",
  "tag": "text",
  "value": {},
  "version": 1,
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "pending",
  "statusChangedAt": "text",
  "statusChangedBy": "text"
}

Notify release candidate of a deployment event

post

Called when a release is deployed to an environment. This endpoint automatically updates the release candidate status based on the environment category and deployment status: - Only successful deployments (Success) trigger status progression - Any successful deployment → status becomes 'in_progress' (if currently pending) - Auto-finalization occurs only when deployed to ALL release category environments for the domain (if autoReleaseFinalization is enabled in project settings)

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

repositoryIdentifierstringRequired

Repository identifier (e.g., "owner/repo")

domainstringRequired

Domain/release configuration name

releaseNamestringRequired

Release name that was deployed

environmentNamestringRequired

Environment name where the release was deployed

deploymentStatusstring · enumOptional

Deployment status: Success, PartialSuccess, or Failure. Only successful deployments trigger status progression.

Default: SuccessPossible values:

Responses

200

Release event processed

application/json

updatedbooleanRequired

Whether the release candidate was updated

newStatusobjectOptional

The new status of the release candidate

previousStatusobjectOptional

Previous status before the update

intermediateCandidatesFinalizednumberOptional

Number of intermediate candidates auto-finalized

messagestringOptional

Message explaining what happened

403

Forbidden - Requires role: member, owner, application

404

Release candidate or environment not found

post

/sfp/api/release-candidates/release-event

HTTPcURLJavaScriptPython

POST /sfp/api/release-candidates/release-event HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "repositoryIdentifier": "text",
  "domain": "text",
  "releaseName": "text",
  "environmentName": "text",
  "deploymentStatus": "Success"
}

{
  "updated": true,
  "newStatus": {},
  "previousStatus": {},
  "intermediateCandidatesFinalized": 1,
  "message": "text"
}

Get rolling analysis from baseline to latest candidate

get

Performs comprehensive rolling analysis showing progression from last completed release to latest candidate. Results are cached (TTL configurable via ROLLING_ANALYSIS_CACHE_TTL_SECONDS env var, default 15 minutes).

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

repositorystringRequired

Repository identifier (e.g., flxbl-io/sf-core)

domainstringRequired

Domain name (e.g., core, auth, origination)

Query parameters

branchstringOptional

Filter by branch (e.g., main, develop)

includeChangelogbooleanOptional

Include package changelogs (default: false)

forcebooleanOptional

Bypass cache and fetch fresh data (default: false)

Header parameters

X-Cache-KeystringOptional

Cache key used for this request

X-Cache-StatusstringOptional

HIT if served from cache, MISS if freshly computed

Responses

200

Rolling analysis data

application/json

repositorystringRequired

Repository identifier

domainstringRequired

Domain name

orchestrationOrderstring[]Required

Environment orchestration order

analyzedAtstringRequired

Analysis timestamp

403

Forbidden - Requires role: viewer, member, owner, application

get

/sfp/api/release-candidates/rolling-analysis/{repository}/{domain}

HTTPcURLJavaScriptPython

GET /sfp/api/release-candidates/rolling-analysis/{repository}/{domain} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "repository": "text",
  "domain": "text",
  "baseline": {
    "releaseName": "text",
    "createdAt": "text",
    "completedAt": "text",
    "deployedEnvironments": [
      "text"
    ],
    "packages": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "orchestrationOrder": [
    "text"
  ],
  "currentEnvironmentStates": {
    "ANY_ADDITIONAL_PROPERTY": {
      "currentRelease": "text",
      "packages": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  },
  "candidatesByBranch": {
    "byBranch": {
      "ANY_ADDITIONAL_PROPERTY": [
        {
          "id": "text",
          "releaseName": "text",
          "branch": "text",
          "commitSha": "text",
          "createdAt": "text",
          "incrementalChanges": {
            "packages": {
              "added": [
                {
                  "name": "text",
                  "version": "text"
                }
              ],
              "updated": [
                {
                  "name": "text",
                  "fromVersion": "text",
                  "toVersion": "text"
                }
              ],
              "removed": [
                {
                  "name": "text",
                  "version": "text"
                }
              ]
            },
            "summary": {
              "totalPackageChanges": 1,
              "totalCommits": 1,
              "totalWorkItems": 1
            }
          },
          "cumulativeChanges": {
            "packages": {
              "added": [
                {
                  "name": "text",
                  "version": "text"
                }
              ],
              "updated": [
                {
                  "name": "text",
                  "fromVersion": "text",
                  "toVersion": "text"
                }
              ],
              "removed": [
                {
                  "name": "text",
                  "version": "text"
                }
              ]
            },
            "summary": {
              "totalPackageChanges": 1,
              "totalCommits": 1,
              "totalWorkItems": 1
            },
            "cumulativeSummary": {
              "estimatedDeploymentTime": 1
            }
          }
        }
      ]
    },
    "all": [
      {
        "id": "text",
        "releaseName": "text",
        "branch": "text",
        "commitSha": "text",
        "createdAt": "text",
        "incrementalChanges": {
          "packages": {
            "added": [
              {
                "name": "text",
                "version": "text"
              }
            ],
            "updated": [
              {
                "name": "text",
                "fromVersion": "text",
                "toVersion": "text"
              }
            ],
            "removed": [
              {
                "name": "text",
                "version": "text"
              }
            ]
          },
          "summary": {
            "totalPackageChanges": 1,
            "totalCommits": 1,
            "totalWorkItems": 1
          }
        },
        "cumulativeChanges": {
          "packages": {
            "added": [
              {
                "name": "text",
                "version": "text"
              }
            ],
            "updated": [
              {
                "name": "text",
                "fromVersion": "text",
                "toVersion": "text"
              }
            ],
            "removed": [
              {
                "name": "text",
                "version": "text"
              }
            ]
          },
          "summary": {
            "totalPackageChanges": 1,
            "totalCommits": 1,
            "totalWorkItems": 1
          },
          "cumulativeSummary": {
            "estimatedDeploymentTime": 1
          }
        }
      }
    ]
  },
  "summary": {
    "deploymentPipeline": {
      "environmentStatus": [
        {
          "environment": "text",
          "currentRelease": "text",
          "candidatesInQueue": [
            "text"
          ]
        }
      ],
      "blockers": [
        {
          "environment": "text",
          "blockedCandidate": "text",
          "reason": "text"
        }
      ]
    },
    "progressMetrics": {
      "candidatesFullyDeployed": 1,
      "candidatesInProgress": 1,
      "candidatesPending": 1,
      "estimatedTimeToFullDeployment": 1
    },
    "baselineToLatestSummary": {
      "totalCandidates": 1,
      "totalUniqueWorkItems": 1,
      "totalUniqueCommits": 1,
      "packageProgressions": [
        {
          "name": "text",
          "journey": [
            {
              "version": "text",
              "candidateIndex": 1
            }
          ]
        }
      ]
    },
    "branchAnalysis": {
      "mainBranch": "text",
      "featureBranches": [
        {
          "branch": "text",
          "candidateCount": 1,
          "firstCandidate": "text",
          "lastCandidate": "text"
        }
      ]
    }
  },
  "analyzedAt": "text"
}

Get environment-specific progression analysis

get

Analyzes progression for a specific environment including pending candidates

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

repositorystringRequired

Repository identifier (e.g., myorg/myrepo)

domainstringRequired

Domain name

environmentstringRequired

Environment name

Query parameters

includeChangelogbooleanOptional

Include package changelogs

Responses

200

Environment progression analysis

No content

403

Forbidden - Requires role: viewer, member, owner, application

get

/sfp/api/release-candidates/rolling-analysis/{repository}/{domain}/environment/{environment}

HTTPcURLJavaScriptPython

GET /sfp/api/release-candidates/rolling-analysis/{repository}/{domain}/environment/{environment} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Assess deployment risk for next candidate

get

Provides risk assessment for the next deployment to a specific environment

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

repositorystringRequired

Repository identifier (e.g., myorg/myrepo)

domainstringRequired

Domain name

environmentstringRequired

Environment name

Responses

200

Deployment risk assessment

No content

403

Forbidden - Requires role: viewer, member, owner, application

get

/sfp/api/release-candidates/rolling-analysis/{repository}/{domain}/environment/{environment}/risk

HTTPcURLJavaScriptPython

GET /sfp/api/release-candidates/rolling-analysis/{repository}/{domain}/environment/{environment}/risk HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content