The endpoints in this group document the Public Pipeline REST APIs that are available. These pipelines allow you to do things like programmatically creating many pipelines, with different parameters, from a single protocol. It also allows you to process a list of files with a given pipeline, paginate through pipeline details, and more.

Endpoints in this section are:

  • GET /v1/pipeline/{pipelineId} - Gets the details of a single pipeline.
  • GET /v1/pipeline/list - Paginate through all pipeline details.
  • POST /v1/pipeline/create - Create a new pipeline.
  • POST /v1/pipeline/update/{pipelineId} - Update an existing pipeline.
  • POST /v1/pipeline/process/{pipelineId} - Process a list of files with a pipeline.

Each of these endpoints is addressed in this topic's subsections.


Here are a few notes for public pipeline endpoints.

  • Before you use these endpoints, please familiarize yourself with pipeline basic concepts and terminology.

  • triggerCondition is used to match pipeline files to a pipeline trigger.

  • groupLevel indicates which hierarchical level the operator and group belong to. groupLevel can start with 1 and go up to 2.

  • groupOperator (AND, OR) are comparators between groups at the same level.

  • groups are a list of trigger conditions that the groupOperator is applied to.

  • Statuses:

    • disabled means the pipeline is not active.
    • null means that the pipeline is active. (null is used as a status instead of enabled).