Skip to main content
GET
/
v1
/
projects
/
{projectId}
/
streaming-pipelines
/
{streamingPipelineId}
Get a streaming pipeline definition
curl --request GET \
  --url https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/streaming-pipelines/{streamingPipelineId} \
  --header 'Authorization: Bearer <token>'
import requests

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

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/{streamingPipelineId}', 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/{streamingPipelineId}",
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/{streamingPipelineId}"

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/{streamingPipelineId}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

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

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
{
  "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"
  }
}
{
"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>"
]
}
{
"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 read the streaming pipeline definition

streamingPipelineId
string<uuid>
required

The ID of the streaming pipeline definition to read

Response

Successfully retrieved the streaming pipeline definition

advancedProperties
object

Any additional properties for the streaming pipeline

Example:
{ "max.batch.size": 10000 }
agentId
string<uuid>

The ID of the agent that will run the streaming pipeline

Example:

"12345678-1234-1234-1234-123456789012"

name
string

The name of the streaming pipeline

Example:

"A Streaming Pipeline"

projectId
string<uuid>

The ID of the project that contains the streaming pipeline definition

Example:

"12345678-1234-1234-1234-123456789012"

streamingPipelineId
string<uuid>

The ID of the streaming pipeline definition

Example:

"12345678-1234-1234-1234-123456789012"

streamingSource
object

The details of the streaming source

streamingTarget
object

The details of the streaming target