sfopsSlackGitHub

Packages

Get all packages in a repository with latest versions

get

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

Authorizations
Path parameters
repoIdstringRequired

Repository identifier (e.g., "flxbl-io/sfp-pro")

Example: flxbl-io/sfp-pro
Responses
200

Repository packages retrieved successfully

application/json
get
GET /sfp/api/packages/{repoId}/packages HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

Repository packages retrieved successfully

{
  "packages": [
    {
      "packageName": "text",
      "latestVersion": "text",
      "latestPublishedAt": "text",
      "latestBuildStatus": "text",
      "latestStage": "text",
      "totalVersions": 1
    }
  ],
  "totalPackages": 1,
  "repoId": "text"
}

Get the latest package artifact

get

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

Authorizations
Path parameters
repoIdstringRequired

Repository identifier (e.g., "flxbl-io/sfp-pro")

Example: flxbl-io/sfp-pro
packageNamestringRequired

Package name

Example: core-package
Responses
200

Latest package artifact retrieved successfully

application/json
get
GET /sfp/api/packages/{repoId}/{packageName}/artifacts/latest HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "packageName": "text",
  "package_version_number": "text",
  "package_type": "text",
  "stage": "Build",
  "publishedAt": "text",
  "repoIdentifier": "text",
  "buildStatus": {
    "commitId": "text",
    "commitMessage": "text",
    "commitAuthor": "text",
    "commitDate": "text",
    "commitTimestamp": 1,
    "domains": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "firstSeenAt": "text",
    "lastUpdatedAt": "text"
  },
  "deployments": [
    {
      "targetOrg": "text",
      "deployedAt": "text",
      "deploymentStatus": "success",
      "deploymentDuration": 1,
      "deploymentMode": "text",
      "stage": "text",
      "deployedBy": "text",
      "errorMessage": "text",
      "subscriberVersionId": "text",
      "commitId": "text",
      "packageType": "text"
    }
  ],
  "sourceVersion": "text",
  "package_version_id": "text",
  "metadataCount": 1,
  "isApexFound": true,
  "isProfilesFound": true,
  "test_coverage": 1,
  "has_passed_coverage_check": true
}

Query package artifacts by criteria

get

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

Authorizations
Path parameters
repoIdstringRequired

Repository identifier (e.g., "flxbl-io/sfp-pro")

Example: flxbl-io/sfp-pro
packageNamestringRequired

Package name

Example: core-package
Query parameters
stagestring · enumOptional

Filter by package stage

Possible values:
statusstring · enumOptional

Filter by build status

Possible values:
domainstringOptional

Filter by domain

limitnumber · min: 1 · max: 100Optional

Number of results to return

Default: 20
offsetnumberOptional

Number of results to skip

Default: 0
sortBystring · enumOptional

Field to sort by

Default: publishedAtPossible values:
sortOrderstring · enumOptional

Sort order

Default: descPossible values:
Responses
200

Query executed successfully

application/json
get
GET /sfp/api/packages/{repoId}/{packageName}/artifacts/query HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

Query executed successfully

[
  {
    "packageName": "text",
    "package_version_number": "text",
    "package_type": "text",
    "stage": "Build",
    "publishedAt": "text",
    "repoIdentifier": "text",
    "buildStatus": {
      "commitId": "text",
      "commitMessage": "text",
      "commitAuthor": "text",
      "commitDate": "text",
      "commitTimestamp": 1,
      "domains": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "firstSeenAt": "text",
      "lastUpdatedAt": "text"
    },
    "deployments": [
      {
        "targetOrg": "text",
        "deployedAt": "text",
        "deploymentStatus": "success",
        "deploymentDuration": 1,
        "deploymentMode": "text",
        "stage": "text",
        "deployedBy": "text",
        "errorMessage": "text",
        "subscriberVersionId": "text",
        "commitId": "text",
        "packageType": "text"
      }
    ],
    "sourceVersion": "text",
    "package_version_id": "text",
    "metadataCount": 1,
    "isApexFound": true,
    "isProfilesFound": true,
    "test_coverage": 1,
    "has_passed_coverage_check": true
  }
]

Get a specific package artifact by version

get

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

Authorizations
Path parameters
repoIdstringRequired

Repository identifier (e.g., "flxbl-io/sfp-pro")

Example: flxbl-io/sfp-pro
packageNamestringRequired

Package name

Example: core-package
versionstringRequired

Package version number

Example: 1.0.0.123
Responses
200

Package artifact retrieved successfully

