Ingestion Admin API

REST API that is the point of contact between users and the ingestion framework.

Through the Admin API you can create any ingestion entities (pipelines, processors, seeds, among others) and also start, stop, schedule executions.

Create a pipeline

Configuration to create a pipeline with the PDP API

Example:

{
  "name": "{Pipeline name}",
  "description": "{Pipeline description}",
  "labels": "{Pipeline labels}",
  "active": true,
  "steps": [
    {
      "processorId": "{Step id}",
      "action": "process",
      "active": true
    }
  ]
}

Configuration

name

(Required, String) Pipeline name

description

(Required, String) Pipeline description

labels

(Required, JSON) Pipeline labels

active

(Required, Boolean) Pipeline status

step.processorId

(Required, String) Processor id

step.action

(Required, String) Processor action

step.active

(Required, Boolean) Processor status

Clone seed

Request: POST /seed/{id}/clone

Path parameters

id (Required, UUID) The id of the seed to clone

Query-String Parameters

name (Optional, String) The name for the new seed

deep (Required, Boolean) If the cloning is deep or shallow