Link Search Menu Expand Document

Pipelines

A pipeline is a workspace-specific configuration or definition for extracting, loading and transforming data from a given dataplugin - following the concept of ELT. Pipelines are run as jobs to load data into a workspace, either manually or on a predetermined schedule. Only a single pipeline can be run at any given time.


Objects

Pipeline

Path Type Format Description
id String Version 4 UUID The pipeline ID
status String Pipeline Status  
name String   The pipeline name
schedule String Cron The interval at which to launch a new job e.g. 0 0 9-17 * * MON-FRI launches a job on the hour nine-to-five weekdays
timeout Integer Unsigned The number of seconds after which the job will terminate - if set to 0, an implicit default value of 300 seconds is used
script String Bash Custom script to be executed as the pipeline job
created String ISO 8601 timestamp When the pipeline was created
lastModified String ISO 8601 timestamp When the pipeline was last modified
properties Properties   The properties to run the pipeline with, defined by the pipeline dataplugin settings
dataSource String   The pipeline data source dataplugin name
dataStore String Version 4 UUID The pipeline datastore id
_embedded.dataSource DataPlugin   The pipeline data source dataplugin
_embedded.dataStore DataStore   The pipeline data store
_embedded.'latest job' Job   The latest job run from the pipeline
{
  "id" : "54f8c145-6520-48c9-b235-1ed95c5d2bbf",
  "status" : "READY",
  "name" : "SIT-generated pipeline (updated)",
  "schedule" : "0 0 0 25 12 ?",
  "timeout" : 0,
  "created" : "2022-01-21T09:36:18.779905",
  "lastModified" : "2022-01-21T09:36:18.779905",
  "properties" : {
    "end_date" : "2022-01-21T09:34:10.203059Z",
    "oauth_credentials.access_token" : "access_token",
    "reports" : "reports",
    "oauth_credentials.refresh_token" : "refresh_token",
    "view_id" : "1234567890",
    "oauth_credentials.client_id" : "client_id",
    "oauth_credentials.client_secret" : "client_secret",
    "start_date" : "2021-12-21T09:34:10.203005Z"
  },
  "dataSource" : "tap-google-analytics",
  "dataStore" : "b28aa8f7-e78a-41ad-839e-cf607b899d1a",
  "_embedded" : {
    "dataSource" : {
      "name" : "tap-google-analytics",
      "label" : "Google Analytics",
      "imageUrl" : "/assets/images/datasource/tap-google-analytics.svg",
      "description" : "App and website analytics platform hosted by Google\n\n## Prerequisites\n\nBefore importing data from Google Analytics you or your webmaster will need to have performed some initial setup to grant\nyourself access to the Google Analytics for your website.\n\n[Google Analytics Prerequisites](https://www.matatika.com/docs/data-sources/tap-google-analytics/prerequisites)\n\n## Data source settings\n\n### View ID\n\nOnce you have connected with your google account, the `View ID` drop down will allow you to choose which view you want to get your data from.\n\n### Start Date\n\nProviding a start date allows you to set how much historical data you wish to import into you workspace. \n\nThis date has to be in the ISO-8601 date format, see the example below.\n\nFormat: `YYYY-MM-DDTHH:MM:SSZ`\n\nExample: `2020-10-01T13:12:11Z`\n\n### End Date\n\nProviding an end date allows you to limit how much data you wish to import into you workspace. \n\nThis date has to be in the ISO-8601 date format, see the example below.\n\nFormat: `YYYY-MM-DDTHH:MM:SSZ`\n\nExample: `2020-10-01T13:12:11Z`\n\n### Reports\n\nProviding the path to a reports json file allows you to supply the tap with a user defined definition of tables and information you want to sync from Google Analytics.\n\nThis does require you to commit a file to your workspace repository so that Google Analytics can find it during run time, and may also break the dbt transforms that are required to have our included datasets work.\n\nFor more information on how to define a custom reports file see the [Meltano Hub Documentation](https://hub.meltano.com/extractors/google-analytics#reports).\n\n## Learn more\n\nLearn more about the Google Analytics data source\n\n[Google Analytics Extractor Documentation](https://hub.meltano.com/extractors/google-analytics)\n      "
    },
    "dataStore" : {
      "id" : "b28aa8f7-e78a-41ad-839e-cf607b899d1a",
      "name" : "Default",
      "loader" : "target-postgres"
    },
    "latest job" : {
      "id" : "72c5d389-5354-4003-9fd3-6757f537b688",
      "created" : "2022-01-21T09:36:19.979035",
      "type" : "PIPELINE_CONFIG",
      "exitCode" : 0,
      "status" : "COMPLETE",
      "startTime" : "2022-01-21T09:36:36.53",
      "endTime" : "2022-01-21T09:37:27.188",
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/jobs/72c5d389-5354-4003-9fd3-6757f537b688"
        },
        "delete job" : {
          "href" : "https://catalog.matatika.com/api/jobs/72c5d389-5354-4003-9fd3-6757f537b688",
          "type" : "DELETE"
        },
        "logs" : {
          "href" : "https://catalog.matatika.com/api/jobs/72c5d389-5354-4003-9fd3-6757f537b688/logs?sequence=0",
          "type" : "GET"
        }
      }
    }
  },
  "_links" : {
    "update pipeline" : {
      "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf",
      "type" : "PUT"
    },
    "delete pipeline" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf",
      "type" : "DELETE"
    },
    "draft pipeline" : {
      "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/draft",
      "type" : "PUT"
    },
    "self" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf"
    },
    "create job" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/jobs",
      "type" : "POST"
    },
    "jobs" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/jobs",
      "type" : "GET"
    },
    "verify pipeline" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/verification",
      "type" : "POST"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/subscriptions"
    },
    "datastore" : {
      "href" : "https://catalog.matatika.com/api/datastores/b28aa8f7-e78a-41ad-839e-cf607b899d1a"
    },
    "latest job" : {
      "href" : "https://catalog.matatika.com/api/jobs/72c5d389-5354-4003-9fd3-6757f537b688"
    }
  }
}

