Docs
flxbl.ioStatusContact us
codevsfp CLIsfp serverlibraries

Packages

sfp server API reference for Packages: 9 endpoints.

Get all packages in a repository with latest versions

GET/sfp/api/packages/{repoId}/packages

Retrieves a summary of all packages in a repository, showing the latest version of each package along with version counts and metadata.

Authorization

access-token
AuthorizationBearer <token>

In: header

Path Parameters

repoId*string

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

Response Body

application/json

curl -X GET "https://example.com/sfp/api/packages/flxbl-io/sf-core/packages"
{  "packages": [    {      "packageName": "string",      "latestVersion": "string",      "latestPublishedAt": "string",      "latestBuildStatus": "string",      "latestStage": "string",      "totalVersions": 0    }  ],  "totalPackages": 0,  "repoId": "string"}

Get the latest package artifact

GET/sfp/api/packages/{repoId}/{packageName}/artifacts/latest

Retrieves the most recent version of a package artifact based on the published timestamp.

Authorization

access-token
AuthorizationBearer <token>

In: header

Path Parameters

repoId*string

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

packageName*string

Package name

Response Body

application/json

curl -X GET "https://example.com/sfp/api/packages/flxbl-io/sf-core/core-package/artifacts/latest"
{  "packageName": "string",  "package_version_number": "string",  "package_type": "string",  "stage": "Build",  "publishedAt": "string",  "repoIdentifier": "string",  "buildStatus": {    "commitId": "string",    "commitMessage": "string",    "commitAuthor": "string",    "commitDate": "string",    "commitTimestamp": 0,    "ciInfo": {      "service": "string",      "name": "string",      "buildUrl": "string",      "buildNumber": "string",      "job": "string",      "branch": "string",      "isPr": true,      "prNumber": "string"    },    "domains": {},    "skipReason": "string",    "workflowStatus": {},    "firstSeenAt": "string",    "lastUpdatedAt": "string"  },  "deployments": [    {      "targetOrg": "string",      "deployedAt": "string",      "deploymentStatus": "success",      "deploymentDuration": 0,      "deploymentMode": "string",      "stage": "string",      "deployedBy": "string",      "errorMessage": "string",      "subscriberVersionId": "string",      "commitId": "string",      "packageType": "string"    }  ],  "sourceVersion": "string",  "package_version_id": "string",  "metadataCount": 0,  "isApexFound": true,  "isProfilesFound": true,  "test_coverage": 0,  "has_passed_coverage_check": true,  "sfpPackage": {}}

Query package artifacts by criteria

GET/sfp/api/packages/{repoId}/{packageName}/artifacts/query

Search for package artifacts using multiple filter criteria. Returns an array of matching artifacts.

Authorization

access-token
AuthorizationBearer <token>

In: header

Path Parameters

repoId*string

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

packageName*string

Package name

Query Parameters

stage?string

Filter by package stage

Value in

  • "Build"
  • "Published"
status?string

Filter by build status

Value in

  • "building"
  • "success"
  • "failed"
domain?string

Filter by domain

limit?number

Number of results to return

Range1 <= value <= 100
Default20
offset?number

Number of results to skip

Range0 <= value
Default0
sortBy?string

Field to sort by

Default"publishedAt"

Value in

  • "version"
  • "publishedAt"
  • "buildNumber"
sortOrder?string

Sort order

Default"desc"

Value in

  • "asc"
  • "desc"

Response Body

application/json

curl -X GET "https://example.com/sfp/api/packages/flxbl-io/sf-core/core-package/artifacts/query"
[  {    "packageName": "string",    "package_version_number": "string",    "package_type": "string",    "stage": "Build",    "publishedAt": "string",    "repoIdentifier": "string",    "buildStatus": {      "commitId": "string",      "commitMessage": "string",      "commitAuthor": "string",      "commitDate": "string",      "commitTimestamp": 0,      "ciInfo": {        "service": "string",        "name": "string",        "buildUrl": "string",        "buildNumber": "string",        "job": "string",        "branch": "string",        "isPr": true,        "prNumber": "string"      },      "domains": {},      "skipReason": "string",      "workflowStatus": {},      "firstSeenAt": "string",      "lastUpdatedAt": "string"    },    "deployments": [      {        "targetOrg": "string",        "deployedAt": "string",        "deploymentStatus": "success",        "deploymentDuration": 0,        "deploymentMode": "string",        "stage": "string",        "deployedBy": "string",        "errorMessage": "string",        "subscriberVersionId": "string",        "commitId": "string",        "packageType": "string"      }    ],    "sourceVersion": "string",    "package_version_id": "string",    "metadataCount": 0,    "isApexFound": true,    "isProfilesFound": true,    "test_coverage": 0,    "has_passed_coverage_check": true,    "sfpPackage": {}  }]

