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
graph
object
required

Complete pipeline graph in version 1 of the public graph format.

Response

Validation report

Configuration errors, check status, and matching checks for a submitted pipeline graph.

checks
object[]
required

Checks whose results match the submitted graph configuration.

issues
object[]
required

Configuration and check findings for the submitted graph.

valid
boolean
required

Whether the submitted graph has no validation errors.