Repository

Create a check run for a repository

post

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

repositoryIdentifierstringRequired

Repository identifier in the format owner/repo

shastringRequired

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

Example: 6dcb09b5b57875f334f61aebed695e2e4193db5e

pull_numbernumberOptional

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

Example: 123

titlestringRequired

Title of the check run

Example: sfp Metadata Duplicate Check

summarystringRequired

Summary of the check results

textstringOptional

Additional details about the check run

details_urlstringOptional

Details URL that will appear in the GitHub UI

Example: https://your-server.com/check-details/123

conclusionstring · enumOptional

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

Default: successExample: successPossible values:

statusstring · enumOptional

Status of the check run. Defaults to completed.

Default: completedExample: completedPossible values:

skip_commentbooleanOptional

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

Default: false

check_categorystringOptional

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

Example: validation

task_execution_idstringOptional

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.

Example: a1b2c3d4-5678-90ab-cdef-1234567890ab

Responses

201

The check run has been successfully created

application/json

idnumberOptional

The check run ID

html_urlstringOptional

URL to view the check run

conclusionstring · enumOptional

The final conclusion of the check

Possible values:

statusstring · enumOptional

The current status of the check

Possible values:

403

Forbidden - Requires role: owner, application

post/sfp/api/repository/checks

POST /sfp/api/repository/checks HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 501

{
  "repositoryIdentifier": "text",
  "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
  "pull_number": 123,
  "title": "sfp Metadata Duplicate Check",
  "summary": "text",
  "text": "text",
  "annotations": [
    {
      "path": "text",
      "start_line": 1,
      "end_line": 1,
      "annotation_level": "warning",
      "message": "text",
      "title": "text"
    }
  ],
  "details_url": "https://your-server.com/check-details/123",
  "conclusion": "success",
  "status": "completed",
  "skip_comment": false,
  "check_category": "validation",
  "task_execution_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab"
}

{
  "id": 1,
  "html_url": "text",
  "conclusion": "success",
  "status": "completed"
}

Get PRs merged between two commits

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

fromCommitstringRequired

toCommitstringRequired

Responses

200

PR metadata returned

No content

403

Forbidden - Requires role: owner, member, application

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

GET /sfp/api/repository/pull-requests/between-commits?repositoryIdentifier=text&fromCommit=text&toCommit=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update an existing check run (body-based)

patch

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").

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

check_idstringOptional

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

Example: sfp/PR Validation

repositoryIdentifierstringRequired

Repository identifier in the format owner/repo

statusstring · enumRequired

Status of the check run

Example: completedPossible values:

conclusionstring · enumOptional

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

Example: successPossible values:

titlestringOptional

Updated title of the check run

summarystringOptional

Updated summary of the check results

textstringOptional

Updated details about the check run

shastringOptional

Commit SHA. Required for Azure DevOps check updates.

Example: 6dcb09b5b57875f334f61aebed695e2e4193db5e

pull_numbernumberOptional

Pull request number. Required for Azure DevOps check updates.

Example: 123

details_urlstringOptional

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

Example: https://your-server.com/project-lifecycle/analysis/34

skip_commentbooleanOptional

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

Default: false

check_categorystringOptional

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

Example: validation

task_execution_idstringOptional

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/).

Example: a1b2c3d4-5678-90ab-cdef-1234567890ab

Responses

200

The check run has been successfully updated

No content

403

Forbidden - Requires role: owner, application

patch/sfp/api/repository/checks/update

PATCH /sfp/api/repository/checks/update HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 399

{
  "check_id": "sfp/PR Validation",
  "repositoryIdentifier": "text",
  "status": "completed",
  "conclusion": "success",
  "title": "text",
  "summary": "text",
  "text": "text",
  "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
  "pull_number": 123,
  "details_url": "https://your-server.com/project-lifecycle/analysis/34",
  "skip_comment": false,
  "check_category": "validation",
  "task_execution_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab"
}

No content

Update an existing check run

patch

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

check_idstringRequired

Body

check_idstringOptional

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

Example: sfp/PR Validation

