Describe Pipeline
Retrieves details about a specific pipeline, including its configurations.
POST /api/v1/describe_pipelineRequest Body (JSON):
Section titled “Request Body (JSON):”{ "virtual_cluster_id": "vci_xxx", "pipeline_id": "pipeline-xyz"}CURL Example:
Section titled “CURL Example:”curl https://api.warpstream.com/api/v1/describe_pipeline \-H 'warpstream-api-key: XXXXXXXXXX' \-H 'Content-Type: application/json' \-d '{"virtual_cluster_id": "vci_xxx", "pipeline_id": "pipeline-xyz"}'Response Body (JSON):
Section titled “Response Body (JSON):”{ "pipeline_overview": { "id": "pipeline-xyz", "name": "my-pipeline", "state": "running", "type": "bento", "deployed_configuration_id": "config-123" }, "pipeline_configurations": [ { "id": "config-123", "version": 1, "configuration_yaml": "input: kafka_franz: seed_brokers: ["localhost:9092"] topics: ["test_topic"] consumer_group: "test_topic_cap"
processors: - mapping: "root = content().capitalize()"
output: kafka_franz: seed_brokers: ["localhost:9092"] topic: "test_topic_capitalized" " }, // ... other configurations (if any) ]}