LogoLogo
WarpStream.comSlackDiscordContact UsCreate Account
  • Overview
    • Introduction
    • Architecture
      • Service Discovery
      • Write Path
      • Read Path
      • Life of a Request (Simplified)
    • Change Log
  • Getting Started
    • Install the WarpStream Agent / CLI
    • Run the Demo
    • "Hello World" for Apache Kafka
  • BYOC
    • Run the Agents Locally
    • Deploy the Agents
      • Object Storage Configuration
      • Kubernetes Known Issues
      • Rolling Restarts and Upgrades
    • Infrastructure as Code
      • Terraform Provider
      • Helm charts
      • Terraform Modules
    • Monitoring
      • Pre-made Datadog Dashboard
      • Pre-made Grafana Dashboard
      • Important Metrics and Logs
      • Recommended List of Alerts
      • Monitoring Consumer Groups
      • Hosted Prometheus Endpoint
    • Client Configuration
      • Tuning for Performance
      • Configure Clients to Eliminate AZ Networking Costs
        • Force Interzone Load Balancing
      • Configuring Kafka Client ID Features
      • Known Issues
    • Authentication
      • SASL Authentication
      • Mutual TLS (mTLS)
      • Basic Authentication
    • Advanced Agent Deployment Options
      • Agent Roles
      • Agent Groups
      • Protect Data in Motion with TLS Encryption
      • Low Latency Clusters
      • Network Architecture Considerations
      • Agent Configuration Reference
      • Reducing Infrastructure Costs
      • Client Configuration Auto-tuning
    • Hosted Metadata Endpoint
    • Managed Data Pipelines
      • Cookbooks
    • Schema Registry
      • WarpStream BYOC Schema Registry
      • Schema Validation
      • WarpStream Schema Linking
    • Port Forwarding (K8s)
    • Orbit
    • Enable SAML Single Sign-on (SSO)
    • Trusted Domains
    • Diagnostics
      • GoMaxProcs
      • Small Files
  • Reference
    • ACLs
    • Billing
      • Direct billing
      • AWS Marketplace
    • Benchmarking
    • Compression
    • Protocol and Feature Support
      • Kafka vs WarpStream Configuration Reference
      • Compacted topics
    • Secrets Overview
    • Security and Privacy Considerations
    • API Reference
      • API Keys
        • Create
        • Delete
        • List
      • Virtual Clusters
        • Create
        • Delete
        • Describe
        • List
        • DescribeConfiguration
        • UpdateConfiguration
      • Virtual Clusters Credentials
        • Create
        • Delete
        • List
      • Monitoring
        • Describe All Consumer Groups
      • Pipelines
        • List Pipelines
        • Create Pipeline
        • Delete Pipeline
        • Describe Pipeline
        • Create Pipeline Configuration
        • Change Pipeline State
      • Invoices
        • Get Pending Invoice
        • Get Past Invoice
    • CLI Reference
      • warpstream agent
      • warpstream demo
      • warpstream cli
      • warpstream cli-beta
        • benchmark-consumer
        • benchmark-producer
        • console-consumer
        • console-producer
        • consumer-group-lag
        • diagnose-record
        • file-reader
        • file-scrubber
      • warpstream playground
    • Integrations
      • Arroyo
      • AWS Lambda Triggers
      • ClickHouse
      • Debezium
      • Decodable
      • DeltaStream
      • docker-compose
      • DuckDB
      • ElastiFlow
      • Estuary
      • Fly.io
      • Imply
      • InfluxDB
      • Kestra
      • Materialize
      • MinIO
      • MirrorMaker
      • MotherDuck
      • Ockam
      • OpenTelemetry Collector
      • ParadeDB
      • Parquet
      • Quix Streams
      • Railway
      • Redpanda Console
      • RisingWave
      • Rockset
      • ShadowTraffic
      • SQLite
      • Streambased
      • Streamlit
      • Timeplus
      • Tinybird
      • Upsolver
    • Partitions Auto-Scaler (beta)
    • Serverless Clusters
Powered by GitBook
On this page
  • Request Body (JSON):
  • CURL Example:
  • Response Body (JSON):
  • Create Orbit Pipeline
  • Request Body (JSON):
  • Response Body (JSON):
  • CURL Example:
  • Create Schema Linking Pipeline
  • Request Body (JSON):
  • Response Body (JSON):
  • CURL Example:

Was this helpful?

  1. Reference
  2. API Reference
  3. Pipelines

Create Pipeline

Creates a new pipeline in a virtual cluster.

POST /api/v1/create_pipeline

Request Body (JSON):

{
  "virtual_cluster_id": "vci_xxx",
  "pipeline_name": "my-pipeline"
}

CURL Example:

curl https://api.warpstream.com/api/v1/create_pipeline \
-H 'warpstream-api-key: XXXXXXXXXX' \
-H 'Content-Type: application/json' \
-d '{"virtual_cluster_id": "vci_xxx", "pipeline_name": "my-pipeline"}'

Response Body (JSON):

{
  "pipeline_id": "pipeline-xyz",
  "pipeline_name": "my-pipeline",
  "pipeline_state": "paused",
  "pipeline_type": "bento",
  "pipeline_deployed_configuration_id": "" // Initially empty
}

Create Orbit Pipeline

You can also use the create_pipeline api to create an Orbit pipeline. Simply add a pipeline_type of orbit to the request above.

POST /api/v1/create_pipeline

Request Body (JSON):

{
  "virtual_cluster_id": "vci_xxx",
  "pipeline_name": "my-pipeline",
  "pipeline_type": "orbit"
}

Response Body (JSON):

{
  "pipeline_id": "pipeline-xyz",
  "pipeline_name": "my-pipeline",
  "pipeline_state": "paused",
  "pipeline_type": "orbit",
  "pipeline_deployed_configuration_id": "" // Initially empty
}

CURL Example:

curl https://api.warpstream.com/api/v1/create_pipeline \
-H 'warpstream-api-key: XXXXXXXXXX' \
-H 'Content-Type: application/json' \
-d '{"virtual_cluster_id": "vci_xxx", "pipeline_name": "my-pipeline", "pipeline_type": "orbit"}'

Create Schema Linking Pipeline

You can also use the create_pipeline api to create a Schema Linking pipeline. Simply add a pipeline_type of schema_linking to the request above.

POST /api/v1/create_pipeline

Request Body (JSON):

{
  "virtual_cluster_id": "vci_sr_xxx",
  "pipeline_name": "my-pipeline",
  "pipeline_type": "schema_linking"
}

Response Body (JSON):

{
  "pipeline_id": "pipeline-xyz",
  "pipeline_name": "my-pipeline",
  "pipeline_state": "paused",
  "pipeline_type": "schema_linking",
  "pipeline_deployed_configuration_id": "" // Initially empty
}

CURL Example:

curl https://api.prod.us-east-1.warpstream.com/api/v1/create_pipeline \
-H 'warpstream-api-key: XXXXXXXXXX' \
-H 'Content-Type: application/json' \
-d '{"virtual_cluster_id": "vci_sr_xxx", "pipeline_name": "my-pipeline", "pipeline_type": "schema_linking"}'
PreviousList PipelinesNextDelete Pipeline

Last updated 2 months ago

Was this helpful?

Note that you can only have a single Orbit pipeline at a time. To create a new Orbit pipeline first the old one.

Note that you can only have a single Schema Linking pipeline at a time for each schema registry cluster. To create a new Schema Linking pipeline first the old one.

delete
delete