repositoryIdentifierstringRequired

Repository identifier in the format owner/repo

statusstring · enumRequired

Status of the check run

Example: completedPossible values:

conclusionstring · enumOptional

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

Example: successPossible values:

titlestringOptional

Updated title of the check run

summarystringOptional

Updated summary of the check results

textstringOptional

Updated details about the check run

shastringOptional

Commit SHA. Required for Azure DevOps check updates.

Example: 6dcb09b5b57875f334f61aebed695e2e4193db5e

pull_numbernumberOptional

Pull request number. Required for Azure DevOps check updates.

Example: 123

details_urlstringOptional

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

Example: https://your-server.com/project-lifecycle/analysis/34

skip_commentbooleanOptional

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

Default: false

check_categorystringOptional

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

Example: validation

task_execution_idstringOptional

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/).

Example: a1b2c3d4-5678-90ab-cdef-1234567890ab

Responses

200

The check run has been successfully updated

application/json

idstringOptional

The check run ID

statusstringOptional

The current status of the check

conclusionstringOptional

The conclusion of the check

403

Forbidden - Requires role: owner, application

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

PATCH /sfp/api/repository/checks/{check_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 399

{
  "check_id": "sfp/PR Validation",
  "repositoryIdentifier": "text",
  "status": "completed",
  "conclusion": "success",
  "title": "text",
  "summary": "text",
  "text": "text",
  "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
  "pull_number": 123,
  "details_url": "https://your-server.com/project-lifecycle/analysis/34",
  "skip_comment": false,
  "check_category": "validation",
  "task_execution_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab"
}

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

List open pull requests in a repository

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

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

usernamestringOptional

Filter pull requests by username

statestring · enumOptional

State of pull requests to return (default: open)

Possible values:

pagenumberOptional

Page number (1-based, default: 1)

per_pagenumberOptional

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

Responses

200

List of pull requests

application/json

idnumberOptional

The pull request ID

numbernumberOptional

The pull request number

html_urlstringOptional

URL to view the pull request

statestring · enumOptional

Current state of the pull request

Possible values:

titlestringOptional

Pull request title

bodystringOptional

Pull request description

created_atstring · date-timeOptional

When the pull request was created

updated_atstring · date-timeOptional

When the pull request was last updated

403

Forbidden - Requires role: owner, application

get/sfp/api/repository/pull-requests

GET /sfp/api/repository/pull-requests?repositoryIdentifier=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[]

Create a pull request in a repository

post

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

repositoryIdentifierstringRequired

Repository identifier in the format owner/repo

Example: octocat/Hello-World

sourceBranchstringRequired

The source branch containing the changes

Example: feature-branch

targetBranchstringRequired

The target branch to merge changes into

Example: main

titlestringRequired

Title of the pull request

Example: Add new feature

descriptionstringOptional

Description of the pull request in markdown format

Example: This PR implements the following: - Feature A - Feature B

draftbooleanOptional

Whether to create as a draft pull request

Default: false

userTokenstringOptional

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.

Responses

201

The pull request has been successfully created

application/json

idnumberOptional

The pull request ID

numbernumberOptional

The pull request number

html_urlstringOptional

URL to view the pull request

statestring · enumOptional

Current state of the pull request

Possible values:

titlestringOptional

Pull request title

bodystringOptional

Pull request description

draftbooleanOptional

Whether this is a draft pull request

403

Forbidden - Requires role: owner, application

post/sfp/api/repository/pull-requests

POST /sfp/api/repository/pull-requests HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "repositoryIdentifier": "octocat/Hello-World",
  "sourceBranch": "feature-branch",
  "targetBranch": "main",
  "title": "Add new feature",
  "description": "This PR implements the following:\n- Feature A\n- Feature B",
  "draft": false,
  "userToken": "text"
}

{
  "id": 1,
  "number": 1,
  "html_url": "text",
  "state": "open",
  "title": "text",
  "body": "text",
  "draft": true
}

Get pull request details

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pull_numbernumberRequired

Query parameters

repositoryIdentifierstringRequired

