Repository

Create a check run for a repository

POST/sfp/api/repository/checks

Creates a check run on a commit with optional code annotations. Supports GitHub check runs and Azure DevOps build status. Useful for reporting CI/CD results, code quality checks, or custom validations. Annotations can highlight specific lines in files with issues.

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

Repository identifier in the format owner/repo

sha*string

Commit SHA to create the check for. For PRs, this should be the head commit SHA.

pull_number?number

Pull request number. If provided, the check will be associated with this PR.

title*string

Title of the check run

summary*string

Summary of the check results

text?string

Additional details about the check run

annotations?array<>

List of annotations to add to the check run

details_url?string

Details URL that will appear in the GitHub UI

conclusion?string

Conclusion of the check run. Required when status is completed.

Default"success"

Value in

"success"
"failure"
"neutral"
"cancelled"
"skipped"
"timed_out"
"action_required"

status?string

Status of the check run. Defaults to completed.

Default"completed"

Value in

"in_progress"
"completed"

skip_comment?boolean

Skip posting a rich PR comment (ADO only). Use when the status badge is sufficient.

Defaultfalse

check_category?string

Category of the check (analysis or validation). Used to construct web UI result page URLs.

task_execution_id?string

Flxbl Cloud task execution id of the flow creating this check. When provided and details_url is omitted, the server links the check to that run (…/workflows/runs/) instead of the app homepage.

Response Body

`application/json`

curl -X POST "https://example.com/sfp/api/repository/checks" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "string",    "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",    "title": "sfp Metadata Duplicate Check",    "summary": "string"  }'

{  "id": 0,  "html_url": "string",  "conclusion": "success",  "status": "completed"}

Get PRs merged between two commits

GET/sfp/api/repository/pull-requests/between-commits

Returns full PR metadata (title, author, comments, files, reviewers, labels) for all PRs merged between two commits. Supports GitHub and Azure DevOps.

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

fromCommit*string

toCommit*string

Response Body

curl -X GET "https://example.com/sfp/api/repository/pull-requests/between-commits?repositoryIdentifier=string&fromCommit=string&toCommit=string"

Empty

Update an existing check run (body-based)

PATCH/sfp/api/repository/checks/update

Updates a check run using check_id from the request body. Use this for check IDs that contain special characters (e.g., ADO genre/name format like "sfp/PR Validation").

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

check_id?string

Check run ID. Required when using the body-based PATCH /checks endpoint (e.g., ADO check IDs with slashes).

repositoryIdentifier*string

Repository identifier in the format owner/repo

status*string

Status of the check run

Value in

"in_progress"
"completed"

conclusion?string

Conclusion of the check run. Required when status is completed.

Value in

"success"
"failure"
"neutral"
"cancelled"
"skipped"
"timed_out"
"action_required"

title?string

Updated title of the check run

summary?string

Updated summary of the check results

text?string

Updated details about the check run

sha?string

Commit SHA. Required for Azure DevOps check updates.

pull_number?number

Pull request number. Required for Azure DevOps check updates.

details_url?string

Details URL to include in the check comment (e.g., link to analysis results page)

skip_comment?boolean

Skip posting a rich PR comment (ADO only). Use when the status badge is sufficient.

Defaultfalse

check_category?string

Category of the check (analysis or validation). Used to construct web UI result page URLs.

task_execution_id?string

Flxbl Cloud task execution id of the flow updating this check. When provided and details_url is omitted, the server links the check to that run (…/workflows/runs/).

Response Body

curl -X PATCH "https://example.com/sfp/api/repository/checks/update" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "string",    "status": "completed"  }'

Empty

Update an existing check run

PATCH/sfp/api/repository/checks/{check_id}

Updates the status, conclusion, or output of an existing check run. For check IDs with special characters (slashes, spaces), use PATCH /checks/update instead.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

check_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

check_id?string

Check run ID. Required when using the body-based PATCH /checks endpoint (e.g., ADO check IDs with slashes).

repositoryIdentifier*string

Repository identifier in the format owner/repo

status*string

Status of the check run

Value in

"in_progress"
"completed"

conclusion?string

Conclusion of the check run. Required when status is completed.

Value in

"success"
"failure"
"neutral"
"cancelled"
"skipped"
"timed_out"
"action_required"

title?string

Updated title of the check run

summary?string

Updated summary of the check results

text?string

