Changesets

List project-scoped changesets

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

projectIdentifierstringRequired

Project identifier

sourceOrgUsernamestringOptional

Filter by source org username

Responses

200

Changesets returned

No content

403

Forbidden - Requires role: member, owner, application

get/sfp/api/changesets

HTTPcURLJavaScriptPython

GET /sfp/api/changesets?projectIdentifier=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create and materialize a changeset from selected org components

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

projectIdentifierstringRequired

Project identifier for the current Codev project

repositoryIdentifierstringOptional

Repository identifier. Defaults to projectIdentifier when omitted.

namestringRequired

User-defined changeset display name

sourceOrgUsernamestringRequired

Source org username selected in Org Explorer

sourceEnvironmentNamestringOptional

Source environment name when the source org is a managed environment

templateIdstringOptional

Changeset template identifier used to govern this changeset

Responses

201

Changeset created and materialization dispatched

No content

403

Forbidden - Requires role: member, owner, application

post/sfp/api/changesets

HTTPcURLJavaScriptPython

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

{
  "projectIdentifier": "text",
  "repositoryIdentifier": "text",
  "name": "text",
  "sourceOrgUsername": "text",
  "sourceEnvironmentName": "text",
  "templateId": "text",
  "selectedComponents": [
    {
      "metadataType": "text",
      "memberName": "text",
      "operation": "deploy",
      "destructiveStage": "pre"
    }
  ]
}

No content

Get a changeset and its deployment history

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

changesetIdstringRequired

Query parameters

projectIdentifierstringRequired

Project identifier

Responses

200

Changeset returned

No content

403

Forbidden - Requires role: member, owner, application

get/sfp/api/changesets/{changesetId}

HTTPcURLJavaScriptPython

GET /sfp/api/changesets/{changesetId}?projectIdentifier=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get materialized source files for a changeset component

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

changesetIdstringRequired

Query parameters

projectIdentifierstringRequired

Project identifier

metadataTypestringRequired

Salesforce metadata type to read from the materialized source snapshot

memberNamestringRequired

Salesforce metadata member name to read from the materialized source snapshot

Responses

200

Materialized component source returned

No content

403

Forbidden - Requires role: member, owner, application

get/sfp/api/changesets/{changesetId}/materialized-source

HTTPcURLJavaScriptPython

GET /sfp/api/changesets/{changesetId}/materialized-source?projectIdentifier=text&metadataType=text&memberName=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List deployments for a changeset

get

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

changesetIdstringRequired

Query parameters

projectIdentifierstringRequired

Project identifier

Responses

200

Deployment records returned

No content

403

Forbidden - Requires role: member, owner, application

get/sfp/api/changesets/{changesetId}/deployments

HTTPcURLJavaScriptPython

GET /sfp/api/changesets/{changesetId}/deployments?projectIdentifier=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retry materialization for a failed changeset

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

changesetIdstringRequired

Body

application/json

projectIdentifierstringRequired

Project identifier

Responses

200

Materialization retry dispatched

No content

403

Forbidden - Requires role: member, owner, application

post/sfp/api/changesets/{changesetId}/retry

HTTPcURLJavaScriptPython

POST /sfp/api/changesets/{changesetId}/retry HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "projectIdentifier": "text"
}

No content

Install or validate a changeset artifact in a target org

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

changesetIdstringRequired

Body

application/json

projectIdentifierstringRequired

Project identifier

repositoryIdentifierstringOptional

Repository identifier. Defaults to projectIdentifier when omitted.

targetOrgstringRequired

Target org username or alias

targetEnvironmentNamestringOptional

Target environment name when known

checkOnlybooleanOptional

Validate deployment without committing changes

Default: false

Responses

201

Install changeset workflow dispatched

No content

403

Forbidden - Requires role: member, owner, application

post/sfp/api/changesets/{changesetId}/install

HTTPcURLJavaScriptPython

POST /sfp/api/changesets/{changesetId}/install HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "projectIdentifier": "text",
  "repositoryIdentifier": "text",
  "targetOrg": "text",
  "targetEnvironmentName": "text",
  "checkOnly": false
}