Properties

For each setting s in the dataplugin settings:

Path Type Description
s.name s.kind Refer to s.description

Formats

Pipeline Status

Value Description
READY The pipeline completed processing resource changes
PROVISIONING The pipeline is processing resource changes
FAILED The pipeline failed to process resource changes

Requests

See Also


View all pipelines in a workspace

GET

/api/workspaces/{workspace-id}/pipelines

Returns all configured pipelines in the workspace {workspace-id}.

Prerequisites

  • Workspace {workspace-id} must exist

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'
  • Python (requests)
import requests

url = "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Pipeline collection with HAL links.

{
  "_embedded" : {
    "pipelines" : [ {
      "id" : "54f8c145-6520-48c9-b235-1ed95c5d2bbf",
      "status" : "READY",
      "name" : "SIT-generated pipeline (updated)",
      "schedule" : "0 0 0 25 12 ?",
      "timeout" : 0,
      "created" : "2022-01-21T09:36:18.779905",
      "lastModified" : "2022-01-21T09:36:18.779905",
      "properties" : { },
      "dataSource" : "tap-google-analytics",
      "dataStore" : "b28aa8f7-e78a-41ad-839e-cf607b899d1a",
      "_embedded" : {
        "dataSource" : {
          "name" : "tap-google-analytics",
          "label" : "Google Analytics",
          "imageUrl" : "/assets/images/datasource/tap-google-analytics.svg",
          "description" : "App and website analytics platform hosted by Google\n\n## Prerequisites\n\nBefore importing data from Google Analytics you or your webmaster will need to have performed some initial setup to grant\nyourself access to the Google Analytics for your website.\n\n[Google Analytics Prerequisites](https://www.matatika.com/docs/data-sources/tap-google-analytics/prerequisites)\n\n## Data source settings\n\n### View ID\n\nOnce you have connected with your google account, the `View ID` drop down will allow you to choose which view you want to get your data from.\n\n### Start Date\n\nProviding a start date allows you to set how much historical data you wish to import into you workspace. \n\nThis date has to be in the ISO-8601 date format, see the example below.\n\nFormat: `YYYY-MM-DDTHH:MM:SSZ`\n\nExample: `2020-10-01T13:12:11Z`\n\n### End Date\n\nProviding an end date allows you to limit how much data you wish to import into you workspace. \n\nThis date has to be in the ISO-8601 date format, see the example below.\n\nFormat: `YYYY-MM-DDTHH:MM:SSZ`\n\nExample: `2020-10-01T13:12:11Z`\n\n### Reports\n\nProviding the path to a reports json file allows you to supply the tap with a user defined definition of tables and information you want to sync from Google Analytics.\n\nThis does require you to commit a file to your workspace repository so that Google Analytics can find it during run time, and may also break the dbt transforms that are required to have our included datasets work.\n\nFor more information on how to define a custom reports file see the [Meltano Hub Documentation](https://hub.meltano.com/extractors/google-analytics#reports).\n\n## Learn more\n\nLearn more about the Google Analytics data source\n\n[Google Analytics Extractor Documentation](https://hub.meltano.com/extractors/google-analytics)\n      "
        },
        "dataStore" : {
          "id" : "b28aa8f7-e78a-41ad-839e-cf607b899d1a",
          "name" : "Default",
          "loader" : "target-postgres"
        },
        "latest job" : {
          "id" : "72c5d389-5354-4003-9fd3-6757f537b688",
          "created" : "2022-01-21T09:36:19.979035",
          "type" : "PIPELINE_CONFIG",
          "exitCode" : 0,
          "status" : "COMPLETE",
          "startTime" : "2022-01-21T09:36:36.53",
          "endTime" : "2022-01-21T09:37:27.188"
        }
      },
      "_links" : {
        "update pipeline" : {
          "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf",
          "type" : "PUT"
        },
        "delete pipeline" : {
          "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf",
          "type" : "DELETE"
        },
        "draft pipeline" : {
          "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/draft",
          "type" : "PUT"
        },
        "self" : {
          "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf"
        },
        "create job" : {
          "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/jobs",
          "type" : "POST"
        },
        "jobs" : {
          "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/jobs",
          "type" : "GET"
        },
        "verify pipeline" : {
          "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/verification",
          "type" : "POST"
        },
        "add subscription" : {
          "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/subscriptions"
        },
        "datastore" : {
          "href" : "https://catalog.matatika.com/api/datastores/b28aa8f7-e78a-41ad-839e-cf607b899d1a"
        },
        "latest job" : {
          "href" : "https://catalog.matatika.com/api/jobs/72c5d389-5354-4003-9fd3-6757f537b688"
        }
      }
    }, {
      "id" : "ca757141-4006-4172-a502-46835c46f40a",
      "status" : "DRAFT",
      "name" : "SIT-generated pipeline (updated)",
      "schedule" : "0 0 0 25 12 ?",
      "timeout" : 0,
      "created" : "2022-01-21T09:34:10.396854",
      "lastModified" : "2022-01-21T09:34:10.396854",
      "properties" : { },
      "dataSource" : "tap-google-analytics",
      "dataStore" : "b28aa8f7-e78a-41ad-839e-cf607b899d1a",
      "_embedded" : {
        "dataSource" : {
          "name" : "tap-google-analytics",
          "label" : "Google Analytics",
          "imageUrl" : "/assets/images/datasource/tap-google-analytics.svg",
          "description" : "App and website analytics platform hosted by Google\n\n## Prerequisites\n\nBefore importing data from Google Analytics you or your webmaster will need to have performed some initial setup to grant\nyourself access to the Google Analytics for your website.\n\n[Google Analytics Prerequisites](https://www.matatika.com/docs/data-sources/tap-google-analytics/prerequisites)\n\n## Data source settings\n\n### View ID\n\nOnce you have connected with your google account, the `View ID` drop down will allow you to choose which view you want to get your data from.\n\n### Start Date\n\nProviding a start date allows you to set how much historical data you wish to import into you workspace. \n\nThis date has to be in the ISO-8601 date format, see the example below.\n\nFormat: `YYYY-MM-DDTHH:MM:SSZ`\n\nExample: `2020-10-01T13:12:11Z`\n\n### End Date\n\nProviding an end date allows you to limit how much data you wish to import into you workspace. \n\nThis date has to be in the ISO-8601 date format, see the example below.\n\nFormat: `YYYY-MM-DDTHH:MM:SSZ`\n\nExample: `2020-10-01T13:12:11Z`\n\n### Reports\n\nProviding the path to a reports json file allows you to supply the tap with a user defined definition of tables and information you want to sync from Google Analytics.\n\nThis does require you to commit a file to your workspace repository so that Google Analytics can find it during run time, and may also break the dbt transforms that are required to have our included datasets work.\n\nFor more information on how to define a custom reports file see the [Meltano Hub Documentation](https://hub.meltano.com/extractors/google-analytics#reports).\n\n## Learn more\n\nLearn more about the Google Analytics data source\n\n[Google Analytics Extractor Documentation](https://hub.meltano.com/extractors/google-analytics)\n      "
        },
        "dataStore" : {
          "id" : "b28aa8f7-e78a-41ad-839e-cf607b899d1a",
          "name" : "Default",
          "loader" : "target-postgres"
        },
        "latest job" : {
          "id" : "2351f606-4c8e-4f26-99cd-efba856861e6",
          "created" : "2022-01-21T09:34:11.609566",
          "type" : "PIPELINE_CONFIG",
          "exitCode" : 0,
          "status" : "COMPLETE",
          "startTime" : "2022-01-21T09:34:27.228",
          "endTime" : "2022-01-21T09:36:16.849"
        }
      },
      "_links" : {
        "update pipeline" : {
          "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/ca757141-4006-4172-a502-46835c46f40a",
          "type" : "PUT"
        },
        "delete pipeline" : {
          "href" : "https://catalog.matatika.com/api/pipelines/ca757141-4006-4172-a502-46835c46f40a",
          "type" : "DELETE"
        },
        "draft pipeline" : {
          "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/ca757141-4006-4172-a502-46835c46f40a/draft",
          "type" : "PUT"
        },
        "self" : {
          "href" : "https://catalog.matatika.com/api/pipelines/ca757141-4006-4172-a502-46835c46f40a"
        },
        "jobs" : {
          "href" : "https://catalog.matatika.com/api/pipelines/ca757141-4006-4172-a502-46835c46f40a/jobs",
          "type" : "GET"
        },
        "verify pipeline" : {
          "href" : "https://catalog.matatika.com/api/pipelines/ca757141-4006-4172-a502-46835c46f40a/verification",
          "type" : "POST"
        },
        "add subscription" : {
          "href" : "https://catalog.matatika.com/api/pipelines/ca757141-4006-4172-a502-46835c46f40a/subscriptions"
        },
        "datastore" : {
          "href" : "https://catalog.matatika.com/api/datastores/b28aa8f7-e78a-41ad-839e-cf607b899d1a"
        },
        "latest job" : {
          "href" : "https://catalog.matatika.com/api/jobs/2351f606-4c8e-4f26-99cd-efba856861e6"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines?page=0&size=20&sort=name,asc"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 2,
    "totalPages" : 1,
    "number" : 0
  }
}

View a pipeline

GET

/api/pipelines/{pipeline-id}

Returns the pipeline {pipeline-id}.

Prerequisites

  • Pipeline {pipeline-id} must exist

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'
  • Python (requests)
import requests

url = "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Pipeline with HAL links.

{
  "id" : "54f8c145-6520-48c9-b235-1ed95c5d2bbf",
  "status" : "READY",
  "name" : "SIT-generated pipeline (updated)",
  "schedule" : "0 0 0 25 12 ?",
  "timeout" : 0,
  "created" : "2022-01-21T09:36:18.779905",
  "lastModified" : "2022-01-21T09:36:18.779905",
  "properties" : {
    "end_date" : "2022-01-21T09:34:10.203059Z",
    "oauth_credentials.access_token" : "access_token",
    "reports" : "reports",
    "oauth_credentials.refresh_token" : "refresh_token",
    "view_id" : "1234567890",
    "oauth_credentials.client_id" : "client_id",
    "oauth_credentials.client_secret" : "client_secret",
    "start_date" : "2021-12-21T09:34:10.203005Z"
  },
  "dataSource" : "tap-google-analytics",
  "dataStore" : "b28aa8f7-e78a-41ad-839e-cf607b899d1a",
  "_embedded" : {
    "dataSource" : {
      "name" : "tap-google-analytics",
      "label" : "Google Analytics",
      "imageUrl" : "/assets/images/datasource/tap-google-analytics.svg",
      "description" : "App and website analytics platform hosted by Google\n\n## Prerequisites\n\nBefore importing data from Google Analytics you or your webmaster will need to have performed some initial setup to grant\nyourself access to the Google Analytics for your website.\n\n[Google Analytics Prerequisites](https://www.matatika.com/docs/data-sources/tap-google-analytics/prerequisites)\n\n## Data source settings\n\n### View ID\n\nOnce you have connected with your google account, the `View ID` drop down will allow you to choose which view you want to get your data from.\n\n### Start Date\n\nProviding a start date allows you to set how much historical data you wish to import into you workspace. \n\nThis date has to be in the ISO-8601 date format, see the example below.\n\nFormat: `YYYY-MM-DDTHH:MM:SSZ`\n\nExample: `2020-10-01T13:12:11Z`\n\n### End Date\n\nProviding an end date allows you to limit how much data you wish to import into you workspace. \n\nThis date has to be in the ISO-8601 date format, see the example below.\n\nFormat: `YYYY-MM-DDTHH:MM:SSZ`\n\nExample: `2020-10-01T13:12:11Z`\n\n### Reports\n\nProviding the path to a reports json file allows you to supply the tap with a user defined definition of tables and information you want to sync from Google Analytics.\n\nThis does require you to commit a file to your workspace repository so that Google Analytics can find it during run time, and may also break the dbt transforms that are required to have our included datasets work.\n\nFor more information on how to define a custom reports file see the [Meltano Hub Documentation](https://hub.meltano.com/extractors/google-analytics#reports).\n\n## Learn more\n\nLearn more about the Google Analytics data source\n\n[Google Analytics Extractor Documentation](https://hub.meltano.com/extractors/google-analytics)\n      "
    },
    "dataStore" : {
      "id" : "b28aa8f7-e78a-41ad-839e-cf607b899d1a",
      "name" : "Default",
      "loader" : "target-postgres"
    },
    "latest job" : {
      "id" : "72c5d389-5354-4003-9fd3-6757f537b688",
      "created" : "2022-01-21T09:36:19.979035",
      "type" : "PIPELINE_CONFIG",
      "exitCode" : 0,
      "status" : "COMPLETE",
      "startTime" : "2022-01-21T09:36:36.53",
      "endTime" : "2022-01-21T09:37:27.188",
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/jobs/72c5d389-5354-4003-9fd3-6757f537b688"
        },
        "delete job" : {
          "href" : "https://catalog.matatika.com/api/jobs/72c5d389-5354-4003-9fd3-6757f537b688",
          "type" : "DELETE"
        },
        "logs" : {
          "href" : "https://catalog.matatika.com/api/jobs/72c5d389-5354-4003-9fd3-6757f537b688/logs?sequence=0",
          "type" : "GET"
        }
      }
    }
  },
  "_links" : {
    "update pipeline" : {
      "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf",
      "type" : "PUT"
    },
    "delete pipeline" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf",
      "type" : "DELETE"
    },
    "draft pipeline" : {
      "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/draft",
      "type" : "PUT"
    },
    "self" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf"
    },
    "create job" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/jobs",
      "type" : "POST"
    },
    "jobs" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/jobs",
      "type" : "GET"
    },
    "verify pipeline" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/verification",
      "type" : "POST"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/subscriptions"
    },
    "datastore" : {
      "href" : "https://catalog.matatika.com/api/datastores/b28aa8f7-e78a-41ad-839e-cf607b899d1a"
    },
    "latest job" : {
      "href" : "https://catalog.matatika.com/api/jobs/72c5d389-5354-4003-9fd3-6757f537b688"
    }
  }
}