Updated details about the check run

sha?string

Commit SHA. Required for Azure DevOps check updates.

pull_number?number

Pull request number. Required for Azure DevOps check updates.

details_url?string

Details URL to include in the check comment (e.g., link to analysis results page)

skip_comment?boolean

Skip posting a rich PR comment (ADO only). Use when the status badge is sufficient.

Defaultfalse

check_category?string

Category of the check (analysis or validation). Used to construct web UI result page URLs.

task_execution_id?string

Flxbl Cloud task execution id of the flow updating this check. When provided and details_url is omitted, the server links the check to that run (…/workflows/runs/).

Response Body

`application/json`

curl -X PATCH "https://example.com/sfp/api/repository/checks/string" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "string",    "status": "completed"  }'

{  "id": "string",  "status": "string",  "conclusion": "string"}

Create a pull request in a repository

POST/sfp/api/repository/pull-requests

Creates a new pull request between two branches. Supports draft pull requests. The source branch must have commits ahead of the target branch. Useful for automated PR creation in CI/CD workflows.

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

Repository identifier in the format owner/repo

sourceBranch*string

The source branch containing the changes

targetBranch*string

The target branch to merge changes into

title*string

Title of the pull request

description?string

Description of the pull request in markdown format

draft?boolean

Whether to create as a draft pull request

Defaultfalse

userToken?string

Personal access token to create the PR as a specific user. For GitHub: use a PAT with repo scope. For GitLab: use a PAT with api scope. If omitted, PR is created using the configured app credentials.

Response Body

`application/json`

curl -X POST "https://example.com/sfp/api/repository/pull-requests" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "octocat/Hello-World",    "sourceBranch": "feature-branch",    "targetBranch": "main",    "title": "Add new feature"  }'

{  "id": 0,  "number": 0,  "html_url": "string",  "state": "open",  "title": "string",  "body": "string",  "draft": true}

List open pull requests in a repository

GET/sfp/api/repository/pull-requests

Lists pull requests with optional filtering by username and state. Supports GitHub and Azure DevOps repositories. Supports pagination. Can filter PRs created by or assigned to a specific user. Returns basic PR information including title, state, and branch details.

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo (GitHub) or org/project/repo (Azure DevOps)

username?string

Filter pull requests by username

state?string

State of pull requests to return (default: open)

Value in

"open"
"closed"
"all"

page?number

Page number (1-based, default: 1)

per_page?number

Number of results per page (default: 30, max: 100)

Response Body

`application/json`

curl -X GET "https://example.com/sfp/api/repository/pull-requests?repositoryIdentifier=string"

[  {    "id": 0,    "number": 0,    "html_url": "string",    "state": "open",    "title": "string",    "body": "string",    "user": {      "login": "string"    },    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }]

Update a pull request description

PATCH/sfp/api/repository/pull-requests/{pull_number}/description

Replaces only the pull request description. Draft state, title, branches, and commits are unchanged.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

pull_number*number

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

Repository identifier in the format owner/repo

description*string

Replacement pull request description in markdown format

Response Body

curl -X PATCH "https://example.com/sfp/api/repository/pull-requests/0/description" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "string",    "description": "string"  }'

Empty

Get pull request details

GET/sfp/api/repository/pull-requests/{pull_number}

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

pull_number*number

Query Parameters

repositoryIdentifier*string

Response Body

curl -X GET "https://example.com/sfp/api/repository/pull-requests/0?repositoryIdentifier=string"

Empty

Get PR context including metadata, changed files, and reviews

GET/sfp/api/repository/pull-requests/{pull_number}/context

Returns a provider-agnostic PR context with branch info, commit SHAs, changed files, reviews, and metadata. Works with GitHub, Azure DevOps, and GitLab repositories. Used by sfp analyze to get PR context without needing CI-specific environment variables.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

pull_number*number

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo (GitHub) or org/project/repo (Azure DevOps)

includeChecks?string

Include aggregated CI check status/conclusion for the head commit (extra provider calls; off by default)

Response Body

`application/json`

curl -X GET "https://example.com/sfp/api/repository/pull-requests/0/context?repositoryIdentifier=flxbl-io%2Fsf-core"

