Snapvisor Docs
API ReferenceBuilds

Finalize parallel builds

Mark every parallel shard sharing the given `parallelNonce` as complete. Once finalized, Snapvisor compares the aggregated screenshots and starts processing the build.

POST
/builds/finalize

Mark every parallel shard sharing the given parallelNonce as complete. Once finalized, Snapvisor compares the aggregated screenshots and starts processing the build.

Authorization

projectToken
AuthorizationBearer <token>

Authenticate as a project with a project token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <project-token>

You can find your project token in your Snapvisor project settings. Project tokens are used by CI and the SDK to create builds and deployments.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/builds/finalize" \  -H "Content-Type: application/json" \  -d '{    "parallelNonce": "string"  }'
{  "builds": [    {      "id": "string",      "number": 1,      "head": {        "sha": "string",        "branch": "string"      },      "base": {        "sha": "string",        "branch": "string"      },      "status": "accepted",      "conclusion": "no-changes",      "stats": {        "added": 0,        "removed": 0,        "unchanged": 0,        "changed": 0,        "ignored": 0,        "failure": 0,        "retryFailure": 0,        "total": 0      },      "metadata": {        "testReport": {          "status": "passed",          "stats": {            "startTime": "string",            "duration": 0          }        }      },      "url": "http://example.com",      "notification": {        "description": "string",        "context": "string",        "github": {          "state": "pending"        },        "gitlab": {          "state": "pending"        },        "origin": {          "status": "queued",          "conclusion": "success"        },        "url": "http://example.com"      }    }  ]}

Upload a file to a proxied upload target POST

Receives one file for an upload target returned by `createBuild` (`postUrl` + `fields`) or `createMedia` (`upload.url` + `upload.fields`) when the object store does not implement S3 presigned POST (e.g. Backblaze B2); on other stores the URL points at the store itself and this route is not used. Behaves like an S3 POST-object endpoint: send the `fields` as form fields, then the file. No bearer token: the signed `policy` field is the authorization.

Find an eligible baseline from a list of commits POST

Find the build eligible to be used as a baseline among a list of commits. Useful when no Git provider is connected: the CLI can send the candidate ancestor commits and let Snapvisor pick the closest one that has an eligible (complete, valid, approved and not rejected) baseline build.