Initialise a pipeline in a workspace

POST

/api/workspaces/{workspace-id}/pipelines

Initialises a new pipeline in the workspace {workspace-id}.

Prerequisites

  • Workspace {workspace-id} must exist

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'
  • Python (requests)
import requests

url = "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Pipeline with HAL links.

{
  "id" : "ca757141-4006-4172-a502-46835c46f40a",
  "status" : "PROVISIONING",
  "timeout" : 0,
  "created" : "2022-01-21T09:34:09.635106",
  "lastModified" : "2022-01-21T09:34:09.635107",
  "properties" : { },
  "_links" : {
    "create pipeline" : {
      "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/ca757141-4006-4172-a502-46835c46f40a",
      "type" : "PUT"
    },
    "draft pipeline" : {
      "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/ca757141-4006-4172-a502-46835c46f40a/draft",
      "type" : "PUT"
    },
    "validate pipeline" : {
      "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/validation",
      "type" : "POST"
    }
  }
}

Create or update a pipeline in a workspace

PUT

/api/workspaces/{workspace-id}/pipelines/{pipeline-id}

Creates or updates the pipeline {pipeline-id} in the workspace {workspace-id}.

Prerequisites

  • Workspace {workspace-id} must exist

Request

Body

Pipeline resource.

{
  "name" : "SIT-generated pipeline",
  "dataSource" : "tap-google-analytics",
  "schedule" : "0 0 0 25 12 ?",
  "properties" : {
    "end_date" : "2022-01-21T09:34:10.203059Z",
    "oauth_credentials.access_token" : "access_token",
    "reports" : "reports",
    "view_id" : "1234567890",
    "oauth_credentials.refresh_token" : "refresh_token",
    "oauth_credentials.client_id" : "client_id",
    "oauth_credentials.client_secret" : "client_secret",
    "start_date" : "2021-12-21T09:34:10.203005Z"
  }
}

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/ca757141-4006-4172-a502-46835c46f40a' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "SIT-generated pipeline",
  "dataSource" : "tap-google-analytics",
  "schedule" : "0 0 0 25 12 ?",
  "properties" : {
    "end_date" : "2022-01-21T09:34:10.203059Z",
    "oauth_credentials.access_token" : "access_token",
    "reports" : "reports",
    "view_id" : "1234567890",
    "oauth_credentials.refresh_token" : "refresh_token",
    "oauth_credentials.client_id" : "client_id",
    "oauth_credentials.client_secret" : "client_secret",
    "start_date" : "2021-12-21T09:34:10.203005Z"
  }
}'
  • Python (requests)