application/json
get
GET /sfp/api/packages/{repoId}/{packageName}/artifacts/{version} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "packageName": "text",
  "package_version_number": "text",
  "package_type": "text",
  "stage": "Build",
  "publishedAt": "text",
  "repoIdentifier": "text",
  "buildStatus": {
    "commitId": "text",
    "commitMessage": "text",
    "commitAuthor": "text",
    "commitDate": "text",
    "commitTimestamp": 1,
    "domains": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "firstSeenAt": "text",
    "lastUpdatedAt": "text"
  },
  "deployments": [
    {
      "targetOrg": "text",
      "deployedAt": "text",
      "deploymentStatus": "success",
      "deploymentDuration": 1,
      "deploymentMode": "text",
      "stage": "text",
      "deployedBy": "text",
      "errorMessage": "text",
      "subscriberVersionId": "text",
      "commitId": "text",
      "packageType": "text"
    }
  ],
  "sourceVersion": "text",
  "package_version_id": "text",
  "metadataCount": 1,
  "isApexFound": true,
  "isProfilesFound": true,
  "test_coverage": 1,
  "has_passed_coverage_check": true
}

List all package artifacts

get

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

Authorizations
Path parameters
repoIdstringRequired

Repository identifier (e.g., "flxbl-io/sfp-pro")

Example: flxbl-io/sfp-pro
packageNamestringRequired

Package name

Example: core-package
Query parameters
stagestring · enumOptional

Filter by package stage

Possible values:
statusstring · enumOptional

Filter by build status

Possible values:
domainstringOptional

Filter by domain

limitnumber · min: 1 · max: 100Optional

Number of results to return (1-100)

Default: 20Example: 20
offsetnumberOptional

Number of results to skip

Default: 0Example: 0
sortBystring · enumOptional

Field to sort by

Possible values:
sortOrderstring · enumOptional

Sort order

Possible values:
Responses
200

Package artifacts retrieved successfully

application/json
get
GET /sfp/api/packages/{repoId}/{packageName}/artifacts HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

Package artifacts retrieved successfully

{
  "artifacts": [
    {
      "packageName": "text",
      "package_version_number": "text",
      "package_type": "text",
      "stage": "Build",
      "publishedAt": "text",
      "repoIdentifier": "text",
      "buildStatus": {
        "commitId": "text",
        "commitMessage": "text",
        "commitAuthor": "text",
        "commitDate": "text",
        "commitTimestamp": 1,
        "domains": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "firstSeenAt": "text",
        "lastUpdatedAt": "text"
      },
      "deployments": [
        {
          "targetOrg": "text",
          "deployedAt": "text",
          "deploymentStatus": "success",
          "deploymentDuration": 1,
          "deploymentMode": "text",
          "stage": "text",
          "deployedBy": "text",
          "errorMessage": "text",
          "subscriberVersionId": "text",
          "commitId": "text",
          "packageType": "text"
        }
      ],
      "sourceVersion": "text",
      "package_version_id": "text",
      "metadataCount": 1,
      "isApexFound": true,
      "isProfilesFound": true,
      "test_coverage": 1,
      "has_passed_coverage_check": true
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1,
  "hasMore": true
}

Get all available versions of a package

get

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

Authorizations
Path parameters
repoIdstringRequired

Repository identifier (e.g., "flxbl-io/sfp-pro")

Example: flxbl-io/sfp-pro
packageNamestringRequired

Package name

Example: core-package
Responses
200

Package versions retrieved successfully

application/json
get
GET /sfp/api/packages/{repoId}/{packageName}/versions HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200

Package versions retrieved successfully

[
  {
    "version": "text",
    "publishedAt": "text",
    "buildStatus": "text",
    "stage": "text"
  }
]

Get changelog diff between two package versions

get

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.
Authorizations
Path parameters
repoIdstringRequired

Repository identifier (e.g., "flxbl-io/sfp-pro")

Example: flxbl-io/sfp-pro
packageNamestringRequired

Package name

Example: core-package
Query parameters
fromstringRequired

Starting version for comparison

Example: 1.0.0.100
tostringRequired

Ending version for comparison

Example: 1.0.0.123
workItemPatternsstring[]Optional

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

Responses
200

Package diff retrieved successfully

application/json
get
GET /sfp/api/packages/{repoId}/{packageName}/changelog/diff?from=1.0.0.100&to=1.0.0.123 HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

{
  "packageName": "text",
  "fromVersion": "text",
  "toVersion": "text",
  "commits": [
    {
      "sha": "text",
      "message": "text",
      "author": "text",
      "date": "text"
    }
  ],
  "removedCommits": [
    {
      "sha": "text",
      "message": "text",
      "author": "text",
      "date": "text"
    }
  ],
  "workItems": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "removedWorkItems": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "isRollback": true,
  "summary": {
    "totalCommits": 1,
    "totalRemovedCommits": 1,
    "totalWorkItems": 1,
    "totalRemovedWorkItems": 1,
    "totalPullRequests": 1,
    "totalRemovedPullRequests": 1,
    "commitRange": {
      "from": "text",
      "to": "text",
      "direction": "forward"
    }
  }
}
PreviousMaintenanceNextReleases

Was this helpful?