{  "prNumber": 0,  "repositoryIdentifier": "string",  "sourceRepositoryIdentifier": "string",  "targetRepositoryIdentifier": "string",  "sameRepository": true,  "sourceBranch": "string",  "targetBranch": "string",  "sourceSha": "string",  "targetSha": "string",  "title": "string",  "body": "string",  "changedFiles": [    "string"  ],  "reviews": [    {      "id": 0,      "user": "string",      "state": "string",      "body": "string",      "submittedAt": "string"    }  ],  "author": "string",  "state": "string",  "merged": true,  "draft": true,  "htmlUrl": "string",  "checkStatus": "string",  "checkConclusion": "string"}

Close a pull request

PATCH/sfp/api/repository/pull-requests/{pull_number}/close

Closes an open pull request without merging. The PR can be reopened later if needed. This action preserves all PR history including comments and reviews.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

pull_number*number

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

Repository identifier in the format owner/repo

Response Body

`application/json`

curl -X PATCH "https://example.com/sfp/api/repository/pull-requests/0/close" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "flxbl-io/sf-core"  }'

{  "id": 0,  "number": 0,  "state": "closed"}

Reopen a pull request

PATCH/sfp/api/repository/pull-requests/{pull_number}/reopen

Reopens a previously closed pull request. The PR must not have been merged. All previous history including comments and reviews is preserved.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

pull_number*number

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

Repository identifier in the format owner/repo

Response Body

`application/json`

curl -X PATCH "https://example.com/sfp/api/repository/pull-requests/0/reopen" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "flxbl-io/sf-core"  }'

{  "id": 0,  "number": 0,  "state": "open"}

Generate an authentication token for a specific repository

GET/sfp/api/repository/auth-token

Generates a scoped authentication token for the specified repository. Supports GitHub (installation tokens via GitHub App or PAT) and Azure DevOps (PAT or Service Principal). The token is cached for 50 minutes to avoid unnecessary API calls. This endpoint requires an application token and the repository must be registered as a project.

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo (GitHub) or org/project/repo (Azure DevOps)

Response Body

`application/json`

curl -X GET "https://example.com/sfp/api/repository/auth-token?repositoryIdentifier=flxbl-io%2Fsf-core"

{  "token": "string",  "expiresAt": "2019-08-24T14:15:22Z",  "type": "installation",  "provider": "github",  "scope": "string"}

Get authenticated clone URL for a repository

GET/sfp/api/repository/clone-url

Returns an HTTPS clone URL with embedded authentication token. Supports GitHub and Azure DevOps repositories. This URL can be used directly with git clone without additional authentication. The token is scoped to the repository and has the same expiration as the auth token (cached for 50 minutes). Useful for automated workflows, CI/CD pipelines, or services like Hatchet that need to clone repositories programmatically.

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo (GitHub) or org/project/repo (Azure DevOps)

Response Body

`application/json`

curl -X GET "https://example.com/sfp/api/repository/clone-url?repositoryIdentifier=flxbl-io%2Fsf-core"

{  "cloneUrl": "https://x-access-token:ghs_xxxxxxxxxxxx@github.com/owner/repo.git",  "expiresAt": "2019-08-24T14:15:22Z",  "type": "installation",  "provider": "github",  "scope": "string"}

Get npmrc configuration for repository

GET/sfp/api/repository/npmrc

Returns authenticated .npmrc file content for npm package registry access. Supports GitHub Packages (via integration), JFrog Artifactory, GitLab Package Registry, and custom npm registries. Content is cached for 50 minutes. Use this endpoint to generate .npmrc files for CI/CD workflows and Hatchet workflows that need to install private npm packages.

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo

scope?string

NPM scope (without @ symbol). If not provided, inferred from repository owner or integration config.

Response Body

`application/json`

curl -X GET "https://example.com/sfp/api/repository/npmrc?repositoryIdentifier=flxbl-io%2Fsf-core"

{  "npmrcContent": "string",  "scope": "string"}

Get domains (release configs) from repository

GET/sfp/api/repository/domains

Downloads a repository snapshot and extracts all domain/release configurations from the config directory. Returns both a simple array of domain names and full release config details. Results are cached for 30 minutes. The config directory location defaults to "config" but can be customized in project configuration.

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo (GitHub) or org/project/repo (Azure DevOps)

branch?string

Git branch name (defaults to "main")

forceRefresh?string

Bypass cache and fetch fresh data

Response Body

`application/json`

curl -X GET "https://example.com/sfp/api/repository/domains?repositoryIdentifier=flxbl-io%2Fsf-core"

