Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error.
Optional params
fetch-request
1await fetch("https://api.vercel.com/v1/deployments/dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6/checks?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {2 "body": {3 "blocking": true,4 "name": "Performance Check",5 "detailsUrl": "http://example.com",6 "externalId": "1234abc",7 "path": "/",8 "rerequestable": true9 },10 "headers": {11 "Authorization": "Bearer <TOKEN>"12 },13 "method": "post"14})
Path Parameter | Description |
---|---|
deploymentId | string requiredThe deployment to create the check for. Example: dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6 |
blockingbooleanRequired completedAtnumber conclusionstring One of: canceled
|failed
|neutral
|succeeded
|skipped
|stale
createdAtnumberRequired deploymentIdstringRequired detailsUrlstring externalIdstring idstringRequired integrationIdstringRequired namestringRequired outputobject pathstring rerequestableboolean startedAtnumber statusstringRequired One of: registered
|running
|completed
updatedAtnumberRequired
Code | Description |
---|---|
200 | |
400 |
|
401 | |
403 | You do not have permission to access this resource. |
404 | The deployment was not found |
Optional params
fetch-request
1await fetch("https://api.vercel.com/v1/deployments/dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6/checks?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {2 "body": {3 "blocking": true,4 "name": "Performance Check",5 "detailsUrl": "http://example.com",6 "externalId": "1234abc",7 "path": "/",8 "rerequestable": true9 },10 "headers": {11 "Authorization": "Bearer <TOKEN>"12 },13 "method": "post"14})
List all of the checks created for a deployment.
Optional params
fetch-request
1await fetch("https://api.vercel.com/v1/deployments/dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6/checks?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {2 "headers": {3 "Authorization": "Bearer <TOKEN>"4 },5 "method": "get"6})
Path Parameter | Description |
---|---|
deploymentId | string requiredThe deployment to get all checks for Example: dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6 |
checksarrayRequired
Code | Description |
---|---|
200 | |
400 | One of the provided values in the request query is invalid. |
401 | |
403 | You do not have permission to access this resource. |
404 | The deployment was not found |
Optional params
fetch-request
1await fetch("https://api.vercel.com/v1/deployments/dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6/checks?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {2 "headers": {3 "Authorization": "Bearer <TOKEN>"4 },5 "method": "get"6})
Return a detailed response for a single check.
Optional params
fetch-request
1await fetch("https://api.vercel.com/v1/deployments/dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6/checks/check_2qn7PZrx89yxY34vEZPD31Y9XVj6?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {2 "headers": {3 "Authorization": "Bearer <TOKEN>"4 },5 "method": "get"6})
Path Parameter | Description |
---|---|
checkId | string requiredThe check to fetch Example: check_2qn7PZrx89yxY34vEZPD31Y9XVj6 |
deploymentId | string requiredThe deployment to get the check for. Example: dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6 |
blockingbooleanRequired completedAtnumber conclusionstring One of: canceled
|failed
|neutral
|succeeded
|skipped
|stale
createdAtnumberRequired deploymentIdstringRequired detailsUrlstring externalIdstring idstringRequired integrationIdstringRequired namestringRequired outputobject pathstring rerequestableboolean startedAtnumber statusstringRequired One of: registered
|running
|completed
updatedAtnumberRequired
Code | Description |
---|---|
200 | |
400 | One of the provided values in the request query is invalid. |
401 | |
403 |
|
404 |
|
Optional params
fetch-request
1await fetch("https://api.vercel.com/v1/deployments/dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6/checks/check_2qn7PZrx89yxY34vEZPD31Y9XVj6?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {2 "headers": {3 "Authorization": "Bearer <TOKEN>"4 },5 "method": "get"6})
Rerequest a selected check that has failed.
Optional params
fetch-request
1await fetch("https://api.vercel.com/v1/deployments/dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6/checks/check_2qn7PZrx89yxY34vEZPD31Y9XVj6/rerequest?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {2 "headers": {3 "Authorization": "Bearer <TOKEN>"4 },5 "method": "post"6})
Path Parameter | Description |
---|---|
checkId | string requiredThe check to rerun Example: check_2qn7PZrx89yxY34vEZPD31Y9XVj6 |
deploymentId | string requiredThe deployment to rerun the check for. Example: dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6 |
object
Code | Description |
---|---|
200 | |
400 | One of the provided values in the request query is invalid. |
401 | |
403 | You do not have permission to access this resource. |
404 |
|
Optional params
fetch-request
1await fetch("https://api.vercel.com/v1/deployments/dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6/checks/check_2qn7PZrx89yxY34vEZPD31Y9XVj6/rerequest?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {2 "headers": {3 "Authorization": "Bearer <TOKEN>"4 },5 "method": "post"6})
Update an existing check. This endpoint must be called with an OAuth2 or it will produce a 400 error.
Optional params
fetch-request
1await fetch("https://api.vercel.com/v1/deployments/dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6/checks/check_2qn7PZrx89yxY34vEZPD31Y9XVj6?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {2 "body": {3 "conclusion": "canceled",4 "detailsUrl": "https://example.com/check/run/1234abc",5 "externalId": "1234abc",6 "name": "Performance Check",7 "output": {8 "metrics": {9 "FCP": {10 "value": 1200,11 "previousValue": 900,12 "source": "web-vitals"13 },14 "LCP": {15 "value": 1200,16 "previousValue": 1000,17 "source": "web-vitals"18 },19 "CLS": {20 "value": 4,21 "previousValue": 2,22 "source": "web-vitals"23 },24 "TBT": {25 "value": 3000,26 "previousValue": 3500,27 "source": "web-vitals"28 },29 "virtualExperienceScore": {30 "value": 30,31 "previousValue": 35,32 "source": "web-vitals"33 }34 }35 },36 "path": "/",37 "status": "running"38 },39 "headers": {40 "Authorization": "Bearer <TOKEN>"41 },42 "method": "patch"43})
Path Parameter | Description |
---|---|
checkId | string requiredThe check being updated Example: check_2qn7PZrx89yxY34vEZPD31Y9XVj6 |
deploymentId | string requiredThe deployment to update the check for. Example: dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6 |
blockingbooleanRequired completedAtnumber conclusionstring One of: canceled
|failed
|neutral
|succeeded
|skipped
|stale
createdAtnumberRequired deploymentIdstringRequired detailsUrlstring externalIdstring idstringRequired integrationIdstringRequired namestringRequired outputobject pathstring rerequestableboolean startedAtnumber statusstringRequired One of: registered
|running
|completed
updatedAtnumberRequired
Code | Description |
---|---|
200 | |
400 |
|
401 | |
403 | You do not have permission to access this resource. |
404 |
|
413 | The output provided is too large |
Optional params
fetch-request
1await fetch("https://api.vercel.com/v1/deployments/dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6/checks/check_2qn7PZrx89yxY34vEZPD31Y9XVj6?slug=SOME_STRING_VALUE&teamId=SOME_STRING_VALUE", {2 "body": {3 "conclusion": "canceled",4 "detailsUrl": "https://example.com/check/run/1234abc",5 "externalId": "1234abc",6 "name": "Performance Check",7 "output": {8 "metrics": {9 "FCP": {10 "value": 1200,11 "previousValue": 900,12 "source": "web-vitals"13 },14 "LCP": {15 "value": 1200,16 "previousValue": 1000,17 "source": "web-vitals"18 },19 "CLS": {20 "value": 4,21 "previousValue": 2,22 "source": "web-vitals"23 },24 "TBT": {25 "value": 3000,26 "previousValue": 3500,27 "source": "web-vitals"28 },29 "virtualExperienceScore": {30 "value": 30,31 "previousValue": 35,32 "source": "web-vitals"33 }34 }35 },36 "path": "/",37 "status": "running"38 },39 "headers": {40 "Authorization": "Bearer <TOKEN>"41 },42 "method": "patch"43})
Was this helpful?