Skip to content
Docs

List job definitions for an invocation attempt

GEThttps://api.vercel.com/v1/vercel-ci/invocations/{invocationId}/attempts/{attempt}/job-definitions
List Job Definitions
Request
import { Vercel } from "@vercel/sdk";
const vercel = new Vercel({
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await vercel.vercelCi.listVercelCiJobDefinitions({
invocationId: "<id>",
attempt: "<value>",
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
slug: "my-team-url-slug",
});
console.log(result);
}
run();
Response
{
"jobDefinitions": [
{
"invocationId": "example_id",
"invocationAttempt": "123",
"jobDefinitionId": "example_id",
"kind": "string",
"name": "Example Name",
"command": "string",
"createdAt": "123"
}
]
}
Errors
{
"error": {
"code": "string",
"message": "string"
}
}
AuthorizationbearerToken

Default authentication mechanism

invocationIdstringRequired
attemptstringRequired
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.
200Successfully listed job definitions.
jobDefinitionsarrayRequired
400One of the provided values in the request query is invalid.
401The request is not authorized.
errorobjectRequired
403You do not have permission to access this resource.
errorobjectRequired
404Error
410Error
429Error
errorobjectRequired
500Error
errorobjectRequired