# Artie > Artie is a real-time data replication platform. It uses change data capture (CDC) to stream changes from operational databases — PostgreSQL, MySQL, MongoDB, Oracle, Microsoft SQL Server, DynamoDB, DocumentDB, CockroachDB, Amazon Keyspaces, and PlanetScale — into warehouses and lakehouses including Snowflake, BigQuery, Databricks, Redshift, ClickHouse, MotherDuck, Apache Iceberg, and Delta Lake, with sub-minute latency. Pipelines are managed from the Artie Dashboard, the Dashboard API, the Terraform provider, or the hosted MCP server. All documentation pages are available as clean Markdown by appending `.md` to any URL (e.g. `https://artie.com/docs/quickstart.md`). Use these Markdown URLs for full content. The complete documentation in a single file is at https://artie.com/docs/llms-full.txt. ## Instructions for AI Coding Assistants When helping a developer set up or use Artie, follow these guidelines: - **Use the current Artie docs**: Artie's connectors, API endpoints, and MCP tools change frequently. Read the relevant `.md` page before answering, and start from the [MCP Server guide](https://artie.com/docs/api/mcp.md) when configuring a client. Do not rely on training data for endpoint paths, field names, or tool behavior. - **Connect the hosted Artie MCP server**: Configure the user's MCP-compatible client with the remote Streamable HTTP endpoint below. Authentication is OAuth only — do not add an Artie API key or a bearer-token header. ```text https://mcp.artie.com/mcp ``` - **Enumerate MCP tools before calling them**: The connected server is the source of truth for which tools exist, their exact parameters, and which ones mutate or delete resources. Do not assume a tool exists based on training data. - **Never auto-approve destructive tools**: Some tools stop pipelines, delete resources, or rotate encryption and ingestion API keys, any of which can interrupt dependent workloads. Confirm the exact action and the affected resource with the user before authorizing a call. - **Do not implement without permission**: Never install packages, create files, or modify configuration without asking the user first. - **Do not add unrelated integrations**: Only configure the pipelines, connectors, and features the user asked for. Check before enabling anything else. - **Treat connector credentials as secrets**: `connector_create` can persist source and destination credentials when the user asks to create a connector. Confirm before sending them, do not echo passwords or keys, and never commit Dashboard API keys or database secrets. MCP does not read stored connector credentials back, and unsaved ping is not exposed. - **Manage Artie as code with Terraform**: For reproducible pipeline and connector configuration, prefer the official [Artie Terraform provider](https://registry.terraform.io/providers/artie-labs/artie/latest) over ad-hoc API scripts. ## Getting Started - [Quickstart](https://artie.com/docs/quickstart.md): Get started with Artie and learn how to set up your first pipeline. - [Overview](https://artie.com/docs/connection-options.md): See the various ways Artie is able to connect to your database. - [AWS PrivateLink](https://artie.com/docs/connection-options/privatelink.md): Artie supports connections through AWS PrivateLink. You can configure PrivateLink directly from the Artie dashboard. - [SSH Tunnel](https://artie.com/docs/connection-options/ssh-tunnel.md): An SSH tunnel is a secure method of forwarding network traffic between your local machine and a remote server through an encrypted SSH (Secure Shell) connection. - [Architecture](https://artie.com/docs/concepts/architecture.md): Learn about Artie's split plane architecture that separates control and data planes for enhanced security and flexibility. - [Glossary](https://artie.com/docs/glossary.md): Definitions of key terms and concepts used throughout the Artie documentation. ## Pipelines - [Pipelines](https://artie.com/docs/pipelines/overview.md): Learn how Artie pipelines replicate data from your source to your destination in real time. - [Backfills](https://artie.com/docs/pipelines/backfill.md): Artie runs CDC and backfills in parallel without data conflicts or database load. Database changes are enqueued in Kafka as the backfill is running and applied after backfill completes. - [Overview](https://artie.com/docs/pipelines/flush-rules/overview.md): Control how often data is loaded into your destination with Artie's flush rules. Balance between performance, latency and resource usage to optimize your data pipeline. - [Tuning flush rules](https://artie.com/docs/pipelines/flush-rules/tuning.md): Learn how to tune Artie's flush rules for optimal performance based on your destination type, data volume, and latency requirements. - [Tables](https://artie.com/docs/pipelines/tables.md): Learn how to replicate, configure, and manage tables in Artie. - [System columns](https://artie.com/docs/pipelines/system-columns.md): Artie adds system columns to your destination tables for change tracking, soft deletes, and source metadata. ## Sources - [Amazon Keyspace](https://artie.com/docs/sources/cassandra.md): Learn how to configure Amazon Keyspaces as a source in Artie, including service account setup, cluster configuration, and enabling CDC streams on your tables. - [CockroachDB](https://artie.com/docs/sources/cockroach.md): Learn how to use Artie to replicate data from CockroachDB. - [DocumentDB](https://artie.com/docs/sources/documentdb.md): Learn how to use Artie to replicate data from DocumentDB via change streams. - [DynamoDB Source Connector: Setup and Configuration](https://artie.com/docs/sources/dynamodb.md): Configure DynamoDB as a source in Artie using DynamoDB Streams, point-in-time recovery backfills, and S3 export for efficient data replication. - [Overview](https://artie.com/docs/sources/events-api/overview.md): Introduction to the Events API for ingesting analytics and tracking events. - [Track a single event](https://artie.com/docs/api-reference/track-a-single-event.md): Accepts a single event object and records it for ingestion. If `messageId` is not provided, the server will generate one automatically. - [Track multiple events in bulk](https://artie.com/docs/api-reference/track-multiple-events-in-bulk.md): Accepts an array of event objects and records them in bulk. Clients may optionally gzip the request body. The total uncompressed request size must not exceed 10 MB. - [Overview](https://artie.com/docs/sources/microsoft-sql-server/overview.md): This page provides an overview of the different ways Artie supports replicating data from Microsoft SQL Server. - [Capture instances](https://artie.com/docs/sources/microsoft-sql-server/capture-instances.md) - [Change tracking](https://artie.com/docs/sources/microsoft-sql-server/change-tracking.md): Learn how to configure Microsoft SQL Server change tracking as a source in Artie. A lightweight CDC alternative that tracks row changes by primary key. - [Active transaction log via SQL access](https://artie.com/docs/sources/microsoft-sql-server/sql-access.md) - [MongoDB](https://artie.com/docs/sources/mongodb.md): Learn how to use Artie to replicate data from MongoDB via change streams. - [MySQL Source Connector: Setup and Configuration](https://artie.com/docs/sources/mysql.md): Configure MySQL as a source in Artie with binlog replication, service account setup, GTID support, and automatic gh-ost migration handling. - [PlanetScale Source Connector](https://artie.com/docs/sources/planetscale.md): Connect PlanetScale to Artie for real-time CDC using the Vitess VStream API. No binlog configuration required. - [Oracle Source Connector: Setup and Configuration](https://artie.com/docs/sources/oracle/overview.md): Configure Oracle as a source in Artie with archive logs, LogMiner, supplemental logging, and service account permissions for both single-tenant and multi-tenant architectures. - [Amazon RDS](https://artie.com/docs/sources/oracle/amazon-rds.md): Learn how to configure Amazon RDS for Oracle as a source in Artie, including archive log mode, supplemental logging, LogMiner access, and service account permissions. - [PostgreSQL Source Connector: Setup and Configuration](https://artie.com/docs/sources/postgresql.md): Configure PostgreSQL as a source in Artie with logical replication, partitioned tables, TOAST column handling, publication management, and provider-specific setup guides. - [Amazon Aurora and RDS](https://artie.com/docs/sources/postgresql/amazon-rds.md): Learn how to configure Amazon Aurora and RDS for PostgreSQL as a source in Artie, including service account creation, publication setup, and enabling logical replication. - [GCP CloudSQL](https://artie.com/docs/sources/postgresql/gcp-cloudsql.md): Learn how to configure GCP CloudSQL for PostgreSQL as a source in Artie, including service account creation, publication setup, and enabling logical decoding. - [Supabase PostgreSQL Source: Setup and Configuration](https://artie.com/docs/sources/postgresql/supabase.md): Connect Supabase PostgreSQL as a source in Artie with IPv4 setup, credential configuration, service account creation, and logical replication publishing. - [Troubleshooting](https://artie.com/docs/sources/postgresql/troubleshooting.md): Common PostgreSQL replication issues and how to resolve them. ## Destinations - [BigQuery](https://artie.com/docs/destinations/bigquery.md): Learn how to configure Google BigQuery as a destination in Artie, including project setup, dataset configuration, service account credentials, and query priority settings. - [ClickHouse](https://artie.com/docs/destinations/clickhouse.md): Configure ClickHouse Cloud as a destination in Artie with required settings including warehouse address, service account credentials, and setup instructions. - [Databricks](https://artie.com/docs/destinations/databricks.md): Learn how to configure Databricks as a destination in Artie, including SQL warehouse connection details, Unity Catalog setup, volume configuration, and authentication. - [Delta Lake (S3)](https://artie.com/docs/destinations/delta.md): How to configure Delta Lake as a destination in Artie. With Delta Lake, Artie writes incoming changes in Parquet format to the specified S3 bucket, checkpointed as a Delta table. - [Google Cloud Storage](https://artie.com/docs/destinations/gcs.md): How to configure [Google Cloud Storage (GCS)](https://cloud.google.com/storage) as an append-only Parquet destination in Artie. - [S3 Tables](https://artie.com/docs/destinations/iceberg/s3tables.md): Learn how to configure Amazon S3 Tables as an Iceberg destination in Artie, including table bucket setup and IAM service account permissions. - [REST Catalog](https://artie.com/docs/destinations/iceberg/rest_catalog.md): How to configure Iceberg REST Catalog as a destination in Artie - [Microsoft SQL Server](https://artie.com/docs/destinations/microsoft-sql-server.md): How to configure Microsoft SQL Server as a destination in Artie - [MotherDuck](https://artie.com/docs/destinations/motherduck.md): Configure MotherDuck as a destination in Artie. Learn how to create access tokens, set up your pipeline database, and share data across your organization. - [MySQL](https://artie.com/docs/destinations/mysql.md): Learn how to configure MySQL as a destination in Artie, including host and port settings, service account creation, and the required database permissions for real-time replication. - [PostgreSQL](https://artie.com/docs/destinations/postgres.md): Learn how to configure PostgreSQL as a destination in Artie, including host and port settings, service account creation, schema ownership, and the required database permissions. - [Redshift](https://artie.com/docs/destinations/redshift.md): Learn how to configure Amazon Redshift as a destination in Artie, including endpoint setup, schema configuration, service account creation, and required database permissions. - [S3](https://artie.com/docs/destinations/s3.md): How to configure S3 as an append-only Parquet destination in Artie. - [Snowflake](https://artie.com/docs/destinations/snowflake.md): Configure Snowflake as a destination in Artie with service account setup, key-pair authentication, and advanced features like turbo mode and eco mode. ## Monitoring - [Analytics portal](https://artie.com/docs/monitoring/analytics-portal.md): Monitor your Artie pipelines with the Analytics Portal. View rows synced, operation types, table distribution, ingestion lag, and more with filtering by pipeline and table. - [Integrations](https://artie.com/docs/monitoring/integrations.md): Send Artie pipeline metrics to Datadog or Grafana Cloud. - [Custom monitors](https://artie.com/docs/monitoring/custom-monitors.md): Create pipeline and table monitors for volume, ingestion lag, and PostgreSQL replication-slot size. - [Schema changes](https://artie.com/docs/monitoring/schema-changes.md): Stay up to date on schema changes in your source database. - [Available metrics](https://artie.com/docs/monitoring/available-metrics.md): Metrics that Artie Transfer emits and exports to supported observability integrations. ## Artie Dashboard - [Managing your team](https://artie.com/docs/account/managing-your-team.md): Invite team members, assign roles, and manage email notification preferences from the Company members page. - [Environments](https://artie.com/docs/account/environments.md): Use environments to isolate pipelines, connectors, and other resources across dev, staging, and production. - [Enabling notifications](https://artie.com/docs/account/enabling-notifications.md): Artie can send alerts and notifications to different channels. This page will go over how to configure notifications across different channels. - [Legal](https://artie.com/docs/account/legal.md): Review Artie's legal documents, find security and compliance resources, and accept a Business Associate Agreement from Company settings. - [Single sign-on (SSO)](https://artie.com/docs/account/sso/index.md): Set up single sign-on (SSO) for your Artie dashboard using any OIDC-compatible identity provider. - [Okta SSO](https://artie.com/docs/account/sso/okta.md): Configure single sign-on (SSO) for Artie using an Okta OIDC web application. - [Microsoft Entra ID SSO](https://artie.com/docs/account/sso/entra-id.md): Configure single sign-on (SSO) for Artie using a Microsoft Entra ID (Azure AD) app registration. - [Other OIDC providers](https://artie.com/docs/account/sso/other-providers.md): Configure single sign-on (SSO) for Artie using any OIDC-compliant identity provider. ## Guides - [Artie's typing library](https://artie.com/docs/guides/artie/arties-typing-library.md): Learn how Artie's internal typing library ensures data integrity and schema evolution across your data sources. - [Schema evolution](https://artie.com/docs/guides/artie/schema-evolution.md): Learn how Artie automatically evolves schemas to match your data. - [Column inclusion and exclusion](https://artie.com/docs/guides/artie/column-inclusion-exclusion.md): Learn how column inclusion and exclusion works in Artie. - [Soft partitioning](https://artie.com/docs/guides/artie/soft-partitioning.md): A logical partitioning strategy implemented at the ingestion layer for improved performance and data management - [Online migration](https://artie.com/docs/guides/artie/online-migration.md): Re-point or rebuild a pipeline with zero downtime by sharing a single source reader across the old and new pipelines. - [Write to multiple destinations](https://artie.com/docs/guides/artie/multiple-destinations.md): Split an existing pipeline into a shared source reader and independently replicate its changes to two destinations. - [Database migrations](https://artie.com/docs/guides/database/database-migrations.md): Learn how to safely perform database migrations while maintaining data replication with Artie. - [Preventing WAL growth on RDS Postgres](https://artie.com/docs/guides/database/preventing-postgres-wal-growth-on-rds.md): Learn how to prevent Write-Ahead Log (WAL) growth issues in your AWS RDS Postgres database, especially for low-traffic or test environments. - [Replicate PostgreSQL tables without primary keys](https://artie.com/docs/guides/database/tables-without-primary-key-s.md): Configure PostgreSQL tables without primary keys for replication by using REPLICA IDENTITY FULL and an Artie primary key override. - [Capacity pricing](https://artie.com/docs/guides/database/bigquery/capacity-pricing.md): Enable capacity pricing for BigQuery to avoid having unexpected BigQuery costs. - [Enable partitioning](https://artie.com/docs/guides/database/bigquery/enable-bigquery-partitioning.md): Partition your BigQuery destination tables to improve Artie merge performance and reduce costs. ## API Reference - [Overview](https://artie.com/docs/api/overview.md): Get started with the Artie Dashboard API to manage your pipelines and data programmatically. Includes authentication setup and API key generation. - [List column hashing salts](https://artie.com/docs/api-reference/column-hashing-salts/list-column-hashing-salts.md): Lists all column hashing salts for the authenticated company. - [Create a column hashing salt](https://artie.com/docs/api-reference/column-hashing-salts/create-a-column-hashing-salt.md): Creates a new column hashing salt for the authenticated company. - [Get a column hashing salt](https://artie.com/docs/api-reference/column-hashing-salts/get-a-column-hashing-salt.md): Retrieves a column hashing salt by UUID, including the decrypted salt. Requires company admin. - [Update a column hashing salt](https://artie.com/docs/api-reference/column-hashing-salts/update-a-column-hashing-salt.md): Updates the name and description of a column hashing salt. - [Delete a column hashing salt](https://artie.com/docs/api-reference/column-hashing-salts/delete-a-column-hashing-salt.md): Deletes a column hashing salt by UUID. - [Preview a column hashing salt](https://artie.com/docs/api-reference/column-hashing-salts/preview-a-column-hashing-salt.md): Hashes a sample string value with this salt using the same function used by Artie's pipelines (HMAC-SHA256 keyed on the salt, or SHA-256 if the salt is empty). Returns the hex-encoded hash. - [Trigger automatic schema changes](https://artie.com/docs/api-reference/company/trigger-automatic-schema-changes.md): Enqueues automatic schema changes for all eligible running pipelines in the authenticated company. The request is accepted before reconciliation completes. - [List connectors](https://artie.com/docs/api-reference/connectors/list-connectors.md): Returns all destination connectors for the authenticated company. Pass includeSourceConnectors=true to also include source connectors. - [Create a connector](https://artie.com/docs/api-reference/connectors/create-a-connector.md): Creates a new source or destination connector for your Artie deployment. Configure database connections, authentication, and replication settings programmatically. - [Get a connector](https://artie.com/docs/api-reference/connectors/get-a-connector.md): Retrieves the full configuration and status of a connector by its unique identifier, including connection settings and current replication state. - [Update a connector](https://artie.com/docs/api-reference/connectors/update-a-connector.md): Updates the configuration of an existing source or destination connector. Modify connection settings, credentials, or replication parameters for a running pipeline. - [Delete a connector](https://artie.com/docs/api-reference/connectors/delete-a-connector.md): Permanently removes a connector and its associated configuration. This stops any active replication pipelines that depend on the connector. - [Fetch databases for a saved connector](https://artie.com/docs/api-reference/connectors/fetch-databases-for-a-saved-connector.md): Lists available databases on the target using a saved connector's configuration. Response metadata may include Iceberg S3 table bucket maintenance defaults. - [Fetch table detail for a saved connector](https://artie.com/docs/api-reference/connectors/fetch-table-detail-for-a-saved-connector.md): Returns detailed metadata for a specific table on the saved connector. tableName is required; databaseName defaults to the connector's configured database, schemaName defaults to the connector type's default schema, and isView is optional. - [Generate Oracle shadow table script](https://artie.com/docs/api-reference/connectors/generate-oracle-shadow-table-script.md): Generates the SQL script to create shadow tables required for Oracle change data capture (CDC). Run this script on your Oracle source before starting replication. - [Drop a PostgreSQL replication slot](https://artie.com/docs/api-reference/connectors/drop-a-postgresql-replication-slot.md): Drops a PostgreSQL replication slot that is inactive or orphaned. Use this to clean up stale replication slots that may be preventing WAL cleanup on the source. - [Fetch schemas for a saved connector](https://artie.com/docs/api-reference/connectors/fetch-schemas-for-a-saved-connector.md): Lists available schemas on the target using a saved connector's configuration. Pass 'databaseName' as a query parameter. - [Start a DynamoDB export](https://artie.com/docs/api-reference/connectors/start-a-dynamodb-export.md): Initiates a point-in-time export from Amazon DynamoDB for the specified connector. Use this to backfill your destination with existing DynamoDB table data. - [Fetch tables for a saved connector](https://artie.com/docs/api-reference/connectors/fetch-tables-for-a-saved-connector.md): Lists available tables on the target using a saved connector's configuration. databaseName defaults to the connector's configured database; schemaName defaults to the connector type's default schema (e.g. 'public' for Postgres, 'dbo' for SQL Server). - [Fetch databases for an unsaved connector](https://artie.com/docs/api-reference/connectors/fetch-databases-for-an-unsaved-connector.md): Lists available databases on the target using an unsaved connector configuration. Useful during connector setup to discover existing databases. Response metadata may include Iceberg S3 table bucket maintenance defaults. - [Create a database on an unsaved connector](https://artie.com/docs/api-reference/connectors/create-a-database-on-an-unsaved-connector.md): Creates a new database on the target destination using a connector configuration that has not yet been saved. Useful during initial setup to prepare the destination. - [Create a schema on an unsaved connector](https://artie.com/docs/api-reference/connectors/create-a-schema-on-an-unsaved-connector.md): Creates a new schema on the target destination using a connector configuration that has not yet been saved. Useful during initial setup to organize destination tables. - [Create a Snowflake warehouse on an unsaved connector](https://artie.com/docs/api-reference/connectors/create-a-snowflake-warehouse-on-an-unsaved-connector.md): Creates a new Snowflake virtual warehouse using an unsaved connector configuration. Useful during initial setup to provision compute resources for data replication. - [Ping a connector](https://artie.com/docs/api-reference/connectors/ping-a-connector.md): Tests network connectivity and authentication for a connector configuration before saving it. Use this to validate connection settings during connector setup. - [List PostgreSQL publications for an unsaved connector](https://artie.com/docs/api-reference/connectors/list-postgresql-publications-for-an-unsaved-connector.md): Lists logical replication publications on a PostgreSQL source using an unsaved connector configuration. Useful during connector setup to let users select an existing publication. - [Fetch schemas for an unsaved connector](https://artie.com/docs/api-reference/connectors/fetch-schemas-for-an-unsaved-connector.md): Lists available schemas in a specific database using an unsaved connector configuration. Useful during connector setup to discover existing schemas. - [Fetch tables for an unsaved connector](https://artie.com/docs/api-reference/connectors/fetch-tables-for-an-unsaved-connector.md): Lists available tables in a specific database and schema using an unsaved connector configuration. Results are cached when a connector UUID is provided. - [Search the data catalog](https://artie.com/docs/api-reference/data-catalog/search-the-data-catalog.md): Searches across the company's data catalog using full-text search. - [List encryption keys](https://artie.com/docs/api-reference/encryption-keys/list-encryption-keys.md): Lists all encryption keys for the authenticated company. - [Create an encryption key](https://artie.com/docs/api-reference/encryption-keys/create-an-encryption-key.md): Creates a new encryption key for the authenticated company. - [Get an encryption key](https://artie.com/docs/api-reference/encryption-keys/get-an-encryption-key.md): Retrieves an encryption key by UUID, including the decrypted key. Requires company admin. - [Update an encryption key](https://artie.com/docs/api-reference/encryption-keys/update-an-encryption-key.md): Updates the name and description of an encryption key. - [Delete an encryption key](https://artie.com/docs/api-reference/encryption-keys/delete-an-encryption-key.md): Deletes an encryption key by UUID. - [Create an ingestion API key](https://artie.com/docs/api-reference/ingestion-api-keys/create-an-ingestion-api-key.md): Creates a new ingestion API key for a source reader. Returns the key and its secret (only shown once). - [Update an ingestion API key](https://artie.com/docs/api-reference/ingestion-api-keys/update-an-ingestion-api-key.md): Updates an existing ingestion API key by UUID. - [Delete an ingestion API key](https://artie.com/docs/api-reference/ingestion-api-keys/delete-an-ingestion-api-key.md): Deletes an ingestion API key by UUID. - [List pipelines](https://artie.com/docs/api-reference/pipelines/list-pipelines.md): Returns pipelines for the authenticated company, optionally filtered by environment. - [Create a pipeline on an existing source reader](https://artie.com/docs/api-reference/pipelines/create-a-pipeline-on-an-existing-source-reader.md): Creates a pipeline attached to an existing source reader (pipeline.sourceReaderUUID). The reader must have no pipeline yet, or be shared. To start a new capture from a source connector, use POST /pipelines/create-from-source. - [Get pipeline by UUID](https://artie.com/docs/api-reference/pipelines/get-pipeline-by-uuid.md): Returns pipeline detail. With query includeRelatedObjects=true returns pipeline, sourceReader, sourceConnector, and optional destinationConnector; otherwise returns FullPipeline only. - [Update pipeline](https://artie.com/docs/api-reference/pipelines/update-pipeline.md): Updates an existing pipeline by UUID. - [Delete pipeline](https://artie.com/docs/api-reference/pipelines/delete-pipeline.md): Deletes a pipeline by UUID. - [Trigger automatic schema changes](https://artie.com/docs/api-reference/pipelines/trigger-automatic-schema-changes.md): Enqueues automatic schema changes for one eligible pipeline. Set forceRefresh to bypass the two-hour cooldown for this execution. The request is accepted before reconciliation completes. - [Backfill pipeline tables](https://artie.com/docs/api-reference/pipelines/backfill-pipeline-tables.md): Triggers a backfill for specified tables in the pipeline. Supports options for pre-backfill behavior (drop, truncate, or do nothing) and schema/database filtering. - [Cancel backfill](https://artie.com/docs/api-reference/pipelines/cancel-backfill.md): Cancels backfilling for the given table UUIDs and/or history table UUIDs. - [Detect schema changes](https://artie.com/docs/api-reference/pipelines/detect-schema-changes.md): Enqueues a background job that checks the pipeline's source database for new, removed, or altered tables. If the pipeline has auto-replicate or auto-history mode enabled, any newly discovered tables will be added to the pipeline automatically. An email summary is sent if changes are detected. - [Start pipeline](https://artie.com/docs/api-reference/pipelines/start-pipeline.md): Starts or resumes a pipeline. Optional body: keepPaused, disableBackFill. - [Update pipeline status](https://artie.com/docs/api-reference/pipelines/update-pipeline-status.md): Changes the status of a pipeline (e.g. running, paused). Validates the pipeline before resuming and deploys the configuration change. - [Update pipeline with source reader](https://artie.com/docs/api-reference/pipelines/update-pipeline-with-source-reader.md): Updates pipeline and optionally its source reader in one request. Accepts gzip-encoded body. - [Create a new pipeline from a source](https://artie.com/docs/api-reference/pipelines/create-a-new-pipeline-from-a-source.md): Creates a draft pipeline and a dedicated source reader. Provide sourceConnectorUUID to use an existing source, or sourceType to create a stub source connector. Optional destinationType creates a stub destination. To attach another pipeline to the same reader, use POST /pipelines with a shared source… - [Validate unsaved destination](https://artie.com/docs/api-reference/pipelines/validate-unsaved-destination.md): Validates destination configuration without persisting. Returns 204 on success or 200 with error message on validation failure. - [Validate unsaved source](https://artie.com/docs/api-reference/pipelines/validate-unsaved-source.md): Validates source reader and connector configuration without persisting. Returns 204 on success or 200 with error message on validation failure. - [Create a PrivateLink connection](https://artie.com/docs/api-reference/privatelink-connections/create-a-privatelink-connection.md): Creates a new PrivateLink connection for the authenticated company. - [Get a PrivateLink connection](https://artie.com/docs/api-reference/privatelink-connections/get-a-privatelink-connection.md): Retrieves the details of a PrivateLink connection by UUID, including its status, VPC service name, region, DNS entry, and availability zones. - [Update a PrivateLink connection](https://artie.com/docs/api-reference/privatelink-connections/update-a-privatelink-connection.md): Updates an existing PrivateLink connection by UUID. The name can always be updated. The config fields (region / VPC service name / data plane / availability zones) are only mutable while the connection is under review or errored — once it is being provisioned or live they are immutable. - [Delete a PrivateLink connection](https://artie.com/docs/api-reference/privatelink-connections/delete-a-privatelink-connection.md): Permanently deletes a PrivateLink connection by UUID. This action cannot be undone and will remove the connection from your account. - [List source readers](https://artie.com/docs/api-reference/source-readers/list-source-readers.md): Lists all source readers for the authenticated company. - [Create a source reader](https://artie.com/docs/api-reference/source-readers/create-a-source-reader.md): Creates a new source reader for the authenticated company. - [Get a source reader](https://artie.com/docs/api-reference/source-readers/get-a-source-reader.md): Retrieves the details of a source reader by UUID, including its configuration, status, connector association, and table settings. - [Update a source reader](https://artie.com/docs/api-reference/source-readers/update-a-source-reader.md): Updates an existing source reader by UUID. You can modify the name, settings, table configuration, and shared status of the source reader. - [Delete a source reader](https://artie.com/docs/api-reference/source-readers/delete-a-source-reader.md): Permanently deletes a source reader by UUID. The source reader must not be associated with any active pipelines before deletion. - [Deploy a source reader](https://artie.com/docs/api-reference/source-readers/deploy-a-source-reader.md): Deploys a shared source reader to the data plane. The source reader must be shared and pass validation before it can be deployed. - [Update source reader status](https://artie.com/docs/api-reference/source-readers/update-source-reader-status.md): Changes the status of a shared source reader (e.g. running, paused). Only shared source readers are supported; for non-shared source readers, use the pipeline status endpoint instead. - [Validate an unsaved source reader](https://artie.com/docs/api-reference/source-readers/validate-an-unsaved-source-reader.md): Validates a source reader configuration without persisting it. - [Create an SSH tunnel](https://artie.com/docs/api-reference/ssh-tunnels/create-an-ssh-tunnel.md): Creates a new SSH tunnel for the authenticated company. - [Get an SSH tunnel](https://artie.com/docs/api-reference/ssh-tunnels/get-an-ssh-tunnel.md): Retrieves the details of an SSH tunnel by UUID, including its host, port, username, public key, and whether it is currently in use. - [Update an SSH tunnel](https://artie.com/docs/api-reference/ssh-tunnels/update-an-ssh-tunnel.md): Updates an existing SSH tunnel by UUID. You can modify the name, host, port, and username. Changes will mark associated pipelines as having undeployed changes. - [Delete an SSH tunnel](https://artie.com/docs/api-reference/ssh-tunnels/delete-an-ssh-tunnel.md): Permanently deletes an SSH tunnel by UUID. The tunnel must not be in use by any connectors or pipelines before it can be deleted. ## Webhook Events - [Overview](https://artie.com/docs/api/webhooks/overview.md): Configure HTTPS webhooks to receive real-time notifications when events occur in your pipelines. - [replication.started](https://artie.com/docs/api/webhooks/replication-started.md): The replication process has started. - [replication.error](https://artie.com/docs/api/webhooks/replication-error.md): An error occurred during replication. - [row.skipped](https://artie.com/docs/api/webhooks/row-skipped.md): A row was not written due to size limits. - [ddl.seen](https://artie.com/docs/api/webhooks/ddl-seen.md): A DDL statement was detected in the CDC stream (MySQL only). - [ddl.applied](https://artie.com/docs/api/webhooks/ddl-applied.md): Artie has applied a schema change to the destination. - [backfill.started](https://artie.com/docs/api/webhooks/backfill-started.md): A backfill has started for a table. - [backfill.completed](https://artie.com/docs/api/webhooks/backfill-completed.md): A backfill has finished successfully. - [backfill.failed](https://artie.com/docs/api/webhooks/backfill-failed.md): A backfill failed before completing. - [dedupe.started](https://artie.com/docs/api/webhooks/dedupe-started.md): A deduplication job has started for a table. - [dedupe.completed](https://artie.com/docs/api/webhooks/dedupe-completed.md): A deduplication job has finished successfully. - [dedupe.failed](https://artie.com/docs/api/webhooks/dedupe-failed.md): A deduplication job failed. - [dek.generated](https://artie.com/docs/api/webhooks/dek-generated.md): A new Data Encryption Key (DEK) was generated. - [replication.failed](https://artie.com/docs/api/webhooks/replication-failed.md): Deprecated alias for replication.error. - [connection.failed](https://artie.com/docs/api/webhooks/connection-failed.md): Deprecated alias for replication.error. - [Backfillcompleted](https://artie.com/docs/api-reference/backfillcompleted.md): Backfill completed - [Backfillfailed](https://artie.com/docs/api-reference/backfillfailed.md): Backfill failed - [Backfillstarted](https://artie.com/docs/api-reference/backfillstarted.md): Backfill started - [Connectionfailed](https://artie.com/docs/api-reference/connectionfailed.md): Connection failed - [Databasediscovered](https://artie.com/docs/api-reference/databasediscovered.md): Database discovered - [Databasediscovery failed](https://artie.com/docs/api-reference/databasediscovery_failed.md): Database discovery failed - [Databaseremoved](https://artie.com/docs/api-reference/databaseremoved.md): Database removed - [Ddlapplied](https://artie.com/docs/api-reference/ddlapplied.md): DDL applied - [Ddlseen](https://artie.com/docs/api-reference/ddlseen.md): DDL seen - [Dedupecompleted](https://artie.com/docs/api-reference/dedupecompleted.md): Deduplication completed - [Dedupefailed](https://artie.com/docs/api-reference/dedupefailed.md): Deduplication failed - [Dedupestarted](https://artie.com/docs/api-reference/dedupestarted.md): Deduplication started - [Dekgenerated](https://artie.com/docs/api-reference/dekgenerated.md): Data Encryption Key (DEK) generated - [Replicationerror](https://artie.com/docs/api-reference/replicationerror.md): Replication error - [Replicationfailed](https://artie.com/docs/api-reference/replicationfailed.md): Replication failed - [Replicationstarted](https://artie.com/docs/api-reference/replicationstarted.md): Replication started - [Rowskipped](https://artie.com/docs/api-reference/rowskipped.md): Row skipped ## MCP - [MCP Server](https://artie.com/docs/api/mcp.md): Connect an MCP-compatible AI client to Artie to work with approved pipeline and infrastructure operations. - [MCP tools](https://artie.com/docs/api/mcp-tools.md): Browse every Artie operation exposed through the MCP server. - [Agent Skills](https://artie.com/docs/api/agent-skills.md): Give compatible AI coding agents Artie’s pipeline-setup guidance. ## Changelog - [Changelog](https://artie.com/docs/changelog.md): Stay up to date with the latest features, improvements, and bug fixes in Artie. ## OpenAPI Specs - [openapi](https://raw.githubusercontent.com/artie-labs/artie-api-spec/refs/heads/master/openapi.yaml) - [openapi](/docs/openapi.yaml)