Skip to content

Definitions

Type to start searching

Documentation

quixio/quix-docs

Get started
Get started
- Welcome
- Installation
  Installation
  - Use command line
- Core concepts
  Core concepts
- Tutorials
  Tutorials
Quix CLI
Quix CLI
- Overview
- Build a pipeline
  Build a pipeline
- Reference guide
Quix Streams
Quix Streams
- Introduction
- Quickstart
- Tutorials
  Tutorials
- Producing Data to Kafka
- Processing & Transforming Data
- Windows & Aggregations
- Configuration
- Advanced Usage
  Advanced Usage
- Connecting to Quix Cloud
- Upgrading Guide
  Upgrading Guide
  - Upgrading from Quix Streams v0.5
- API Docs
  API Docs
Quix Cloud
Quix Cloud
- Overview
- Quickstart
- Quix Tour
  Quix Tour
- Build a pipeline
  Build a pipeline
  - 1. Create your project
    1. Create your project
    
    Overview
    
    Clone a project
    
    Fork a project
    
    Create a project
    
    Create an environment
    
    Protected environments
    
    Syncing an environment
    
    Project structure
    
    Create a topic
  - 2. Develop a pipeline
    2. Develop a pipeline
    
    Overview
    
    Create an application
    
    Authentication
    Authentication
    
    Authenticating Quix Streams
    
    Personal Access Token (PAT)
    
    Streaming Token
    
    Using Code Samples
    
    Integrate your data
    Integrate your data
    
    Overview
    
    Ingest your data - source
    Ingest your data - source
    
    Using a prebuilt source connector
    
    Reading a CSV file
    
    Polling a REST API
    
    Handling inbound webhooks
    
    Using an external source
    
    Using the Quix Streaming APIs
    
    Using Quix Streams
    
    Posting data to a Quix web app
    
    Publish your data - sink
    Publish your data - sink
    
    Using a prebuilt destination connector
    
    Using an external destination
    
    Exporting Quix data to Jupyter notebooks
    
    Process your data
    Process your data
    
    Overview
    
    Types of processing
    
    Types of transform
    
    Generating events
    
    Using Quix Streaming APIs
    Using Quix Streaming APIs
    
    Overview
    
    Streaming Writer API
    Streaming Writer API
    
    Overview
    
    Setup
    
    HTTP requests
    
    Create a new Stream
    
    Add Stream metadata
    
    Send Parameter data
    
    Send an Event
    
    Streaming Reader API
    Streaming Reader API
    
    Overview
    
    Setup
    
    Reading data
    
    Subscription and events
  - 3. Deploy a pipeline
    3. Deploy a pipeline
    
    Overview
    
    Environment variables
    
    Secrets management
    
    YAML variables
    
    State management
    
    Deploy public services
  - 4. Manage your pipelines
    4. Manage your pipelines
    
    Overview
    
    Troubleshooting
    
    Security
    
    MLOps
    
    Using replay service
    
    Testing using Quix data store
    
    Testing multiple environments
    
    Query API
    Query API
    
    Overview
    
    Setup
    
    HTTP requests
    
    Paged streams
    
    Filtered streams
    
    Streams with models
    
    Raw data
    
    Aggregate data by time
    
    Aggregate data by tags
    
    Tag filtering
    
    Portal API
    Portal API
    
    Overview
    
    Setup
    
    HTTP requests
Connectors
Connectors
- Sources
  Sources
- Destinations
  Destinations
Integrations
Integrations
- Overview
- Brokers
  Brokers
  - Overview
  - Broker settings
  - Quix
  - Confluent
  - Redpanda
  - Aiven
  - Upstash
- Databases
  Databases
  - InfluxDB
    InfluxDB
    
    Overview
    
    Quickstart
    
    Guides
    Guides
    
    Using Telegraf
    
    Replacing Flux
    
    Replacing Kapacitor
    
    Alerting
    
    Migrating from v2 to v3
Bring Your Own Cluster (BYOC)
Bring Your Own Cluster (BYOC)
Knowledge base
Knowledge base
- Guides
  Guides
- Reference
  Reference
  - Glossary
  - Contribute
- Tutorials
  Tutorials
  - Overview
  - Event detection and alerting featuring InfluxDB and PagerDuty
    Event detection and alerting featuring InfluxDB and PagerDuty
    
    Overview
    
    1. Write the Python client
    
    2. Add an external source
    
    3. Add InfluxDB destination
    
    4. Add threshold detection
    
    5. Add PagerDuty alerting
    
    6. Summary
  - Migrating InfluxDB v2 to v3
    Migrating InfluxDB v2 to v3
    
    Overview
    
    1. Install InfluxDB v2
    
    2. Create the project
    
    3. Add InfluxDB v2 source
    
    4. Add InfluxDB v3 destination
    
    5. Summary
  - Vector Store Embeddings
  - Predictive maintenance
    Predictive maintenance
    
    Overview
    
    1. Get the project
    
    2. Data generator
    
    3. Downsampling
    
    4. Forecast
    
    5. Alerts
    
    6. InfluxDB - raw data
    
    7. InfluxDB - alerts
    
    8. Summary

Overview - Portal API

The Portal API gives access to the Portal interface, enabling you to programmatically control projects, environments, applications, and deployments.

Was this page helpful?

Thanks for your feedback!

Thanks for your feedback!
Help us improve this page by letting us know what went wrong in our Quix Community.

© 2020 - 2024 Quix Analytics, Ltd. Privacy Terms License Terms Cookie settings

Slack

Cookie consent

We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.

Google Analytics
Posthog
GitHub

Manage settings