Responses

200

Pull request details

No content

403

Forbidden - Requires role: member, owner, application

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

GET /sfp/api/repository/pull-requests/{pull_number}?repositoryIdentifier=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get PR context including metadata, changed files, and reviews

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pull_numbernumberRequired

Query parameters

repositoryIdentifierstringRequired

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

Example: flxbl-io/sf-core

includeChecksstringOptional

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

Example: false

Responses

200

PR context retrieved successfully

application/json

prNumbernumberRequired

Pull request number

repositoryIdentifierstringRequired

Repository identifier (owner/repo or org/project/repo)

sourceBranchstringRequired

Source branch (head branch)

targetBranchstringRequired

Target branch (base branch)

sourceShastringRequired

Source commit SHA (head commit)

targetShastringRequired

Target commit SHA (base commit)

titlestringRequired

PR title

bodystringOptional

PR description/body

changedFilesstring[]Required

List of files changed in the PR

authorstringOptional

PR author username

statestringOptional

PR state (open, closed, merged)

mergedbooleanOptional

Whether PR is merged

htmlUrlstringOptional

PR HTML URL

checkStatusstringOptional

Aggregated CI check status for the head commit ('completed', 'in_progress', 'queued', 'pending')

checkConclusionstringOptional

Aggregated CI check conclusion for the head commit ('success' when no run failed, else 'failure')

403

Forbidden - Requires role: member, owner, application

404

Pull request not found

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

GET /sfp/api/repository/pull-requests/{pull_number}/context?repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "prNumber": 1,
  "repositoryIdentifier": "text",
  "sourceBranch": "text",
  "targetBranch": "text",
  "sourceSha": "text",
  "targetSha": "text",
  "title": "text",
  "body": "text",
  "changedFiles": [
    "text"
  ],
  "reviews": [
    {
      "id": 1,
      "user": "text",
      "state": "text",
      "body": "text",
      "submittedAt": "text"
    }
  ],
  "author": "text",
  "state": "text",
  "merged": true,
  "htmlUrl": "text",
  "checkStatus": "text",
  "checkConclusion": "text"
}

Close a pull request

patch

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pull_numbernumberRequired

Body

repositoryIdentifierstringRequired

Repository identifier in the format owner/repo

Example: flxbl-io/sf-core

Responses

200

The pull request has been successfully closed

application/json

idnumberOptional

The pull request ID

numbernumberOptional

The pull request number

statestring · enumOptional

Current state of the pull request

Possible values:

403

Forbidden - Requires role: owner, application

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

PATCH /sfp/api/repository/pull-requests/{pull_number}/close HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "repositoryIdentifier": "flxbl-io/sf-core"
}

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

Reopen a pull request

patch

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pull_numbernumberRequired

Body

repositoryIdentifierstringRequired

Repository identifier in the format owner/repo

Example: flxbl-io/sf-core

Responses

200

The pull request has been successfully reopened

application/json

idnumberOptional

The pull request ID

numbernumberOptional

The pull request number

statestring · enumOptional

Current state of the pull request

Possible values:

403

Forbidden - Requires role: owner, application

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

PATCH /sfp/api/repository/pull-requests/{pull_number}/reopen HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "repositoryIdentifier": "flxbl-io/sf-core"
}

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

Generate an authentication token for a specific repository

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

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

Example: flxbl-io/sf-core

Responses

200

Authentication token generated successfully

application/json

tokenstringOptional

The authentication token

expiresAtstring · date-timeOptional

Token expiration time in ISO format

typestring · enumOptional

Type of authentication token

Possible values:

providerstring · enumOptional

Repository provider

Possible values:

scopestringOptional

Repository scope of the token

403

Forbidden - Requires role: application

404

Repository not found or not registered as a project

get/sfp/api/repository/auth-token

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

{
  "token": "text",
  "expiresAt": "2026-07-10T16:51:27.311Z",
  "type": "installation",
  "provider": "github",
  "scope": "text"
}

Get authenticated clone URL for a repository

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

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

Example: flxbl-io/sf-core

Responses

