Pipelines

Create or update a pipeline

Create a new pipeline, if it does not exist or update an existing pipeline.

put/v1/pipelines

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/pipelines
  • Auth: HTTP bearer

Request body

namestring required
displayNamestring
descriptionstring
dataProductsstring[]
sourceUrlstring
concurrencyinteger
pipelineLocationstring
startDatestring date-time
state'Active' | 'Inactive'
servicestring required
extensionobject
scheduleIntervalstring
domainsstring[]
sourceHashstring

Response

The pipeline

idstring uuid required
namestring required
displayNamestring
fullyQualifiedNamestring
descriptionstring
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
sourceUrlstring
concurrencyinteger
pipelineLocationstring
startDatestring date-time
endDatestring date-time
state'Active' | 'Inactive'
hrefstring uri
serviceType'Airflow' | 'GluePipeline' | 'KinesisFirehose' | 'Airbyte' | 'Fivetran' | 'Flink' | 'Dagster' | 'Nifi' | 'DomoPipeline' | 'CustomPipeline' | 'DatabricksPipeline' | 'Spline' | 'Spark' | 'OpenLineage' | 'Prefect' | 'KafkaConnect' | 'DBTCloud' | 'Matillion' | 'Stitch' | 'DataFactory' | 'Wherescape' | 'SSIS' | 'Snowplow' | 'Mulesoft' | 'MicrosoftFabricPipeline' | 'SapBw4HanaPipeline'
deletedboolean
extensionobject
scheduleIntervalstring
sourceHashstring
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
provider'system' | 'user' | 'automation'

Changes

No recorded changes to this operation across all 1 revision of this API.