No content

Create a pull request from the materialized changeset source

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

changesetIdstringRequired

Body

application/json

projectIdentifierstringRequired

Project identifier

repositoryIdentifierstringOptional

Deprecated compatibility field. When provided, it must match the changeset repository.

targetBranchstringRequired

Tracked target branch for the pull request

titlestringOptional

Pull request title. Defaults to a changeset-generated title.

descriptionstringOptional

Pull request body markdown. Defaults to a changeset-generated body.

draftbooleanOptional

Create as draft pull request

Default: false

Responses

201

Changeset pull request workflow dispatched

No content

403

Forbidden - Requires role: member, owner, application

post/sfp/api/changesets/{changesetId}/pull-requests

HTTPcURLJavaScriptPython

POST /sfp/api/changesets/{changesetId}/pull-requests HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "projectIdentifier": "text",
  "repositoryIdentifier": "text",
  "targetBranch": "text",
  "title": "text",
  "description": "text",
  "draft": false
}

No content

Internal worker callback for changeset materialization status

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

changesetIdstringRequired

Body

application/json

projectIdentifierstringRequired

Project identifier

statusobjectRequired

Materialization status

taskExecutionIdstringOptional

artifactNamestringOptional

artifactVersionstringOptional

artifactCoordinatesstringOptional

errorstringOptional

Responses

403

Forbidden - Requires role: application

No content

post/sfp/api/changesets/internal/{changesetId}/materialization

HTTPcURLJavaScriptPython

POST /sfp/api/changesets/internal/{changesetId}/materialization HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 586

{
  "projectIdentifier": "text",
  "status": {},
  "taskExecutionId": "text",
  "artifactName": "text",
  "artifactVersion": "text",
  "artifactCoordinates": "text",
  "error": "text",
  "materializedSource": {
    "version": 1,
    "objectPrefix": "text",
    "manifestObjectKey": "text",
    "capturedAt": "text",
    "fileCount": 1,
    "sizeBytes": 1,
    "components": [
      {
        "metadataType": "text",
        "memberName": "text",
        "operation": "deploy",
        "destructiveStage": "pre",
        "sourceData": [
          {
            "fileName": "text",
            "relativePath": "text",
            "objectKey": "text",
            "fullName": "text",
            "type": "text",
            "state": "text",
            "contentType": "text",
            "sizeBytes": 1,
            "sha256": "text",
            "fetchedAt": "text"
          }
        ]
      }
    ]
  }
}

403

Forbidden - Requires role: application

No content

Internal worker callback for changeset deployment status

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

changesetIdstringRequired

deploymentIdstringRequired

Body

application/json

projectIdentifierstringRequired

Project identifier

statusobjectRequired

Deployment status

taskExecutionIdstringOptional

errorstringOptional

Responses

403

Forbidden - Requires role: application

No content

post/sfp/api/changesets/internal/{changesetId}/deployments/{deploymentId}

HTTPcURLJavaScriptPython

POST /sfp/api/changesets/internal/{changesetId}/deployments/{deploymentId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "projectIdentifier": "text",
  "status": {},
  "taskExecutionId": "text",
  "error": "text"
}

403

Forbidden - Requires role: application

No content

Internal worker callback for changeset pull request status

post

Authorizations

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

changesetIdstringRequired

pullRequestIdstringRequired

Body

application/json

projectIdentifierstringRequired

Project identifier

statusobjectRequired

Pull request creation status

taskExecutionIdstringOptional

sourceBranchstringOptional

prUrlstringOptional

prNumbernumberOptional

errorstringOptional

Responses

403

Forbidden - Requires role: application

No content

post/sfp/api/changesets/internal/{changesetId}/pull-requests/{pullRequestId}

HTTPcURLJavaScriptPython

POST /sfp/api/changesets/internal/{changesetId}/pull-requests/{pullRequestId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "projectIdentifier": "text",
  "status": {},
  "taskExecutionId": "text",
  "sourceBranch": "text",
  "prUrl": "text",
  "prNumber": 1,
  "error": "text"
}

403

Forbidden - Requires role: application

No content