{  "domains": [    "sales",    "frameworks",    "integration"  ],  "releaseConfigs": [    {      "name": "sales",      "filePath": "config/sales.yml",      "packages": [        "salespkg",        "sales-unpackaged-pkg"      ],      "config": {        "releaseName": "sales",        "pool": "sales-pool",        "includeOnlyArtifacts": [          "core-crm",          "sales-cloud"        ],        "excludeArtifacts": [],        "dependencyOn": [          "frameworks"        ]      }    }  ]}

Get packages from repository sfdx-project.json

GET/sfp/api/repository/packages

Downloads a repository snapshot and extracts all package information from sfdx-project.json. Returns both a simple array of package names and detailed package metadata including paths, versions, types, and dependencies. Results are cached for 30 minutes.

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo (GitHub) or org/project/repo (Azure DevOps)

branch?string

Git branch name (defaults to "main")

forceRefresh?string

Bypass cache and fetch fresh data

Response Body

`application/json`

curl -X GET "https://example.com/sfp/api/repository/packages?repositoryIdentifier=flxbl-io%2Fsf-core"

{  "packages": [    "core-crm",    "sales-cloud",    "service-cloud"  ],  "packageDetails": [    {      "package": "core-crm",      "path": "src/core-crm",      "versionNumber": "1.0.0.NEXT",      "type": "Unlocked",      "default": true,      "dependencies": [        {          "package": "core-framework",          "versionNumber": "1.0.0.1"        }      ],      "domains": [        "sales",        "frameworks"      ]    }  ]}

List Salesforce metadata component names from a repository tree

GET/sfp/api/repository/metadata/names

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

types*unknown

branch?unknown

Response Body

curl -X GET "https://example.com/sfp/api/repository/metadata/names?repositoryIdentifier=string&types=permissionsets%2Cprofiles%2Cpermissionsetgroups"

Empty

Get issue or pull request details

GET/sfp/api/repository/issues/{issueNumber}

Retrieves details of an issue or pull request including title, body, author, labels, and state. Works with GitHub issues/PRs and Azure DevOps work items/PRs.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

issueNumber*string

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo (GitHub) or org/project/repo (Azure DevOps)

Response Body

`application/json`

curl -X GET "https://example.com/sfp/api/repository/issues/string?repositoryIdentifier=flxbl-io%2Fsf-core"

{  "number": 0,  "title": "string",  "body": "string",  "author": "string",  "state": "string",  "labels": [    "string"  ]}

Add a comment to an issue or pull request

POST/sfp/api/repository/issues/{issueNumber}/comments

Posts a new comment to an issue or pull request. Supports GitHub and Azure DevOps repositories.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

issueNumber*string

Response Body

curl -X POST "https://example.com/sfp/api/repository/issues/string/comments"

Empty

List comments on an issue or pull request

GET/sfp/api/repository/issues/{issueNumber}/comments

Retrieves all comments on an issue or pull request.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

issueNumber*string

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo (GitHub) or org/project/repo (Azure DevOps)

Response Body

`application/json`

curl -X GET "https://example.com/sfp/api/repository/issues/string/comments?repositoryIdentifier=string"

[  {    "id": "string",    "body": "string",    "author": "string",    "createdAt": "2019-08-24T14:15:22Z"  }]

Add a reaction to a comment

POST/sfp/api/repository/issues/{issueNumber}/comments/{commentId}/reactions

Creates a reaction on a specific comment. Supports standard reactions like +1, -1, laugh, confused, heart, hooray, rocket, eyes.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

issueNumber*string

commentId*string

Response Body

curl -X POST "https://example.com/sfp/api/repository/issues/string/comments/string/reactions"

Empty

Edit an existing issue/PR comment in place

PATCH/sfp/api/repository/issues/comments/{commentId}

Updates the body of an existing comment by its provider comment id. Used for sticky comments such as the AI Version Assist directive so re-runs edit one comment instead of posting duplicates.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

commentId*string

Response Body

curl -X PATCH "https://example.com/sfp/api/repository/issues/comments/string"

Empty

Add labels to an issue or pull request

POST/sfp/api/repository/issues/{issueNumber}/labels

Adds one or more labels to an issue or pull request.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

issueNumber*string

Response Body

curl -X POST "https://example.com/sfp/api/repository/issues/string/labels"

