v1
latestOpenAPI 3.1.02026-07-22106199311.5 KBStreaming Pipelines
List streaming pipeline definitions
Gets a page of streaming pipeline definitions in the account and project
get/v1/projects/{projectId}/streaming-pipelines
Path parameters
projectIdstring uuid required
The ID of the project in which to list the streaming pipeline definitions
Query parameters
{"stackTrail":"paths:/v1/projects/{projectId}/streaming-pipelines:get:parameters:1:schema","oasType":"schema","type":"unknown"}
Page number (0-indexed)
{"stackTrail":"paths:/v1/projects/{projectId}/streaming-pipelines:get:parameters:2:schema","oasType":"schema","type":"unknown"}
Number of records per page (from 1 to 100)
Response
A page of streaming pipeline definitions. Possibly empty if no definitions exist in the account and project
Example response
{
"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",
"jdbcProperties": {
"date format": "ymd"
},
"password": {
"secretKey": "the-secret-key",
"secretLocation": "the-secret-location",
"secretName": "the-secret-name"
},
"port": 8471,
"username": "db2_streaming_user"
},
"tables": [
{
"schema": "SCHEMA_A",
"table": "TABLE_A"
}
]
},
"streamingTarget": {
"accountKey": {
"secretKey": "the-secret-key",
"secretLocation": "the-secret-location",
"secretName": "the-secret-name"
},
"accountName": "abs-account-name",
"container": "streaming-container",
"prefix": "streaming-prefix"
}
}
],
"size": 50,
"total": 472
}