import requests

url = "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/ca757141-4006-4172-a502-46835c46f40a"

data = {
  "name" : "SIT-generated pipeline",
  "dataSource" : "tap-google-analytics",
  "schedule" : "0 0 0 25 12 ?",
  "properties" : {
    "end_date" : "2022-01-21T09:34:10.203059Z",
    "oauth_credentials.access_token" : "access_token",
    "reports" : "reports",
    "view_id" : "1234567890",
    "oauth_credentials.refresh_token" : "refresh_token",
    "oauth_credentials.client_id" : "client_id",
    "oauth_credentials.client_secret" : "client_secret",
    "start_date" : "2021-12-21T09:34:10.203005Z"
  }
}
headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("PUT", url, headers=headers, data=data)

print(response.text.encode('utf8'))

Response

200 OK / 201 Created

Pipeline with HAL links.

{
  "id" : "ca757141-4006-4172-a502-46835c46f40a",
  "status" : "PROVISIONING",
  "name" : "SIT-generated pipeline",
  "schedule" : "0 0 0 25 12 ?",
  "timeout" : 0,
  "created" : "2022-01-21T09:34:10.396854",
  "lastModified" : "2022-01-21T09:34:10.396854",
  "properties" : {
    "end_date" : "2022-01-21T09:34:10.203059Z",
    "oauth_credentials.access_token" : "access_token",
    "reports" : "reports",
    "oauth_credentials.refresh_token" : "refresh_token",
    "view_id" : "1234567890",
    "oauth_credentials.client_id" : "client_id",
    "oauth_credentials.client_secret" : "client_secret",
    "start_date" : "2021-12-21T09:34:10.203005Z"
  },
  "dataSource" : "tap-google-analytics",
  "dataStore" : "b28aa8f7-e78a-41ad-839e-cf607b899d1a",
  "_embedded" : {
    "dataSource" : {
      "name" : "tap-google-analytics",
      "label" : "Google Analytics",
      "imageUrl" : "/assets/images/datasource/tap-google-analytics.svg",
      "description" : "App and website analytics platform hosted by Google\n\n## Prerequisites\n\nBefore importing data from Google Analytics you or your webmaster will need to have performed some initial setup to grant\nyourself access to the Google Analytics for your website.\n\n[Google Analytics Prerequisites](https://www.matatika.com/docs/data-sources/tap-google-analytics/prerequisites)\n\n## Data source settings\n\n### View ID\n\nOnce you have connected with your google account, the `View ID` drop down will allow you to choose which view you want to get your data from.\n\n### Start Date\n\nProviding a start date allows you to set how much historical data you wish to import into you workspace. \n\nThis date has to be in the ISO-8601 date format, see the example below.\n\nFormat: `YYYY-MM-DDTHH:MM:SSZ`\n\nExample: `2020-10-01T13:12:11Z`\n\n### End Date\n\nProviding an end date allows you to limit how much data you wish to import into you workspace. \n\nThis date has to be in the ISO-8601 date format, see the example below.\n\nFormat: `YYYY-MM-DDTHH:MM:SSZ`\n\nExample: `2020-10-01T13:12:11Z`\n\n### Reports\n\nProviding the path to a reports json file allows you to supply the tap with a user defined definition of tables and information you want to sync from Google Analytics.\n\nThis does require you to commit a file to your workspace repository so that Google Analytics can find it during run time, and may also break the dbt transforms that are required to have our included datasets work.\n\nFor more information on how to define a custom reports file see the [Meltano Hub Documentation](https://hub.meltano.com/extractors/google-analytics#reports).\n\n## Learn more\n\nLearn more about the Google Analytics data source\n\n[Google Analytics Extractor Documentation](https://hub.meltano.com/extractors/google-analytics)\n      "
    },
    "dataStore" : {
      "id" : "b28aa8f7-e78a-41ad-839e-cf607b899d1a",
      "name" : "Default",
      "loader" : "target-postgres"
    },
    "latest job" : {
      "id" : "2351f606-4c8e-4f26-99cd-efba856861e6",
      "created" : "2022-01-21T09:34:11.609566",
      "type" : "PIPELINE_CONFIG",
      "status" : "QUEUED",
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/jobs/2351f606-4c8e-4f26-99cd-efba856861e6"
        },
        "delete job" : {
          "href" : "https://catalog.matatika.com/api/jobs/2351f606-4c8e-4f26-99cd-efba856861e6",
          "type" : "DELETE"
        },
        "logs" : {
          "href" : "https://catalog.matatika.com/api/jobs/2351f606-4c8e-4f26-99cd-efba856861e6/logs?sequence=0",
          "type" : "GET"
        },
        "withdraw job" : {
          "href" : "https://catalog.matatika.com/api/jobs/2351f606-4c8e-4f26-99cd-efba856861e6/stopped",
          "type" : "PUT"
        }
      }
    }
  },
  "_links" : {
    "update pipeline" : {
      "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/ca757141-4006-4172-a502-46835c46f40a",
      "type" : "PUT"
    },
    "delete pipeline" : {
      "href" : "https://catalog.matatika.com/api/pipelines/ca757141-4006-4172-a502-46835c46f40a",
      "type" : "DELETE"
    },
    "draft pipeline" : {
      "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/ca757141-4006-4172-a502-46835c46f40a/draft",
      "type" : "PUT"
    },
    "self" : {
      "href" : "https://catalog.matatika.com/api/pipelines/ca757141-4006-4172-a502-46835c46f40a"
    },
    "jobs" : {
      "href" : "https://catalog.matatika.com/api/pipelines/ca757141-4006-4172-a502-46835c46f40a/jobs",
      "type" : "GET"
    },
    "verify pipeline" : {
      "href" : "https://catalog.matatika.com/api/pipelines/ca757141-4006-4172-a502-46835c46f40a/verification",
      "type" : "POST"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/pipelines/ca757141-4006-4172-a502-46835c46f40a/subscriptions"
    },
    "datastore" : {
      "href" : "https://catalog.matatika.com/api/datastores/b28aa8f7-e78a-41ad-839e-cf607b899d1a"
    },
    "latest job" : {
      "href" : "https://catalog.matatika.com/api/jobs/2351f606-4c8e-4f26-99cd-efba856861e6"
    },
    "withdraw job" : {
      "href" : "https://catalog.matatika.com/api/jobs/2351f606-4c8e-4f26-99cd-efba856861e6/stopped",
      "type" : "PUT"
    }
  }
}

