Projects

Replace build-on-merge domain allow-list rules for a project

put

Replaces all branch-scoped domain allow-list rules for the build-on-merge flow.

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

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

repositoryIdentifierstringRequired

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

Example: flxbl-io/sf-core

Responses

200

Domain allow-list rules updated

No content

403

Forbidden - Requires role: owner, application

404

Project not found

put/sfp/api/projects/config/build-on-merge

HTTPcURLJavaScriptPython

PUT /sfp/api/projects/config/build-on-merge HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "repositoryIdentifier": "flxbl-io/sf-core",
  "domainRules": [
    {
      "branchPattern": "main",
      "allowedDomains": [
        "core",
        "sales"
      ]
    }
  ]
}

No content

Replace changeset template settings for a project

put

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

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

selectionModestring · enumRequiredDefault: anyPossible values:

repositoryIdentifierstringRequired

Project/repository identifier

Responses

200

Changeset settings updated

No content

403

Forbidden - Requires role: owner, application

404

Project not found

put/sfp/api/projects/config/changesets

HTTPcURLJavaScriptPython

PUT /sfp/api/projects/config/changesets HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 464

{
  "selectionMode": "any",
  "templates": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "source": {
        "type": "manual",
        "packageName": "text",
        "platformTemplateId": "text"
      },
      "metadataTypes": [
        "text"
      ],
      "components": [
        {
          "metadataType": "text",
          "memberName": "text",
          "operation": "deploy",
          "destructiveStage": "pre"
        }
      ],
      "allowedOperations": [
        "deploy"
      ],
      "allowedDestructiveStages": [
        "pre"
      ],
      "createdBy": "text",
      "createdAt": "text",
      "updatedBy": "text",
      "updatedAt": "text"
    }
  ],
  "repositoryIdentifier": "text"
}

No content

List all onboarded projects

get

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.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of projects retrieved successfully.

application/json

identifierstringRequired

Repository identifier

Example: flxbl-io/sf-core

remoteUrlstringRequired

Remote repository URL

Example: https://github.com/flxbl-io/sf-core

platformstring · enumRequired

Platform for the repository (user-specified)

Example: githubPossible values:

createdAtstringRequired

Creation timestamp

Example: 2025-06-21T10:00:00.000Z

updatedAtstringRequired

Last update timestamp

Example: 2025-06-21T10:00:00.000Z

versionnumberRequired

Document version for optimistic concurrency control

Example: 1

configurationobjectOptional

Project configuration object for extensibility.

Includes optional fields for:

• workItems: Issue tracker integration (Jira, GitHub, Azure DevOps)
• metricsAlertConfig: Custom alert thresholds for dashboard metrics
• branches: Tracked branches
• settings: Build and deployment settings

Example: {"displayName":"SFP Pro","description":"Enterprise Salesforce build system","branches":["main","develop"],"devHubs":["[e-mail]","[e-mail]"],"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}}

integrationsarrayOptional

Integration references linked to this project

Example: [{"id":"uuid","provider":"ai_anthropic","authType":"api_key","created_at":"2025-01-01T00:00:00.000Z"}]

403

Forbidden - Requires role: member, application

500

Internal server error

get/sfp/api/projects

HTTPcURLJavaScriptPython

GET /sfp/api/projects HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "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": [
        "[e-mail]",
        "[e-mail]"
      ],
      "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"
      }
    ]
  }
]

Onboard a new repository

post

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.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

identifierstringOptional

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

Example: flxbl-io/sf-core

remoteUrlstringRequired

Remote repository URL

Example: https://github.com/flxbl-io/sf-core

platformstring · enumOptional

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

Example: githubPossible values:

Responses

201

The project has been successfully created.

application/json

identifierstringRequired

Repository identifier

Example: flxbl-io/sf-core

remoteUrlstringRequired

Remote repository URL

Example: https://github.com/flxbl-io/sf-core

platformstring · enumRequired

Platform for the repository (user-specified)

Example: githubPossible values:

createdAtstringRequired

Creation timestamp

Example: 2025-06-21T10:00:00.000Z

updatedAtstringRequired

Last update timestamp

Example: 2025-06-21T10:00:00.000Z

versionnumberRequired

Document version for optimistic concurrency control

Example: 1

configurationobjectOptional

Project configuration object for extensibility.

Includes optional fields for:

• workItems: Issue tracker integration (Jira, GitHub, Azure DevOps)
• metricsAlertConfig: Custom alert thresholds for dashboard metrics
• branches: Tracked branches
• settings: Build and deployment settings