Get a specific package artifact by version

GET/sfp/api/packages/{repoId}/{packageName}/artifacts/{version}

Retrieves complete metadata for a specific version of a package artifact including build status, deployment history, and all associated metadata.

Authorization

access-token
AuthorizationBearer <token>

In: header

Path Parameters

repoId*string

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

packageName*string

Package name

version*string

Package version number

Response Body

application/json

curl -X GET "https://example.com/sfp/api/packages/flxbl-io/sf-core/core-package/artifacts/1.0.0.123"
{  "packageName": "string",  "package_version_number": "string",  "package_type": "string",  "stage": "Build",  "publishedAt": "string",  "repoIdentifier": "string",  "buildStatus": {    "commitId": "string",    "commitMessage": "string",    "commitAuthor": "string",    "commitDate": "string",    "commitTimestamp": 0,    "ciInfo": {      "service": "string",      "name": "string",      "buildUrl": "string",      "buildNumber": "string",      "job": "string",      "branch": "string",      "isPr": true,      "prNumber": "string"    },    "domains": {},    "skipReason": "string",    "workflowStatus": {},    "firstSeenAt": "string",    "lastUpdatedAt": "string"  },  "deployments": [    {      "targetOrg": "string",      "deployedAt": "string",      "deploymentStatus": "success",      "deploymentDuration": 0,      "deploymentMode": "string",      "stage": "string",      "deployedBy": "string",      "errorMessage": "string",      "subscriberVersionId": "string",      "commitId": "string",      "packageType": "string"    }  ],  "sourceVersion": "string",  "package_version_id": "string",  "metadataCount": 0,  "isApexFound": true,  "isProfilesFound": true,  "test_coverage": 0,  "has_passed_coverage_check": true,  "sfpPackage": {}}

List all package artifacts

GET/sfp/api/packages/{repoId}/{packageName}/artifacts

Retrieves a paginated list of all versions of a package with optional filtering by stage, status, and domain.

Authorization

access-token
AuthorizationBearer <token>

In: header

Path Parameters

repoId*string

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

packageName*string

Package name

Query Parameters

stage?string

Filter by package stage

Value in

  • "Build"
  • "Published"
status?string

Filter by build status

Value in

  • "building"
  • "success"
  • "failed"
domain?string

Filter by domain

limit?number

Number of results to return (1-100)

Range1 <= value <= 100
Default20
offset?number

Number of results to skip

Range0 <= value
Default0
sortBy?string

Field to sort by

Value in

  • "version"
  • "publishedAt"
  • "buildNumber"
sortOrder?string

Sort order

Value in

  • "asc"
  • "desc"

Response Body

application/json

curl -X GET "https://example.com/sfp/api/packages/flxbl-io/sf-core/core-package/artifacts"
{  "artifacts": [    {      "packageName": "string",      "package_version_number": "string",      "package_type": "string",      "stage": "Build",      "publishedAt": "string",      "repoIdentifier": "string",      "buildStatus": {        "commitId": "string",        "commitMessage": "string",        "commitAuthor": "string",        "commitDate": "string",        "commitTimestamp": 0,        "ciInfo": {          "service": "string",          "name": "string",          "buildUrl": "string",          "buildNumber": "string",          "job": "string",          "branch": "string",          "isPr": true,          "prNumber": "string"        },        "domains": {},        "skipReason": "string",        "workflowStatus": {},        "firstSeenAt": "string",        "lastUpdatedAt": "string"      },      "deployments": [        {          "targetOrg": "string",          "deployedAt": "string",          "deploymentStatus": "success",          "deploymentDuration": 0,          "deploymentMode": "string",          "stage": "string",          "deployedBy": "string",          "errorMessage": "string",          "subscriberVersionId": "string",          "commitId": "string",          "packageType": "string"        }      ],      "sourceVersion": "string",      "package_version_id": "string",      "metadataCount": 0,      "isApexFound": true,      "isProfilesFound": true,      "test_coverage": 0,      "has_passed_coverage_check": true,      "sfpPackage": {}    }  ],  "total": 0,  "limit": 0,  "offset": 0,  "hasMore": true}

