Projects

When build-on-merge runs for a branch, only the domains allow-listed for the first matching branchPattern are built; every other impacted domain is skipped. No matching rule (or an empty list) imposes no restriction.

Branch patterns support wildcards: main, release/*, *. Domains are matched by exact, case-insensitive name (a release config's releaseName).

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)

domainRules*array<>

Branch-scoped domain allow-list rules. Replaces all existing rules.

Response Body

curl -X PUT "https://example.com/sfp/api/projects/config/build-on-merge" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "flxbl-io/sf-core",    "domainRules": [      {        "branchPattern": "main",        "allowedDomains": [          "core",          "sales"        ]      }    ]  }'

Empty

Replace changeset template settings for a project

PUT/sfp/api/projects/config/changesets

Replaces the project-scoped changeset selection mode and template list.

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

selectionMode*string

Default"any"

Value in

"any"
"template_only"

templates?array<>

repositoryIdentifier*string

Project/repository identifier

Response Body

curl -X PUT "https://example.com/sfp/api/projects/config/changesets" \  -H "Content-Type: application/json" \  -d '{    "selectionMode": "any",    "repositoryIdentifier": "string"  }'

Empty

Onboard a new repository

POST/sfp/api/projects

Creates a new project entry for repository onboarding. Fails if the project already exists to prevent accidental updates through POST requests. Use this endpoint to register repositories with the SFP server for future operations. Only users with the "owner" role can create projects.

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

Project details

TypeScript Definitions

Use the request body type in TypeScript.

identifier?string

Repository identifier (e.g., "org/repo" for GitHub, "org/project/repo" for Azure DevOps). Must be lowercase. If omitted, auto-derived from remoteUrl.

remoteUrl*string

Remote repository URL

platform?string

Platform for the repository. If not provided, will be inferred from URL (deprecated behavior)

Value in

"github"
"gitlab"
"bitbucket"
"azure-devops"
"other"

configuration?

Project configuration including workItems settings

Response Body

`application/json`

curl -X POST "https://example.com/sfp/api/projects" \  -H "Content-Type: application/json" \  -d '{    "identifier": "flxbl-io/sf-core",    "remoteUrl": "https://github.com/flxbl-io/sf-core"  }'

{  "identifier": "flxbl-io/sf-core",  "remoteUrl": "https://github.com/flxbl-io/sf-core",  "platform": "github",  "createdAt": "2025-06-21T10:00:00.000Z",  "updatedAt": "2025-06-21T10:00:00.000Z",  "version": 1,  "configuration": {    "displayName": "SFP Pro",    "description": "Enterprise Salesforce build system",    "branches": [      "main",      "develop"    ],    "devHubs": [      "devhub1@example.com",      "devhub2@example.com"    ],    "autoReleaseFinalization": true,    "workItems": {      "provider": "jira",      "jiraProjects": [        "DP",        "PROJ"      ],      "baseUrl": "https://company.atlassian.net/browse"    },    "metricsAlertConfig": {      "validation.successRate": {        "warning": 0.85,        "alert": 0.7      },      "build.avgCreationTime": {        "warning": 15,        "alert": 30      }    },    "settings": {      "buildTimeout": 3600,      "parallelBuilds": 4    }  },  "integrations": [    {      "id": "uuid",      "provider": "ai_anthropic",      "authType": "api_key",      "created_at": "2025-01-01T00:00:00.000Z"    }  ]}

List all onboarded projects

GET/sfp/api/projects

Returns a list of all projects that have been onboarded to the system. Projects are returned in no particular order. This endpoint is useful for discovering available projects before performing operations on them.

Authorization

access-token

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/sfp/api/projects"

[  {    "identifier": "flxbl-io/sf-core",    "remoteUrl": "https://github.com/flxbl-io/sf-core",    "platform": "github",    "createdAt": "2025-06-21T10:00:00.000Z",    "updatedAt": "2025-06-21T10:00:00.000Z",    "version": 1,    "configuration": {      "displayName": "SFP Pro",      "description": "Enterprise Salesforce build system",      "branches": [        "main",        "develop"      ],      "devHubs": [        "devhub1@example.com",        "devhub2@example.com"      ],      "autoReleaseFinalization": true,      "workItems": {        "provider": "jira",        "jiraProjects": [          "DP",          "PROJ"        ],        "baseUrl": "https://company.atlassian.net/browse"      },      "metricsAlertConfig": {        "validation.successRate": {          "warning": 0.85,          "alert": 0.7        },        "build.avgCreationTime": {          "warning": 15,          "alert": 30        }      },      "settings": {        "buildTimeout": 3600,        "parallelBuilds": 4      }    },    "integrations": [      {        "id": "uuid",        "provider": "ai_anthropic",        "authType": "api_key",        "created_at": "2025-01-01T00:00:00.000Z"      }    ]  }]

Get a specific project by identifier

GET/sfp/api/projects/{identifier}

Retrieves a project by its repository identifier (e.g., "org/repo"). The identifier must match exactly what was used during project creation. This endpoint supports identifiers with slashes for GitHub-style repositories.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

identifier*string

Repository identifier (e.g., "org/repo")

Response Body

`application/json`

curl -X GET "https://example.com/sfp/api/projects/flxbl-io/sf-core"

{  "identifier": "flxbl-io/sf-core",  "remoteUrl": "https://github.com/flxbl-io/sf-core",  "platform": "github",  "createdAt": "2025-06-21T10:00:00.000Z",  "updatedAt": "2025-06-21T10:00:00.000Z",  "version": 1,  "configuration": {    "displayName": "SFP Pro",    "description": "Enterprise Salesforce build system",    "branches": [      "main",      "develop"    ],    "devHubs": [      "devhub1@example.com",      "devhub2@example.com"    ],    "autoReleaseFinalization": true,    "workItems": {      "provider": "jira",      "jiraProjects": [        "DP",        "PROJ"      ],      "baseUrl": "https://company.atlassian.net/browse"    },    "metricsAlertConfig": {      "validation.successRate": {        "warning": 0.85,        "alert": 0.7      },      "build.avgCreationTime": {        "warning": 15,        "alert": 30      }    },    "settings": {      "buildTimeout": 3600,      "parallelBuilds": 4    }  },  "integrations": [    {      "id": "uuid",      "provider": "ai_anthropic",      "authType": "api_key",      "created_at": "2025-01-01T00:00:00.000Z"    }  ]}

Update project configuration

PATCH/sfp/api/projects/{identifier}

Updates an existing project's configuration. Supports partial updates via PATCH semantics. Only owners can update projects. Includes optimistic concurrency control through version checking to prevent concurrent update conflicts.

Renaming: Pass identifier in the body to rename the project. The old identifier is deleted and a new one is created with all existing data.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

identifier*string

Repository identifier (e.g., "org/repo")

Request Body

application/json

Fields to update

TypeScript Definitions

Use the request body type in TypeScript.

identifier?string

New repository identifier. Renames the project key in the store. Must be lowercase in format org/repo or org/project/repo.

remoteUrl?string

Remote repository URL

platform?string

Platform for the repository

Value in

"github"
"gitlab"
"bitbucket"
"azure-devops"
"other"

configuration?

Project configuration object.

Examples by provider:

Jira: { workItems: { provider: "jira", jiraProjects: ["DP", "PROJ"], baseUrl: "https://company.atlassian.net/browse" } }
GitHub: { workItems: { provider: "github" } } (uses project identifier directly)
Azure DevOps: { workItems: { provider: "azure-devops", project: "sf-core", organizationUrl: "https://dev.azure.com/org", areaPaths: ["sf-core\\Team1"] } }

version?number

Document version for optimistic concurrency control

Response Body

`application/json`

curl -X PATCH "https://example.com/sfp/api/projects/flxbl-io/sf-core" \  -H "Content-Type: application/json" \  -d '{    "remoteUrl": "https://github.com/flxbl-io/sf-core-renamed"  }'

{  "identifier": "flxbl-io/sf-core",  "remoteUrl": "https://github.com/flxbl-io/sf-core",  "platform": "github",  "createdAt": "2025-06-21T10:00:00.000Z",  "updatedAt": "2025-06-21T10:00:00.000Z",  "version": 1,  "configuration": {    "displayName": "SFP Pro",    "description": "Enterprise Salesforce build system",    "branches": [      "main",      "develop"    ],    "devHubs": [      "devhub1@example.com",      "devhub2@example.com"    ],    "autoReleaseFinalization": true,    "workItems": {      "provider": "jira",      "jiraProjects": [        "DP",        "PROJ"      ],      "baseUrl": "https://company.atlassian.net/browse"    },    "metricsAlertConfig": {      "validation.successRate": {        "warning": 0.85,        "alert": 0.7      },      "build.avgCreationTime": {        "warning": 15,        "alert": 30      }    },    "settings": {      "buildTimeout": 3600,      "parallelBuilds": 4    }  },  "integrations": [    {      "id": "uuid",      "provider": "ai_anthropic",      "authType": "api_key",      "created_at": "2025-01-01T00:00:00.000Z"    }  ]}

Delete a project

DELETE/sfp/api/projects/{identifier}

Permanently deletes a project and its stored configuration. Only owners can delete projects. This does not delete external resources (webhooks, environments, etc.).

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

identifier*string

Repository identifier (e.g., "org/repo")

Response Body

`application/json`

curl -X DELETE "https://example.com/sfp/api/projects/flxbl-io/sf-core"

Empty

200

403

200

403

404

200

403

404

201application/json

400application/json

403

409application/json

200application/json

403

500

200application/json

403

404application/json

500

200application/json

400application/json

403

404application/json

409application/json

500

204

403

404application/json

500

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`