Create or update a pipeline as a draft

PUT

/api/workspaces/{workspace-id}/pipelines/{pipeline-id}/draft

Creates or updates the pipeline {pipeline-id} in the workspace {workspace-id} as a draft.

Prerequisites

  • Workspace {workspace-id} must exist

Request

Body

Pipeline resource.

{
  "name" : "SIT-generated pipeline",
  "dataSource" : "tap-google-analytics",
  "schedule" : "0 0 0 25 12 ?",
  "properties" : {
    "end_date" : "2022-01-21T09:34:10.203059Z",
    "oauth_credentials.access_token" : "access_token",
    "reports" : "reports",
    "view_id" : "1234567890",
    "oauth_credentials.refresh_token" : "refresh_token",
    "oauth_credentials.client_id" : "client_id",
    "oauth_credentials.client_secret" : "client_secret",
    "start_date" : "2021-12-21T09:34:10.203005Z"
  }
}

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/draft' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "SIT-generated pipeline",
  "dataSource" : "tap-google-analytics",
  "schedule" : "0 0 0 25 12 ?",
  "properties" : {
    "end_date" : "2022-01-21T09:34:10.203059Z",
    "oauth_credentials.access_token" : "access_token",
    "reports" : "reports",
    "view_id" : "1234567890",
    "oauth_credentials.refresh_token" : "refresh_token",
    "oauth_credentials.client_id" : "client_id",
    "oauth_credentials.client_secret" : "client_secret",
    "start_date" : "2021-12-21T09:34:10.203005Z"
  }
}'
  • Python (requests)
