Repository

Create a check run for a repository

post

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

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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

Responses

201

The check run has been successfully created

application/json

post

/sfp/api/repository/checks

HTTPcURLJavaScriptPython

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

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

201

The check run has been successfully created

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

Create an issue in a repository

post

Creates a new GitHub issue in the specified repository. Supports setting labels, assignees, and milestones. Useful for automated issue creation from CI/CD pipelines or error tracking systems.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

repositoryIdentifierstringRequired

Repository identifier in the format owner/repo

titlestringRequired

Issue title

bodystringRequired

Issue body/description in markdown format

labelsstring[]Optional

Labels to apply to the issue

assigneesstring[]Optional

GitHub usernames to assign to the issue

milestonestringOptional

Milestone number or title

Responses

201

The issue has been successfully created

application/json

post

/sfp/api/repository/issues

HTTPcURLJavaScriptPython

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

{
  "repositoryIdentifier": "text",
  "title": "text",
  "body": "text",
  "labels": [
    "text"
  ],
  "assignees": [
    "text"
  ],
  "milestone": "text"
}

201

The issue has been successfully created

{
  "id": 1,
  "number": 1,
  "html_url": "text",
  "state": "open",
  "title": "text",
  "body": "text",
  "labels": [
    "text"
  ],
  "assignees": [
    "text"
  ]
}

Update an existing issue

patch

Updates an existing GitHub issue including title, body, state, labels, assignees, and milestone. Can be used to close issues, update their status, or modify metadata. Only the fields provided in the request body will be updated.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

issue_numbernumberRequired

Body

application/json

repositoryIdentifierstringRequired

Repository identifier in the format owner/repo

titlestringOptional

New title for the issue

bodystringOptional

New body/description in markdown format

statestring · enumOptional

New state for the issue

Possible values:

labelsstring[]Optional

New labels for the issue

assigneesstring[]Optional

GitHub usernames to assign to the issue

milestonestringOptional

New milestone number or title

Responses

200

The issue has been successfully updated

application/json

patch

/sfp/api/repository/issues/{issue_number}

HTTPcURLJavaScriptPython

PATCH /sfp/api/repository/issues/{issue_number} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "repositoryIdentifier": "text",
  "title": "text",
  "body": "text",
  "state": "open",
  "labels": [
    "text"
  ],
  "assignees": [
    "text"
  ],
  "milestone": "text"
}

200

The issue has been successfully updated

{
  "id": 1,
  "number": 1,
  "html_url": "text",
  "state": "open",
  "title": "text",
  "body": "text",
  "labels": [
    "text"
  ],
  "assignees": [
    "text"
  ]
}

Close an issue

post

Closes a GitHub issue with an optional comment. This is a convenience endpoint that updates the issue state to closed and optionally adds a closing comment in a single operation.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

issue_numbernumberRequired

Body

application/json

repositoryIdentifierstringRequired

Repository identifier in the format owner/repo

commentstringOptional

Optional comment to add when closing the issue

Responses

200

The issue has been successfully closed

application/json

post

/sfp/api/repository/issues/{issue_number}/close

HTTPcURLJavaScriptPython

POST /sfp/api/repository/issues/{issue_number}/close HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "repositoryIdentifier": "text",
  "comment": "text"
}

200

The issue has been successfully closed

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

List open pull requests in a repository

get

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

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

usernamestringOptional

Filter pull requests by GitHub 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

get

/sfp/api/repository/pull-requests

HTTPcURLJavaScriptPython

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

200

List of pull requests

[]

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

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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

Responses

201

The pull request has been successfully created

application/json

post

/sfp/api/repository/pull-requests

HTTPcURLJavaScriptPython

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

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

201

The pull request has been successfully created

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

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

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pull_numbernumberRequired

Body

application/json

repositoryIdentifierstringRequired

Repository identifier in the format owner/repo

Example: flxbl-io/sf-core

Responses

200

The pull request has been successfully closed

application/json

patch

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

HTTPcURLJavaScriptPython

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

200

The pull request has been successfully closed

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

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

pull_numbernumberRequired

Body

application/json

repositoryIdentifierstringRequired

Repository identifier in the format owner/repo

Example: flxbl-io/sf-core

Responses

200

The pull request has been successfully reopened

application/json

patch

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

HTTPcURLJavaScriptPython

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

200

The pull request has been successfully reopened

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

Generate an authentication token for a specific repository

get

Generates a scoped authentication token that is only valid for the specified repository. For GitHub, this returns an installation token scoped to the repository. The token is cached for 50 minutes to avoid unnecessary API calls. For other providers, returns appropriate authentication tokens. This endpoint requires an application token and the repository must be registered as a project.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core

Responses

200

Authentication token generated successfully

application/json

403

Forbidden - User authentication not allowed, application token required

404

Repository not found or not registered as a project

get

/sfp/api/repository/auth-token

HTTPcURLJavaScriptPython

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

{
  "token": "text",
  "expiresAt": "2026-02-05T09:29:09.318Z",
  "type": "installation",
  "provider": "github",
  "scope": "text"
}