post/v1/deployments/{deploymentId}/checks

Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error.

Optional params

fetch-request

1
await 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": true
9
},
10
"headers": {
11
"Authorization": "Bearer <TOKEN>"
12
},
13
"method": "post"
14
})
Path Params
Query Params
Body Params
Path ParameterDescription

deploymentId

string

required
The 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
  • Properties
  • pathstring
  • rerequestableboolean
  • startedAtnumber
  • statusstringRequired
    One of: registered | running | completed
  • updatedAtnumberRequired
CodeDescription
200
400
  • One of the provided values in the request body is invalid.

  • One of the provided values in the request query is invalid.

  • Cannot create check for finished deployment

  • The provided token is not from an OAuth2 Client

401
403You do not have permission to access this resource.
404The deployment was not found
get/v1/deployments/{deploymentId}/checks

List all of the checks created for a deployment.

Optional params

fetch-request

1
await 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 Params
Query Params
Path ParameterDescription

deploymentId

string

required
The deployment to get all checks for
Example:dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6
  • checksarrayRequired
  • Properties
CodeDescription
200
400One of the provided values in the request query is invalid.
401
403You do not have permission to access this resource.
404The deployment was not found
get/v1/deployments/{deploymentId}/checks/{checkId}

Return a detailed response for a single check.

Optional params

fetch-request

1
await 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 Params
Query Params
Path ParameterDescription

checkId

string

required
The check to fetch
Example:check_2qn7PZrx89yxY34vEZPD31Y9XVj6

deploymentId

string

required
The 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
  • Properties
  • pathstring
  • rerequestableboolean
  • startedAtnumber
  • statusstringRequired
    One of: registered | running | completed
  • updatedAtnumberRequired
CodeDescription
200
400One of the provided values in the request query is invalid.
401
403
  • You do not have permission to access this resource.

  • The provided token is not from an OAuth2 Client that created the Check

404
  • Check was not found

  • The deployment was not found

post/v1/deployments/{deploymentId}/checks/{checkId}/rerequest

Rerequest a selected check that has failed.

Optional params

fetch-request

1
await 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 Params
Query Params
Path ParameterDescription

checkId

string

required
The check to rerun
Example:check_2qn7PZrx89yxY34vEZPD31Y9XVj6

deploymentId

string

required
The deployment to rerun the check for.
Example:dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6
  • object
CodeDescription
200
400One of the provided values in the request query is invalid.
401
403You do not have permission to access this resource.
404
  • The deployment was not found

  • Check was not found

patch/v1/deployments/{deploymentId}/checks/{checkId}

Update an existing check. This endpoint must be called with an OAuth2 or it will produce a 400 error.

Optional params

fetch-request

1
await 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 Params
Query Params
Body Params
Path ParameterDescription

checkId

string

required
The check being updated
Example:check_2qn7PZrx89yxY34vEZPD31Y9XVj6

deploymentId

string

required
The 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
  • Properties
  • pathstring
  • rerequestableboolean
  • startedAtnumber
  • statusstringRequired
    One of: registered | running | completed
  • updatedAtnumberRequired
CodeDescription
200
400
  • One of the provided values in the request body is invalid.

  • One of the provided values in the request query is invalid.

  • The provided token is not from an OAuth2 Client

401
403You do not have permission to access this resource.
404
  • Check was not found

  • The deployment was not found

413The output provided is too large
Last updated on November 7, 2024