Example: {"displayName":"SFP Pro","description":"Enterprise Salesforce build system","branches":["main","develop"],"devHubs":["[e-mail]","[e-mail]"],"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}}

integrationsarrayOptional

Integration references linked to this project

Example: [{"id":"uuid","provider":"ai_anthropic","authType":"api_key","created_at":"2025-01-01T00:00:00.000Z"}]

400

Invalid request data

application/json

403

Forbidden - Requires role: owner, application

409

The project already exists.

application/json

post/sfp/api/projects

HTTPcURLJavaScriptPython

POST /sfp/api/projects HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "identifier": "flxbl-io/sf-core",
  "remoteUrl": "https://github.com/flxbl-io/sf-core"
}

GitHub repositoryGitLab repository

{
  "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": [
      "[e-mail]",
      "[e-mail]"
    ],
    "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

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.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

identifierstringRequired

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

Example: flxbl-io/sf-core

Responses

200

Project retrieved successfully.

application/json

identifierstringRequired

Repository identifier

Example: flxbl-io/sf-core

remoteUrlstringRequired

Remote repository URL

Example: https://github.com/flxbl-io/sf-core

platformstring · enumRequired

Platform for the repository (user-specified)

Example: githubPossible values:

createdAtstringRequired

Creation timestamp

Example: 2025-06-21T10:00:00.000Z

updatedAtstringRequired

Last update timestamp

Example: 2025-06-21T10:00:00.000Z

versionnumberRequired

Document version for optimistic concurrency control

Example: 1

configurationobjectOptional

Project configuration object for extensibility.

Includes optional fields for:

• workItems: Issue tracker integration (Jira, GitHub, Azure DevOps)
• metricsAlertConfig: Custom alert thresholds for dashboard metrics
• branches: Tracked branches
• settings: Build and deployment settings

Example: {"displayName":"SFP Pro","description":"Enterprise Salesforce build system","branches":["main","develop"],"devHubs":["[e-mail]","[e-mail]"],"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}}

integrationsarrayOptional

Integration references linked to this project

Example: [{"id":"uuid","provider":"ai_anthropic","authType":"api_key","created_at":"2025-01-01T00:00:00.000Z"}]

403

Forbidden - Requires role: member, application

404

Project not found.

application/json

500

Internal server error

get/sfp/api/projects/{identifier}

HTTPcURLJavaScriptPython

GET /sfp/api/projects/{identifier} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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": [
      "[e-mail]",
      "[e-mail]"
    ],
    "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

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

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

identifierstringRequired

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

Example: flxbl-io/sf-core

Responses

204

Project deleted successfully.

No content

403

Forbidden - Requires role: owner, application

404

Project not found.

application/json

500

Internal server error

delete/sfp/api/projects/{identifier}

HTTPcURLJavaScriptPython

DELETE /sfp/api/projects/{identifier} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update project configuration

patch

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.

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

identifierstringRequired

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

Example: flxbl-io/sf-core

Body

application/json

identifierstringOptional

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

Example: flxbl-io/sf-core-renamed

remoteUrlstringOptional

Remote repository URL

Example: https://github.com/flxbl-io/sf-core

platformstring · enumOptional

Platform for the repository

Example: githubPossible values:

versionnumberOptional

Document version for optimistic concurrency control

Example: 1

Responses

200

Project updated successfully.

application/json

identifierstringRequired

Repository identifier

Example: flxbl-io/sf-core

remoteUrlstringRequired

Remote repository URL

Example: https://github.com/flxbl-io/sf-core

platformstring · enumRequired

Platform for the repository (user-specified)

Example: githubPossible values:

createdAtstringRequired

Creation timestamp

Example: 2025-06-21T10:00:00.000Z

updatedAtstringRequired

Last update timestamp

Example: 2025-06-21T10:00:00.000Z

versionnumberRequired

Document version for optimistic concurrency control

Example: 1

configurationobjectOptional

Project configuration object for extensibility.

Includes optional fields for:

• workItems: Issue tracker integration (Jira, GitHub, Azure DevOps)
• metricsAlertConfig: Custom alert thresholds for dashboard metrics
• branches: Tracked branches
• settings: Build and deployment settings

Example: {"displayName":"SFP Pro","description":"Enterprise Salesforce build system","branches":["main","develop"],"devHubs":["[e-mail]","[e-mail]"],"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}}

integrationsarrayOptional

Integration references linked to this project

Example: [{"id":"uuid","provider":"ai_anthropic","authType":"api_key","created_at":"2025-01-01T00:00:00.000Z"}]

400

Invalid request data

application/json

403

Forbidden - Requires role: owner, application

404

Project not found.

application/json

409

Version conflict - the project has been modified by another process.

application/json

500

Internal server error

patch/sfp/api/projects/{identifier}

HTTPcURLJavaScriptPython

PATCH /sfp/api/projects/{identifier} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "remoteUrl": "https://github.com/flxbl-io/sf-core-renamed"
}

Update repository URLAdd project configurationUpdate with version checkRename project identifier

{
  "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": [
      "[e-mail]",
      "[e-mail]"
    ],
    "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"
    }
  ]
}