200

Authenticated clone URL generated successfully

application/json

cloneUrlstringOptional

HTTPS clone URL with embedded authentication token

Example: https://x-access-token:ghs_xxxxxxxxxxxx@github.com/owner/repo.git

expiresAtstring · date-timeOptional

Token expiration time in ISO format

typestring · enumOptional

Type of authentication token

Possible values:

providerstring · enumOptional

Repository provider

Possible values:

scopestringOptional

Repository scope of the token

403

Forbidden - Requires role: application

404

Repository not found or not registered as a project

get/sfp/api/repository/clone-url

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

{
  "cloneUrl": "https://x-access-token:ghs_xxxxxxxxxxxx@github.com/owner/repo.git",
  "expiresAt": "2026-07-10T16:51:27.311Z",
  "type": "installation",
  "provider": "github",
  "scope": "text"
}

Get npmrc configuration for repository

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

scopestringOptional

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

Example: flxbl-io

Responses

200

npmrc configuration with content and scope

application/json

npmrcContentstringOptional

The npmrc file content

scopestringOptional

The npm scope used (without @ symbol)

403

Forbidden - Requires role: application

404

Repository not found or not registered as a project, or no integration found

get/sfp/api/repository/npmrc

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

{
  "npmrcContent": "text",
  "scope": "text"
}

Get domains (release configs) from repository

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

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

Example: flxbl-io/sf-core

branchstringOptional

Git branch name (defaults to "main")

Example: develop

forceRefreshstringOptional

Bypass cache and fetch fresh data

Example: true

Responses

200

Domains retrieved successfully

application/json

domainsstring[]Required

Array of domain names

Example: ["sales","frameworks","integration"]

403

Forbidden - Requires role: member, owner, application

404

Repository not found or not registered as a project

get/sfp/api/repository/domains

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

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

Get packages from repository sfdx-project.json

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

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

Example: flxbl-io/sf-core

branchstringOptional

Git branch name (defaults to "main")

Example: develop

forceRefreshstringOptional

Bypass cache and fetch fresh data

Example: true

Responses

200

Packages retrieved successfully

application/json

packagesstring[]Required

Array of package names

Example: ["core-crm","sales-cloud","service-cloud"]

403

Forbidden - Requires role: member, owner, application

404

Repository not found, not registered as a project, or sfdx-project.json not found

get/sfp/api/repository/packages

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

{
  "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"
      ]
    }
  ]
}

Get issue or pull request details

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

issueNumberstringRequired

Query parameters

repositoryIdentifierstringRequired

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

Example: flxbl-io/sf-core

Responses

200

Issue details

application/json

numbernumberOptional

Issue/PR number

titlestringOptional

Issue title

bodystringOptional

Issue body/description

authorstringOptional

Author username

statestringOptional

Current state (open/closed)

labelsstring[]Optional

Labels attached to the issue

403

Forbidden - Requires role: member, owner, application

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

GET /sfp/api/repository/issues/{issueNumber}?repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "number": 1,
  "title": "text",
  "body": "text",
  "author": "text",
  "state": "text",
  "labels": [
    "text"
  ]
}

List comments on an issue or pull request

get

Retrieves all comments on an issue or pull request.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

issueNumberstringRequired

Query parameters

repositoryIdentifierstringRequired

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

Responses

200

List of comments

application/json

idstringOptional

Comment ID

bodystringOptional

Comment body

authorstringOptional

Comment author

createdAtstring · date-timeOptional

When the comment was created

403

Forbidden - Requires role: member, owner, application

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

GET /sfp/api/repository/issues/{issueNumber}/comments?repositoryIdentifier=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[]

Add a comment to an issue or pull request

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

issueNumberstringRequired

Responses

201

Comment created successfully

No content

403

Forbidden - Requires role: owner, application

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

POST /sfp/api/repository/issues/{issueNumber}/comments HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Add a reaction to a comment

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

issueNumberstringRequired

commentIdstringRequired

Responses

201

Reaction created successfully

No content

403

Forbidden - Requires role: owner, application

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

