Retrieve details of pipelines

GET https://{controlplane_path}api/1/rest/public/catalog/{env_org}/pipelines

Retrieve list of pipelines in the environment.

Prerequisites

Environment (Org) admin permissions

Path parameters


Parameter	Description	Required
`controlplane_path`	The path to the SnapLogic control plane: `elastic.snaplogic.com` For the UAT or EMEA control plane, substitute the name for `elastic`. For example: `uat.elastic.snaplogic.com` `emea.snaplogic.com`	Yes
`org_name`	The name of the SnapLogic Environment/Org.	Yes

Query parameters

Response

A successful response includes a Code 200 OK where:

list: The list of pipelines.
page: The current page of results.
content: Each JSON object contains the data lineage for a pipeline in the OpenLineage Object Model.

 {
"size": 0,
"page": 0,
"content": [
json1, json2, json3
]
}

Example

Assuming a pipeline request in a development environment: https://elastic.snaplogicdev.com/api/1/rest/public/catalog/DEV/pipelines

    
    {
    "size": 2,
    "page": 0,
    "total_pages": 1,
    "total_elements": 2,
    "sync_status": "finished",
    "content": [
       
    {
    "name": "01.JDBC.slp_20240618142302457765",
    "path": "DEV/Automation/Lineage_JDBC",
    "pipeline_id": "c2d27ca6-1951-4e77-926d-999056f8911b",
    "snode_id": "66717c287582f450c5589dac",
    "created_by": "[email protected]",
    "updated_by": "[email protected]",
    "last_run_status": null,
    "created_at": "2024-06-18T12:23:04.535Z",
    "updated_at": "2024-06-18T12:23:04.535Z",
    "last_run_date": null,
    "sources": [
        {
            "name": "JDBC"
        }
    ],
    "targets": [
        {
            "name": "JDBC"
        }
    ],
    "accounts": [],
    "operational_data": {
        "total_executions": 0,
        "stopped_executions": 0,
        "successful_executions": 0,
        "failed_executions": 0,
        "execution_failure_rate": 0.0,
        "average_duration_ms": 0,
        "average_docs_processed": 0
    },
    "custom_metadata": {
        "LOB": "Utility"
    }
},
{
    "name": "01.JDBC.slp_20240625173717460551",
    "path": "ADM-DEV/Automation/Lineage_JDBC",
    "pipeline_id": "6e18482a-3016-430e-b041-ae125b101eaa",
    "snode_id": "667ae42f3ace493bf6dce1e7",
    "created_by": "[email protected]",
    "updated_by": "[email protected]",
    "last_run_status": null,
    "created_at": "2024-06-25T15:37:19.016Z",
    "updated_at": "2024-06-25T15:37:19.017Z",
    "last_run_date": null,
    "sources": [
        {
            "name": "JDBC"
        }
    ],
    "targets": [
        {
            "name": "JDBC"
        }
    ],
    "accounts": [],
    "operational_data": {
        "total_executions": 0,
        "stopped_executions": 0,
        "successful_executions": 0,
        "failed_executions": 0,
        "execution_failure_rate": 0.0,
        "average_duration_ms": 0,
        "average_docs_processed": 0
    },
    "custom_metadata": {
        "LOB": "Utility"
    }
    },
    },