Empty

Delete a branch from a repository

DELETE/sfp/api/repository/branches/{branchName}

Deletes the specified branch from the remote repository. Protected branches cannot be deleted.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

branchName*string

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo (GitHub) or org/project/repo (Azure DevOps)

Response Body

curl -X DELETE "https://example.com/sfp/api/repository/branches/string?repositoryIdentifier=flxbl-io%2Fsf-core"

Empty

Remove a label from an issue or pull request

DELETE/sfp/api/repository/issues/{issueNumber}/labels/{label}

Removes a label from an issue or pull request. Works with GitHub and Azure DevOps.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

issueNumber*string

label*string

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo (GitHub) or org/project/repo (Azure DevOps)

Response Body

curl -X DELETE "https://example.com/sfp/api/repository/issues/string/labels/string?repositoryIdentifier=flxbl-io%2Fsf-core"

Empty

Get workspace metadata tree for a repository

GET/sfp/api/repository/workspace-tree

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo

branch?string

Branch name

Default"main"

Response Body

curl -X GET "https://example.com/sfp/api/repository/workspace-tree?repositoryIdentifier=flxbl-io%2Fsf-core"

Empty

Store workspace metadata tree for a repository

POST/sfp/api/repository/workspace-tree

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

Repository identifier in format owner/repo

branch*string

Branch name

nodes*array<any>

Array of workspace tree nodes

metadata?

Additional metadata about the tree build

Response Body

curl -X POST "https://example.com/sfp/api/repository/workspace-tree" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "flxbl-io/sf-core",    "branch": "main",    "nodes": []  }'

Empty

Get the build-payload manifest for a repository branch

GET/sfp/api/repository/workspace-tree/payload

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo

branch?string

Branch name

Default"main"

Response Body

curl -X GET "https://example.com/sfp/api/repository/workspace-tree/payload?repositoryIdentifier=flxbl-io%2Fsf-core"

Empty

Force re-generation of workspace tree

POST/sfp/api/repository/workspace-tree/refresh

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

Repository identifier in format owner/repo

branch?string

Branch name

Default"main"

Response Body

curl -X POST "https://example.com/sfp/api/repository/workspace-tree/refresh" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "flxbl-io/sf-core"  }'

Empty

Get code analysis overlay for workspace tree nodes

GET/sfp/api/repository/workspace-tree/overlays/code-analysis

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo

branch?string

Branch name

Default"main"

nodeId?string

Node ID to scope the overlay to

packageName?string

Package name to scope the overlay to

domain?string

Domain to scope the overlay to

Response Body

curl -X GET "https://example.com/sfp/api/repository/workspace-tree/overlays/code-analysis?repositoryIdentifier=flxbl-io%2Fsf-core"

Empty

Get file content from a repository

GET/sfp/api/repository/workspace-tree/file-content

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo

branch*string

Branch name

filePath*string

File path relative to repository root

Response Body

curl -X GET "https://example.com/sfp/api/repository/workspace-tree/file-content?repositoryIdentifier=flxbl-io%2Fsf-core&branch=main&filePath=src%2Fmain%2Fdefault%2Fclasses%2FMyClass.cls"

Empty

Get package baselines

GET/sfp/api/repository/package-baselines

Get baselines for a specific package, or all packages on a branch if packageName is omitted.

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

Repository identifier

branch*string

Branch name

packageName?string

Package name (omit to get all packages for the branch)

Response Body

curl -X GET "https://example.com/sfp/api/repository/package-baselines?repositoryIdentifier=string&branch=string"

Empty

Create or update a package baseline

PUT/sfp/api/repository/package-baselines

Sets the default baseline and optional per-environment baselines for a package on a branch.

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

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

branch*string

Branch name

packageName*string

Package name

packageType*string

Package type

Value in

"source"
"unlocked"
"data"
"diff"

defaultBaseline*string

Default baseline commit SHA for this package on this branch

defaultVersion?string

Package version from sfdx-project.json at time of baseline creation

environments?

Per-environment baselines

Response Body

curl -X PUT "https://example.com/sfp/api/repository/package-baselines" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "string",    "branch": "string",    "packageName": "string",    "packageType": "source",    "defaultBaseline": "string"  }'

Empty

Manually edit a baseline of a diff package

PATCH/sfp/api/repository/package-baselines/baseline