POST /sfp/api/repository/issues/{issueNumber}/comments/{commentId}/reactions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Edit an existing issue/PR comment in place

patch

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

commentIdstringRequired

Responses

200

The comment has been updated

No content

403

Forbidden - Requires role: owner, application

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

PATCH /sfp/api/repository/issues/comments/{commentId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Add labels to an issue or pull request

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

issueNumberstringRequired

Responses

201

Labels added successfully

No content

403

Forbidden - Requires role: owner, application

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

POST /sfp/api/repository/issues/{issueNumber}/labels HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete a branch from a repository

delete

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

branchNamestringRequired

Query parameters

repositoryIdentifierstringRequired

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

Example: flxbl-io/sf-core

Responses

200

Branch deleted successfully

No content

403

Forbidden - Requires role: owner, application

404

Branch not found

422

Branch is protected and cannot be deleted

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

DELETE /sfp/api/repository/branches/{branchName}?repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Remove a label from an issue or pull request

delete

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

issueNumberstringRequired

labelstringRequired

Query parameters

repositoryIdentifierstringRequired

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

Example: flxbl-io/sf-core

Responses

200

Label removed successfully

No content

403

Forbidden - Requires role: owner, application

404

Label not found on the issue

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

DELETE /sfp/api/repository/issues/{issueNumber}/labels/{label}?repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get workspace metadata tree for a repository

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

branchstringOptional

Branch name

Default: mainExample: main

Responses

200

Workspace tree retrieved or generation triggered

No content

403

Forbidden - Requires role: member, owner, application

get/sfp/api/repository/workspace-tree

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

No content

Store workspace metadata tree for a repository

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

branchstringRequired

Branch name

Example: main

nodesarrayRequired

Array of workspace tree nodes

metadataobjectOptional

Additional metadata about the tree build

Responses

201

Workspace tree stored successfully

No content

403

Forbidden - Requires role: owner, application

post/sfp/api/repository/workspace-tree

POST /sfp/api/repository/workspace-tree HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "repositoryIdentifier": "flxbl-io/sf-core",
  "branch": "main",
  "nodes": [],
  "metadata": {}
}

No content

Force re-generation of workspace tree

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

branchstringOptional

Branch name

Default: mainExample: main

Responses

200

Workspace tree refresh triggered

No content

403

Forbidden - Requires role: member, owner, application

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

POST /sfp/api/repository/workspace-tree/refresh HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "repositoryIdentifier": "flxbl-io/sf-core",
  "branch": "main"
}

No content

Get code analysis overlay for workspace tree nodes

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

branchstringOptional

Branch name

Default: mainExample: main

nodeIdstringOptional

Node ID to scope the overlay to

Example: item-core-crm-classes-MyClass.cls

packageNamestringOptional

Package name to scope the overlay to

Example: core-crm

domainstringOptional

Domain to scope the overlay to

Example: sales

Responses

200

Code analysis overlay data

No content

403

Forbidden - Requires role: member, owner, application

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

GET /sfp/api/repository/workspace-tree/overlays/code-analysis?repositoryIdentifier=flxbl-io%2Fsf-core HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get file content from a repository

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

branchstringRequired

Branch name

Example: main

filePathstringRequired

File path relative to repository root

Example: src/main/default/classes/MyClass.cls

Responses

200

File content retrieved successfully

No content

403

Forbidden - Requires role: member, owner, application

404

File not found

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

GET /sfp/api/repository/workspace-tree/file-content?repositoryIdentifier=flxbl-io%2Fsf-core&branch=main&filePath=src%2Fmain%2Fdefault%2Fclasses%2FMyClass.cls HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get package baselines

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier

branchstringRequired

Branch name

packageNamestringOptional

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

Responses

200

Package baseline(s) returned

No content

403

Forbidden - Requires role: owner, member, application

get/sfp/api/repository/package-baselines

GET /sfp/api/repository/package-baselines?repositoryIdentifier=text&branch=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create or update a package baseline

put

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

repositoryIdentifierstringRequired

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

branchstringRequired

Branch name

