Switchboard
  • Understand Switchboard
  • Build for Switchboard
  • Operate
  • API reference
Information
Manifest
    Get the manifest schemagetValidate a manifestpost
Releases
    List releasesgetCreate a releasepostGet a releasegetBegin testingpostRequest approval for productionpostApprove and shippost
Regression suites
    Get the regression suitegetGenerate the regression suitepostDispatch agents on the pending stepspostReport a step resultpost
GraphQL
    The control plane's GraphQL APIpost
Other endpoints
    Health checkgetInbound webhooks (GitHub App, Frontegg, partners)post
powered by Zuplo
Switchboard API
Switchboard API

Releases

The release process: assemble from channel heads, hold an environment, test, request approval, ship. The QA implementation team's surface — and the operation-phase plugin's.


List releases

GET
https://switchboard-api-main-0076d17.zuplo.app
/v1/releases

List releases › Responses

200

OK — stubbed example payload

No data returned
GET/v1/releases
curl https://switchboard-api-main-0076d17.zuplo.app/v1/releases
Example Responses
No example specified for this content type

Create a release

POST
https://switchboard-api-main-0076d17.zuplo.app
/v1/releases

Assembles a release from channel heads: the app pins and config pins, the target environment to hold. The QA surface — everything after this is the release process.

Create a release › Responses

200

OK — stubbed example payload

No data returned
POST/v1/releases
curl https://switchboard-api-main-0076d17.zuplo.app/v1/releases \ --request POST
Example Responses
No example specified for this content type

Get a release

GET
https://switchboard-api-main-0076d17.zuplo.app
/v1/releases/{releaseId}

Get a release › path Parameters

releaseId
​string · required

Get a release › Responses

200

OK — stubbed example payload

No data returned
GET/v1/releases/{releaseId}
curl https://switchboard-api-main-0076d17.zuplo.app/v1/releases/:releaseId
Example Responses
No example specified for this content type

Begin testing

POST
https://switchboard-api-main-0076d17.zuplo.app
/v1/releases/{releaseId}/begin-testing

Deploys the pins to the target environment and holds it on this release until it ships or is abandoned.

Begin testing › path Parameters

releaseId
​string · required

Begin testing › Responses

200

OK — stubbed example payload

No data returned
POST/v1/releases/{releaseId}/begin-testing
curl https://switchboard-api-main-0076d17.zuplo.app/v1/releases/:releaseId/begin-testing \ --request POST
Example Responses
No example specified for this content type

Request approval for production

POST
https://switchboard-api-main-0076d17.zuplo.app
/v1/releases/{releaseId}/request-approval

One promotion request per repository, decided by the approver its policy names. Requester and approver are two people.

Request approval for production › path Parameters

releaseId
​string · required

Request approval for production › Responses

200

OK — stubbed example payload

No data returned
POST/v1/releases/{releaseId}/request-approval
curl https://switchboard-api-main-0076d17.zuplo.app/v1/releases/:releaseId/request-approval \ --request POST
Example Responses
No example specified for this content type

Approve and ship

POST
https://switchboard-api-main-0076d17.zuplo.app
/v1/releases/{releaseId}/approve

Advances stable for every repository in the release; production follows stable and deploys.

Approve and ship › path Parameters

releaseId
​string · required

Approve and ship › Responses

200

OK — stubbed example payload

No data returned
POST/v1/releases/{releaseId}/approve
curl https://switchboard-api-main-0076d17.zuplo.app/v1/releases/:releaseId/approve \ --request POST
Example Responses
No example specified for this content type

ManifestRegression suites