HomeBlogOur Salesforce Deployment Tools
API
Use Metadata DeployerUse CPQ Deployer

Upsert a Check

put
https://COMPANY.my.bluecanvas.io/apis/rest/v1/deployments//checks/

Creates or updates the status of a check for a given deployment by its canonical check name. The first time you invoke this action, a new record for the check is created and will appear in the interface. Successive calls to this action update the state of that record. This allows you to update the status of a check as it progresses in your external system.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The numeric identifier of the Deployment Request for which you are updating the check.

string
required

The canonical identifier of the status check, for example "code-coverage".

Body Params
string
required

Can be one of QUEUED, IN_PROGRESS, DONE.

string

Can be one of SUCCESS, FAILURE, NEUTRAL, CANCELLED, SKIPPED, TIMED_OUT. Required if the state is DONE.

string

A short human readable description of the status.

string

An external URL where the user can find the full details of the status, for example "https://ci.example.com/jobs/20194". Will be linked from the user interface.

string

A machine readable external identifier, for reference. For example, "20194".

Response

Updated almost 5 years ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json

Updated almost 5 years ago