Builds
sfp server API reference for Builds: 7 endpoints.
GET
/sfp/api/builds/statusRetrieves the latest build statuses ordered by commit date, with package metadata enriched from the package collection
Authorization
access-token AuthorizationBearer <token>
In: header
Query Parameters
repositoryIdentifier*string
Repository identifier (e.g., owner/repo)
limit?number
Maximum number of builds to return
Range
1 <= value <= 100Default
20offset?number
Offset for pagination
Range
0 <= valueDefault
0domain?string
Filter by specific domain
Response Body
application/json
curl -X GET "https://example.com/sfp/api/builds/status?repositoryIdentifier=flxbl-io%2Fsf-core"{ "builds": [ { "commitId": "string", "commitMessage": "string", "commitAuthor": "string", "commitDate": "string", "commitTimestamp": 0, "ciInfo": { "service": "string", "name": "string", "buildUrl": "string", "buildNumber": "string", "job": "string", "branch": "string", "isPr": true, "prNumber": "string" }, "domains": {}, "skipReason": "string", "workflowStatus": {}, "firstSeenAt": "string", "lastUpdatedAt": "string" } ], "total": 0, "hasMore": true}GET
/sfp/api/builds/branchesAuthorization
access-token AuthorizationBearer <token>
In: header
Query Parameters
repositoryIdentifier*string
Response Body
curl -X GET "https://example.com/sfp/api/builds/branches?repositoryIdentifier=flxbl-io%2Fsf-core"Empty
GET
/sfp/api/builds/commitsAuthorization
access-token AuthorizationBearer <token>
In: header
Query Parameters
repositoryIdentifier*string
branch*string
limit?unknown
Range
1 <= value <= 50Default
30Response Body
application/json
curl -X GET "https://example.com/sfp/api/builds/commits?repositoryIdentifier=flxbl-io%2Fsf-core&branch=release%2FV3"[ { "sha": "string", "message": "string", "authorName": {}, "authoredAt": "2019-08-24T14:15:22Z", "baseRef": {} }]GET
/sfp/api/builds/previewAuthorization
access-token AuthorizationBearer <token>
In: header
Query Parameters
repositoryIdentifier*string
branchName*string
commitId*string
forceBuildDomains?array<string>
forceBuildPackages?array<string>
targetEnvironmentTypes?array<string>
debug?boolean
refreshImpact?string
Value in
- "true"
- "false"
Response Body
application/json
curl -X GET "https://example.com/sfp/api/builds/preview?repositoryIdentifier=flxbl-io%2Fsf-core&branchName=release%2FV3&commitId=c306bc1510cd0518c707ee3889cee54f7ca95c8d"{ "workflowKind": "build-on-merge", "targetScope": "allowed-domains", "plannedTargets": [ "string" ], "cascadeSourceBranch": "string", "excluded": true, "exclusionReason": "string", "dispatchStatus": "available", "existingExecutionId": "string", "existingRun": { "executionId": "exec-123", "status": "failed" }, "impact": { "status": "pending", "previewKey": "string", "jobId": "string", "impactedDomains": [ { "domainName": "string", "impactedPackages": [ "string" ] } ], "computedAt": "string", "message": "string" }}GET
/sfp/api/builds/impact-previewAuthorization
access-token AuthorizationBearer <token>
In: header
Query Parameters
repositoryIdentifier*string
previewKey*string
Response Body
application/json
curl -X GET "https://example.com/sfp/api/builds/impact-preview?repositoryIdentifier=flxbl-io%2Fsf-core&previewKey=v1-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"{ "status": "pending", "previewKey": "string", "jobId": "string", "impactedDomains": [ { "domainName": "string", "impactedPackages": [ "string" ] } ], "computedAt": "string", "message": "string"}POST
/sfp/api/builds/impact-preview/resultsAuthorization
access-token AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "https://example.com/sfp/api/builds/impact-preview/results" \ -H "Content-Type: application/json" \ -d '{ "repositoryIdentifier": "string", "previewKey": "string", "generation": "string", "status": "available", "impactedDomains": [ { "domainName": "string", "impactedPackages": [ "string" ] } ], "computedAt": "string" }'Empty
POST
/sfp/api/builds/runValidates the branch and commit server-side, then re-enters the canonical push pipeline. Existing active or completed builds are returned instead of duplicated.
Authorization
access-token AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/sfp/api/builds/run" \ -H "Content-Type: application/json" \ -d '{ "repositoryIdentifier": "flxbl-io/sf-core", "branchName": "release/V3", "commitId": "c306bc1510cd0518c707ee3889cee54f7ca95c8d" }'{ "outcome": "started", "executionId": "string", "message": "string"}