Overrides the default baseline commit for a diff package on a branch, or — when environmentName is given — that environment's baseline (its recorded deploy metadata is preserved). Only diff packages can be edited — baselines for other package types are advanced by the deployment pipeline.

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

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

branch*string

Branch name

packageName*string

Package name

baseline*string

New baseline commit SHA (full 40-character SHA)

environmentName?string

Environment whose baseline to edit. Omit to edit the default baseline. The environment must already carry a baseline record.

Response Body

curl -X PATCH "https://example.com/sfp/api/repository/package-baselines/baseline" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "string",    "branch": "string",    "packageName": "string",    "baseline": "string"  }'

Empty

Update environment baseline after deployment

PATCH/sfp/api/repository/package-baselines/environments/{environmentName}

Advances the baseline for a specific environment after a successful package deployment.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

environmentName*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

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

branch*string

Branch name

packageName*string

Package name

baseline*string

Commit SHA deployed to this environment

version?string

Package version at time of deploy

Response Body

curl -X PATCH "https://example.com/sfp/api/repository/package-baselines/environments/string" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "string",    "branch": "string",    "packageName": "string",    "baseline": "string"  }'

Empty

Update published version for a package

PATCH/sfp/api/repository/package-baselines/versions

Records the latest published version after a successful build. Tracks version intent and source.

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

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

branch*string

Branch name

packageName*string

Package name

version*string

The version that was just published (e.g., 1.3.0.42)

intent?string

Version intent that produced this version

Value in

"major"
"minor"
"patch"
"none"

intentSource?string

Source of the version intent

Value in

"explicit"
"pr-comment"
"conventional-commit"
"ai"
"default"

commitId?string

Commit SHA that was built/published

Response Body

curl -X PATCH "https://example.com/sfp/api/repository/package-baselines/versions" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "string",    "branch": "string",    "packageName": "string",    "version": "string"  }'

Empty

Atomically allocate next versions for a build

POST/sfp/api/repository/package-baselines/versions/allocate

Reserves the next version per package from the authoritative baseline under optimistic concurrency. Allocations are idempotent per commit and expire after the reservation TTL. Packages without a baseline record are returned as skipped (client falls back to local computation).

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

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

branch*string

Branch name

commitId*string

Commit SHA being built — allocations are idempotent per commit

buildNumber*number

Build number substituted into the 4th version segment

packages*array<>

Packages to allocate versions for

Response Body

`application/json`

curl -X POST "https://example.com/sfp/api/repository/package-baselines/versions/allocate" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "string",    "branch": "string",    "commitId": "string",    "buildNumber": 0,    "packages": [      {        "packageName": "string",        "intent": "major"      }    ]  }'

{  "allocations": [    {      "packageName": "string",      "version": "string",      "base": "string",      "replayed": true,      "intent": "string",      "escalated": true    }  ],  "skipped": [    {      "packageName": "string",      "reason": "string"    }  ]}

Query baseline changelog

GET/sfp/api/repository/package-baselines/changelog

Returns the history of baseline changes, filterable by package, environment, branch, and date range.

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

Repository identifier

packageName?string

Filter by package name

branch?string

Filter by branch

environmentName?string

Filter by environment name

since?string

ISO 8601 start date

until?string

ISO 8601 end date

limit?number

Max results to return

Default50

offset?number

Number of results to skip

Default0

Response Body

curl -X GET "https://example.com/sfp/api/repository/package-baselines/changelog?repositoryIdentifier=string"

Empty

List configuration files of a given type from a repository

GET/sfp/api/repository/configs

Generic endpoint for reading typed config files from a repo. Supported types: access-config.

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

Repository identifier in format owner/repo

type*string

Configuration type to look up

branch?string

Branch name

Default"main"

Response Body

`application/json`

curl -X GET "https://example.com/sfp/api/repository/configs?repositoryIdentifier=flxbl-io%2Fsf-core&type=access-config"

{  "type": "access-config",  "branch": "string",  "entries": [    {      "path": "string",      "data": {}    }  ]}

201application/json

403

200

403

200

403

200application/json

403

201application/json

403

200application/json

403

200

403

200

403

200application/json

403

404

200application/json

403

200application/json

403

200application/json

403

404

200application/json

403

404

200application/json

403

404

200application/json

403

404

200application/json

403

404

200

403

200application/json

403

201

403

200application/json

403

201

403

200

403

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`