Pipelines

Get a pipeline by fully qualified name

Get a pipeline by fully qualified name.

get/v1/pipelines/name/{fqn}

Request

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

Path parameters

fqnstring required

Fully qualified name of the pipeline

Query parameters

fieldsstring
Example:owners,tasks,pipelineStatus,followers,tags,extension,scheduleInterval,domains,sourceHash

Fields requested in the returned resource

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

includeRelationsstring
Example:owners:non-deleted,followers:all

Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value.

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.