Skip to main content
POST
TypeScript SDK

Authorizations

Authorization
string
header
required

Enter ApiKey <your-api-key> in Authorization, including the ApiKey prefix. In cURL and Python samples, <api-key> means this full value. The TypeScript SDK adds the prefix for you.

Path Parameters

pipelineId
string
required

Pipeline ID with prefix pl..

Pattern: ^pl\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Body

application/json

The body is of type object.

Response

Lints of the pipeline

The lints of a pipeline after a request to run them.

checks
object[]
required

The current lint checks after this request, including retained results and newly started checks.

nodesInUse
string[]
required

Nodes on the path from Start to End. Only lints of these nodes block a deploy; lints of other nodes are reported but never block.

rejected
object[]
required

Lints that could not start, usually because their node has configuration errors.