GEgetorchestra
Pipelines

Validate pipeline schema

Changed on

Validate a pipeline definition without creating or updating a pipeline.

This endpoint does not require authentication. If you provide a credential, Orchestra also validates account-specific references such as integration connections. The endpoint is rate limited to 20 requests per minute per IP.

post/pipelines/schema

Request

  • Base URL
    https://app.getorchestra.io/api/engine/public
  • URL
    https://app.getorchestra.io/api/engine/public/pipelines/schema
  • Auth
    • none
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getorchestra.io/oauth/authorize
      Token URL: https://app.getorchestra.io/oauth/token scopes: orchestra:read

Query parameters

canonicalizeboolean

When true, a valid response also includes the pipeline serialised in Orchestra's canonical camelCase form under a 'pipeline' key.

Request body

object required

Pipeline definition JSON to validate.

Response

Successful response.

messagestring required

Example response

{
  "message": "Pipeline schema is valid"
}

Changes

  • e45165e7e223Revision changes
    • info

      the endpoint scheme security ApiKey was added to the API

    • info

      the endpoint scheme security OAuth was added to the API

    • info

      the endpoint scheme security BearerAuthReadOnly was removed from the API