Get all available versions of a package

GET/sfp/api/packages/{repoId}/{packageName}/versions

Retrieves a list of all available versions for a package with basic metadata.

Authorization

access-token
AuthorizationBearer <token>

In: header

Path Parameters

repoId*string

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

packageName*string

Package name

Response Body

application/json

curl -X GET "https://example.com/sfp/api/packages/flxbl-io/sf-core/core-package/versions"
[  {    "version": "string",    "publishedAt": "string",    "buildStatus": "string",    "stage": "string"  }]

Get changelog diff between two package versions

GET/sfp/api/packages/{repoId}/{packageName}/changelog/diff

Compares two versions of a package and returns the diff including: - List of commits between versions - Extracted work items from commit messages - Summary statistics

    Supports both forward diffs (older to newer) and rollback diffs (newer to older).    Rollback diffs will show removed commits and work items.        Work items are extracted using patterns that match:    - GitHub issues: #123    - JIRA tickets: ABC-123, AB-1234    - Custom patterns: USER-STORY-123, BUG-456, etc.

Authorization

access-token
AuthorizationBearer <token>

In: header

Path Parameters

repoId*string

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

packageName*string

Package name

Query Parameters

from*string

Starting version for comparison

to*string

Ending version for comparison

workItemPatterns?array<unknown>

Custom regex patterns for extracting work items from commit messages. If not provided, uses default patterns.

Response Body

application/json

curl -X GET "https://example.com/sfp/api/packages/flxbl-io/sf-core/core-package/changelog/diff?from=1.0.0.100&to=1.0.0.123"
{  "packageName": "string",  "fromVersion": "string",  "toVersion": "string",  "commits": [    {      "sha": "string",      "message": "string",      "author": "string",      "date": "string"    }  ],  "removedCommits": [    {      "sha": "string",      "message": "string",      "author": "string",      "date": "string"    }  ],  "workItems": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "removedWorkItems": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "isRollback": true,  "summary": {    "totalCommits": 0,    "totalRemovedCommits": 0,    "totalWorkItems": 0,    "totalRemovedWorkItems": 0,    "totalPullRequests": 0,    "totalRemovedPullRequests": 0,    "commitRange": {      "from": "string",      "to": "string",      "direction": "forward"    }  }}

Compare source contents of two package versions

POST/sfp/api/packages/{repoId}/{packageName}/content-diff

Fetches two artifact versions from Verdaccio, extracts them, and generates a file-level diff with unified text diffs for modified files. Returns an execution ID for polling.

Authorization

access-token
AuthorizationBearer <token>

In: header

Path Parameters

repoId*string

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

packageName*string

Package name

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/sfp/api/packages/flxbl-io/sf-core/core-package/content-diff" \  -H "Content-Type: application/json" \  -d '{    "fromVersion": "1.0.0.5",    "toVersion": "1.0.0.8"  }'
{  "id": "string",  "taskType": "string",  "status": "string",  "triggeredAt": "string"}

Get cached content diff between two package versions

GET/sfp/api/packages/{repoId}/{packageName}/content-diff/{fromVersion}/{toVersion}

Retrieves a previously computed content diff result from the dedicated content diffs store.

Authorization

access-token
AuthorizationBearer <token>

In: header

Path Parameters

repoId*string

Repository identifier

packageName*string

Package name

fromVersion*string

Source version

toVersion*string

Target version

Response Body

curl -X GET "https://example.com/sfp/api/packages/flxbl-io/sf-core/core-package/content-diff/1.0.0.5/1.0.0.8"
Empty

Orgs Meta

sfp server API reference for Orgs Meta: 1 endpoint.

Platform AI

sfp server API reference for Platform AI: 5 endpoints.