Deployment Steps

Browse all recorded manual-step completions and reopenings, newest first

GET/sfp/api/deployment-steps/history

Authorization

access-token

AuthorizationBearer <token>

In: header

Declare a manual pre/post deployment step

POST/sfp/api/deployment-steps

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

type*string

Pre steps gate the deploy; post steps become due after it

Value in

"pre"
"post"

title*string

body?string

Markdown detail shown with the step

prNumber?number

Pull request the step is authored on and anchored to

prUrl?string

environments?array<string>

Narrow the step to named environments. Empty means every environment whose policy gates.

categories?array<string>

Narrow the step to environment categories

domains?array<string>

Narrow the step to named domains. Empty means every domain's release waits on it.

List deployment steps for a repository, optionally for one pull request

GET/sfp/api/deployment-steps

Authorization

access-token

AuthorizationBearer <token>

In: header

Query Parameters

repositoryIdentifier*string

pr?number

Only steps authored on this pull request

status?string

Default"open"

Value in

"open"
"cancelled"
"all"

Get a deployment step with environment attestations and release candidate overrides

GET/sfp/api/deployment-steps/{stepId}/details

Authorization

access-token

AuthorizationBearer <token>

In: header

Attest that a step was performed in an environment

POST/sfp/api/deployment-steps/{stepId}/complete

Completion is attested per environment: whichever domain surfaced the step, completing it clears the step for every deploy to that environment.

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

environment*string

Environment the action was performed in

domain?string

Domain of the release that surfaced the step (audit trail)

note?string

evidenceUrl?string

Link to evidence that the step was performed

Reopen a completed step for an environment

POST/sfp/api/deployment-steps/{stepId}/reopen

Re-gates the step for that environment. Use after a rollback undid the action, or when an attestation was recorded in error.

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

environment*string

Environment the action was performed in

domain?string

Domain of the release that surfaced the step (audit trail)

note?string

evidenceUrl?string

Link to evidence that the step was performed

Manually include or exclude a step for a release candidate

POST/sfp/api/deployment-steps/{stepId}/link

The override honoured by the same read path as the computed verdict — the escape hatch for cherry-picked delivery and mis-anchored steps.

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

releaseCandidate*string

Release candidate ref as domain:releaseName

mode*string

Value in

"include"
"exclude"

reason?string

Inspect pending anchor migrations for recovery

GET/sfp/api/deployment-steps/anchors/migrations

Authorization

access-token

AuthorizationBearer <token>

In: header

Cancel a pending migration after confirming its reconstruction was never published

POST/sfp/api/deployment-steps/anchors/migrations/{headCommit}/cancel

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

reason?string

Persist an anchor migration before publishing a reconstructed branch

POST/sfp/api/deployment-steps/anchors/prepare

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

releaseBranch*string

commitMapping*array<>

Old -> new SHA for every re-applied commit

mergeCommits?array<>

Merge commits of the rewritten range with the commits they brought in

previousHeadCommit?string

Branch head before the reconstruction, when the branch already existed

headCommit?string

Head of the reconstructed branch

Carry step anchors across a branch reconstruction

POST/sfp/api/deployment-steps/anchors/migrate

Reported by sfp releasecandidate unbundle after it force-pushes a reconstructed release branch. Re-anchors every step whose commit was re-applied under a new SHA (an anchor on a merge commit follows the re-applied commits of its lineage), and flags the steps the branch used to carry but no longer does.

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

releaseBranch*string

commitMapping*array<>

Old -> new SHA for every re-applied commit

mergeCommits?array<>

Merge commits of the rewritten range with the commits they brought in

previousHeadCommit?string

Branch head before the reconstruction, when the branch already existed

headCommit?string

Head of the reconstructed branch

Response Body

curl -X POST "https://example.com/sfp/api/deployment-steps/anchors/migrate" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "acme/salesforce-core",    "releaseBranch": "release/1.4",    "commitMapping": [      {        "original": "string",        "rewritten": "string"      }    ]  }'

Empty

Cancel a step (author or owner)

POST/sfp/api/deployment-steps/{stepId}/cancel

A cancelled step never pends again, whatever the ancestry says. The record is kept for audit.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

stepId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

reason?string

Response Body

curl -X POST "https://example.com/sfp/api/deployment-steps/string/cancel" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "acme/salesforce-core"  }'

Empty

Evaluate the manual-steps gate for an environment (internal)

POST/sfp/api/deployment-steps/gate/check

Resolves whether the environment gates on manual steps, computes what is still outstanding for the candidate, records the audit snapshot, and returns the steps the caller still has to surface in a checklist. Fails with 5xx when the pending set cannot be established, so the caller retries rather than proceeding.

Authorization

access-token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

repositoryIdentifier*string

environment*string

releaseCandidate*string

One or more domain:releaseName refs, comma separated for a multi-domain release

runId*string

Hatchet workflow run id — identifies the gate record

requestedBy?string

approvalReceived?boolean

True after approval, false when approval was skipped; omitted by legacy workers

postedChecklistStepIds?array<string>

Step ids whose checklist the caller posted since its last check

Response Body

curl -X POST "https://example.com/sfp/api/deployment-steps/gate/check" \  -H "Content-Type: application/json" \  -d '{    "repositoryIdentifier": "acme/salesforce-core",    "environment": "prod",    "releaseCandidate": "sales:Sprint_26.20",    "runId": "string"  }'

Empty

Manual deployment steps for an environment

GET/sfp/api/environments/by-name/{name}/deployment-steps

Per domain: the pre steps the next deploy is waiting on, the post steps that became due from the environment's current release, and the attestations recorded here. A domain that cannot be evaluated is reported with its error rather than failing the whole view.

Authorization

access-token

AuthorizationBearer <token>

In: header

Path Parameters

name*string

Query Parameters

repositoryIdentifier*string

domain?string

Restrict the view to one domain

Response Body

curl -X GET "https://example.com/sfp/api/environments/by-name/string/deployment-steps?repositoryIdentifier=acme%2Fsalesforce-core"

Empty

403

201

403

200

403

403

200

403

201

403

201

400

403

201

403

403

403

403

201

403

201

403

201

403

200

403