Set status
Sets the tests/applitools and/or scm/applitools status, depending if the SHA is push or PR.
- For a push commit the API will only update the
tests/applitoolsstatus - For a PR commit, the API will update the status of both
tests/applitoolsandscm/applitools
Request
POST /scm/commits/{sha}/set-status
Parameters
| Name | Type | In | Description |
|---|---|---|---|
| sha | string | path | SHA of the commit |
| status | string | body | The commit status to set (Pending/Failed/Success) |
Response
This API will respond with 200 and no body.
If the commit context for SHA does not exist, it will respond with status 404.
cURL example
The following script shows how to set the status to pending at the beginning of the pipeline.
curl -H "X-Eyes-Api-Key: <your-api-key>" -H 'Content-Type: application/json' -X POST "https://eyes.applitools.com/api/v1/scm/commits/325ce31f424ced997dd14fc355fa5ce829d0e429/set-status" --data-raw '{
"status": "Pending"
}'