List streaming pipeline definitions

Gets a page of streaming pipeline definitions in the account and project

GET /v1/projects/{projectId}/streaming-pipelines

List streaming pipeline definitions

cURL

curl --request GET \
  --url https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/streaming-pipelines \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/streaming-pipelines"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/streaming-pipelines', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/streaming-pipelines",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/streaming-pipelines"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/streaming-pipelines")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/streaming-pipelines")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "page": 1,
  "results": [
    {
      "advancedProperties": {
        "max.batch.size": 10000
      },
      "agentId": "12345678-1234-1234-1234-123456789012",
      "name": "A Streaming Pipeline",
      "projectId": "12345678-1234-1234-1234-123456789012",
      "streamingPipelineId": "12345678-1234-1234-1234-123456789012",
      "streamingSource": {
        "connection": {
          "host": "127.0.0.1",
          "password": {
            "secretName": "the-secret-name",
            "secretKey": "the-secret-key",
            "secretLocation": "the-secret-location"
          },
          "port": 8471,
          "username": "db2_streaming_user",
          "jdbcProperties": {
            "date format": "ymd"
          }
        },
        "tables": [
          {
            "schema": "SCHEMA_A",
            "table": "TABLE_A"
          }
        ]
      },
      "streamingTarget": {
        "accountKey": {
          "secretName": "the-secret-name",
          "secretKey": "the-secret-key",
          "secretLocation": "the-secret-location"
        },
        "accountName": "abs-account-name",
        "container": "streaming-container",
        "prefix": "streaming-prefix"
      }
    }
  ],
  "size": 50,
  "total": 472
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

a valid bearer token

Path Parameters

projectId · string<uuid> · required

The ID of the project in which to list the streaming pipeline definitions

Query Parameters

Response

200

application/json

A page of streaming pipeline definitions. Possibly empty if no definitions exist in the account and project

page · integer<int32>

The 0-indexed page number of the returned results.

Example:

1

results · object[]

Page of results or empty.

Show child attributes

size · integer<int32>

The size of each page of results.

Example:

50

total · integer<int64>

Total number of available results across all pages.

Example:

472