import requests

url = "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/draft"

data = {
  "name" : "SIT-generated pipeline",
  "dataSource" : "tap-google-analytics",
  "schedule" : "0 0 0 25 12 ?",
  "properties" : {
    "end_date" : "2022-01-21T09:34:10.203059Z",
    "oauth_credentials.access_token" : "access_token",
    "reports" : "reports",
    "view_id" : "1234567890",
    "oauth_credentials.refresh_token" : "refresh_token",
    "oauth_credentials.client_id" : "client_id",
    "oauth_credentials.client_secret" : "client_secret",
    "start_date" : "2021-12-21T09:34:10.203005Z"
  }
}
headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("PUT", url, headers=headers, data=data)

print(response.text.encode('utf8'))

Response

200 OK / 201 Created

Pipeline with HAL links.

{
  "id" : "54f8c145-6520-48c9-b235-1ed95c5d2bbf",
  "status" : "PROVISIONING",
  "name" : "SIT-generated pipeline",
  "schedule" : "0 0 0 25 12 ?",
  "timeout" : 0,
  "created" : "2022-01-21T09:36:18.779905",
  "lastModified" : "2022-01-21T09:36:18.779905",
  "properties" : {
    "end_date" : "2022-01-21T09:34:10.203059Z",
    "oauth_credentials.access_token" : "access_token",
    "reports" : "reports",
    "oauth_credentials.refresh_token" : "refresh_token",
    "view_id" : "1234567890",
    "oauth_credentials.client_id" : "client_id",
    "oauth_credentials.client_secret" : "client_secret",
    "start_date" : "2021-12-21T09:34:10.203005Z"
  },
  "dataSource" : "tap-google-analytics",
  "dataStore" : "b28aa8f7-e78a-41ad-839e-cf607b899d1a",
  "_embedded" : {
    "dataSource" : {
      "name" : "tap-google-analytics",
      "label" : "Google Analytics",
      "imageUrl" : "/assets/images/datasource/tap-google-analytics.svg",
      "description" : "App and website analytics platform hosted by Google\n\n## Prerequisites\n\nBefore importing data from Google Analytics you or your webmaster will need to have performed some initial setup to grant\nyourself access to the Google Analytics for your website.\n\n[Google Analytics Prerequisites](https://www.matatika.com/docs/data-sources/tap-google-analytics/prerequisites)\n\n## Data source settings\n\n### View ID\n\nOnce you have connected with your google account, the `View ID` drop down will allow you to choose which view you want to get your data from.\n\n### Start Date\n\nProviding a start date allows you to set how much historical data you wish to import into you workspace. \n\nThis date has to be in the ISO-8601 date format, see the example below.\n\nFormat: `YYYY-MM-DDTHH:MM:SSZ`\n\nExample: `2020-10-01T13:12:11Z`\n\n### End Date\n\nProviding an end date allows you to limit how much data you wish to import into you workspace. \n\nThis date has to be in the ISO-8601 date format, see the example below.\n\nFormat: `YYYY-MM-DDTHH:MM:SSZ`\n\nExample: `2020-10-01T13:12:11Z`\n\n### Reports\n\nProviding the path to a reports json file allows you to supply the tap with a user defined definition of tables and information you want to sync from Google Analytics.\n\nThis does require you to commit a file to your workspace repository so that Google Analytics can find it during run time, and may also break the dbt transforms that are required to have our included datasets work.\n\nFor more information on how to define a custom reports file see the [Meltano Hub Documentation](https://hub.meltano.com/extractors/google-analytics#reports).\n\n## Learn more\n\nLearn more about the Google Analytics data source\n\n[Google Analytics Extractor Documentation](https://hub.meltano.com/extractors/google-analytics)\n      "
    },
    "dataStore" : {
      "id" : "b28aa8f7-e78a-41ad-839e-cf607b899d1a",
      "name" : "Default",
      "loader" : "target-postgres"
    },
    "latest job" : {
      "id" : "72c5d389-5354-4003-9fd3-6757f537b688",
      "created" : "2022-01-21T09:36:19.979035",
      "type" : "PIPELINE_CONFIG",
      "status" : "QUEUED",
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/jobs/72c5d389-5354-4003-9fd3-6757f537b688"
        },
        "delete job" : {
          "href" : "https://catalog.matatika.com/api/jobs/72c5d389-5354-4003-9fd3-6757f537b688",
          "type" : "DELETE"
        },
        "logs" : {
          "href" : "https://catalog.matatika.com/api/jobs/72c5d389-5354-4003-9fd3-6757f537b688/logs?sequence=0",
          "type" : "GET"
        },
        "withdraw job" : {
          "href" : "https://catalog.matatika.com/api/jobs/72c5d389-5354-4003-9fd3-6757f537b688/stopped",
          "type" : "PUT"
        }
      }
    }
  },
  "_links" : {
    "update pipeline" : {
      "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf",
      "type" : "PUT"
    },
    "delete pipeline" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf",
      "type" : "DELETE"
    },
    "draft pipeline" : {
      "href" : "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/draft",
      "type" : "PUT"
    },
    "self" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf"
    },
    "jobs" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/jobs",
      "type" : "GET"
    },
    "verify pipeline" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/verification",
      "type" : "POST"
    },
    "add subscription" : {
      "href" : "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf/subscriptions"
    },
    "datastore" : {
      "href" : "https://catalog.matatika.com/api/datastores/b28aa8f7-e78a-41ad-839e-cf607b899d1a"
    },
    "latest job" : {
      "href" : "https://catalog.matatika.com/api/jobs/72c5d389-5354-4003-9fd3-6757f537b688"
    },
    "withdraw job" : {
      "href" : "https://catalog.matatika.com/api/jobs/72c5d389-5354-4003-9fd3-6757f537b688/stopped",
      "type" : "PUT"
    }
  }
}