packageNamestringRequired

Package name

packageTypestring · enumRequired

Package type

Possible values:

defaultBaselinestringRequired

Default baseline commit SHA for this package on this branch

defaultVersionstringOptional

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

environmentsobjectOptional

Per-environment baselines

Responses

200

Package baseline created or updated

No content

403

Forbidden - Requires role: owner, application

put/sfp/api/repository/package-baselines

PUT /sfp/api/repository/package-baselines HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "repositoryIdentifier": "text",
  "branch": "text",
  "packageName": "text",
  "packageType": "source",
  "defaultBaseline": "text",
  "defaultVersion": "text",
  "environments": {}
}

No content

Update environment baseline after deployment

patch

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

environmentNamestringRequired

Body

repositoryIdentifierstringRequired

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

branchstringRequired

Branch name

packageNamestringRequired

Package name

baselinestringRequired

Commit SHA deployed to this environment

versionstringOptional

Package version at time of deploy

Responses

200

Environment baseline updated

No content

403

Forbidden - Requires role: owner, application

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

PATCH /sfp/api/repository/package-baselines/environments/{environmentName} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "repositoryIdentifier": "text",
  "branch": "text",
  "packageName": "text",
  "baseline": "text",
  "version": "text"
}

No content

Update published version for a package

patch

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

repositoryIdentifierstringRequired

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

branchstringRequired

Branch name

packageNamestringRequired

Package name

versionstringRequired

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

intentstring · enumOptional

Version intent that produced this version

Possible values:

intentSourcestring · enumOptional

Source of the version intent

Possible values:

commitIdstringOptional

Commit SHA that was built/published

Responses

200

Published version updated

No content

403

Forbidden - Requires role: owner, application

409

Version already published from a different commit (collision)

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

PATCH /sfp/api/repository/package-baselines/versions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "repositoryIdentifier": "text",
  "branch": "text",
  "packageName": "text",
  "version": "text",
  "intent": "major",
  "intentSource": "explicit",
  "commitId": "text"
}

No content

Atomically allocate next versions for a build

post

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).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

repositoryIdentifierstringRequired

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

branchstringRequired

Branch name

commitIdstringRequired

Commit SHA being built — allocations are idempotent per commit

buildNumbernumberRequired

Build number substituted into the 4th version segment

Responses

200

Versions allocated

application/json

403

Forbidden - Requires role: owner, application

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

POST /sfp/api/repository/package-baselines/versions/allocate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 156

{
  "repositoryIdentifier": "text",
  "branch": "text",
  "commitId": "text",
  "buildNumber": 1,
  "packages": [
    {
      "packageName": "text",
      "intent": "major",
      "floorVersion": "text"
    }
  ]
}

{
  "allocations": [
    {
      "packageName": "text",
      "version": "text",
      "base": "text",
      "replayed": true
    }
  ],
  "skipped": [
    {
      "packageName": "text",
      "reason": "text"
    }
  ]
}

Query baseline changelog

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier

packageNamestringOptional

Filter by package name

branchstringOptional

Filter by branch

environmentNamestringOptional

Filter by environment name

sincestringOptional

ISO 8601 start date

untilstringOptional

ISO 8601 end date

limitnumberOptional

Max results to return

Default: 50

offsetnumberOptional

Number of results to skip

Default: 0

Responses

200

Changelog entries returned

No content

403

Forbidden - Requires role: owner, member, application

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

GET /sfp/api/repository/package-baselines/changelog?repositoryIdentifier=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List configuration files of a given type from a repository

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

typestringRequired

Configuration type to look up

Example: access-config

branchstringOptional

Branch name

Default: mainExample: main

Responses

200Success

application/json

typestringRequired

Configuration type that was queried

Example: access-config

branchstringRequired

Branch the configs were read from

403

Forbidden - Requires role: member, owner, application

404

Unsupported config type

get/sfp/api/repository/configs

GET /sfp/api/repository/configs?repositoryIdentifier=flxbl-io%2Fsf-core&type=access-config HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Last updated 2 hours ago

Was this helpful?