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

Regression suites

Generated from what ships; steps run as guided human tests or agent runs, and every result carries evidence — a screenshot of the run.


Get the regression suite

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

The suite with its steps, executor modes, statuses, and evidence.

Get the regression suite › path Parameters

releaseId
​string · required

Get the regression suite › Responses

200

OK — stubbed example payload

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

Generate the regression suite

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

Drafts the steps from what ships — the PRs in the app pins and the config revisions in the config pins. Steps are editable before running.

Generate the regression suite › path Parameters

releaseId
​string · required

Generate the regression suite › Responses

200

OK — stubbed example payload

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

Dispatch agents on the pending steps

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

Runs every pending agent-mode step against the held environment. Each run reports back through the step-result operation with its screenshot evidence.

Dispatch agents on the pending steps › path Parameters

releaseId
​string · required

Dispatch agents on the pending steps › Responses

200

OK — stubbed example payload

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

Report a step result

POST
https://switchboard-api-main-0076d17.zuplo.app
/v1/releases/{releaseId}/regression-suite/steps/{stepId}/result

Records passed/failed with evidence — a screenshot of the run — whether the executor was an agent or a guided human. This is the operation the operation-phase plugin and the agent runners call.

Report a step result › path Parameters

releaseId
​string · required
stepId
​string · required

Report a step result › Responses

200

OK — stubbed example payload

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

ReleasesGraphQL