Validate a pipeline configuration in a workspace

POST

/api/workspaces/{workspace-id}/pipelines/validation

Validates a pipeline configuration in the workspace {workspace-id}.

Prerequisites

  • Workspace {workspace-id} must exist

Request

Body

Pipeline resource.

{
  "name" : "SIT-generated pipeline",
  "dataSource" : "tap-google-analytics"
}

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/validation' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "SIT-generated pipeline",
  "dataSource" : "tap-google-analytics"
}'
  • Python (requests)
import requests

url = "https://catalog.matatika.com/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/validation"

data = {
  "name" : "SIT-generated pipeline",
  "dataSource" : "tap-google-analytics"
}
headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers, data=data)

print(response.text.encode('utf8'))

Response

200 OK

No response body provided.

400 Bad Request

Pipeline property validation errors.

{
  "timestamp" : "2022-01-21T09:34:10.170647",
  "status" : 400,
  "error" : "Bad Request",
  "message" : "Validation failed for object='pipelineResource'. Error count: 4",
  "errors" : [ {
    "codes" : [ "NotBlank.oauth_credentials.access_token", "NotBlank" ],
    "defaultMessage" : "No value given for setting",
    "objectName" : "pipelineResource",
    "field" : "properties.oauth_credentials.access_token",
    "bindingFailure" : true,
    "code" : "NotBlank"
  }, {
    "codes" : [ "NotBlank.oauth_credentials.refresh_token", "NotBlank" ],
    "defaultMessage" : "No value given for setting",
    "objectName" : "pipelineResource",
    "field" : "properties.oauth_credentials.refresh_token",
    "bindingFailure" : true,
    "code" : "NotBlank"
  }, {
    "codes" : [ "NotBlank.view_id", "NotBlank" ],
    "defaultMessage" : "No value given for setting",
    "objectName" : "pipelineResource",
    "field" : "properties.view_id",
    "bindingFailure" : true,
    "code" : "NotBlank"
  }, {
    "codes" : [ "NotBlank.start_date", "NotBlank" ],
    "defaultMessage" : "No value given for setting",
    "objectName" : "pipelineResource",
    "field" : "properties.start_date",
    "bindingFailure" : true,
    "code" : "NotBlank"
  } ],
  "path" : "/api/workspaces/80026b5f-e391-4f7b-ac88-f29246a4178d/pipelines/validation"
}

Verify a pipeline

POST

/api/pipelines/{pipeline-id}/verification

Verifies the configuration of the pipeline {pipeline-id}.

Prerequisites

  • Pipeline {pipeline-id} must exist

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com/api/pipelines/fcc06fcf-0b53-439d-8e7b-6a3c1be6f431/verification' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'
  • Python (requests)
import requests

url = "https://catalog.matatika.com/api/pipelines/fcc06fcf-0b53-439d-8e7b-6a3c1be6f431/verification"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Job with HAL links.

{
  "id" : "f31a282d-e18e-4ce3-8f68-17688210a570",
  "created" : "2022-01-21T09:28:31.957998",
  "type" : "PIPELINE_VERIFY",
  "status" : "QUEUED",
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/jobs/f31a282d-e18e-4ce3-8f68-17688210a570"
    },
    "delete job" : {
      "href" : "https://catalog.matatika.com/api/jobs/f31a282d-e18e-4ce3-8f68-17688210a570",
      "type" : "DELETE"
    },
    "logs" : {
      "href" : "https://catalog.matatika.com/api/jobs/f31a282d-e18e-4ce3-8f68-17688210a570/logs?sequence=0",
      "type" : "GET"
    },
    "withdraw job" : {
      "href" : "https://catalog.matatika.com/api/jobs/f31a282d-e18e-4ce3-8f68-17688210a570/stopped",
      "type" : "PUT"
    }
  }
}

Delete a pipeline

DELETE

/api/pipelines/{pipeline-id}

Deletes the pipeline {pipeline-id}.

Prerequisites

  • Pipeline {pipeline-id} must exist

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf' -i -X DELETE \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'
  • Python (requests)
import requests

url = "https://catalog.matatika.com/api/pipelines/54f8c145-6520-48c9-b235-1ed95c5d2bbf"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("DELETE", url, headers=headers)

print(response.text.encode('utf8'))

Response

204 No Content

No response body provided.