---
title: "Arroyo REST API"
---

> Documentation Index
> Fetch the complete documentation index at: https://www.arroyo.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Arroyo REST API

Version: 1.0.0

## Servers

- `http://localhost:5115/api`

## [ping](https://www.arroyo.dev/docs/api/tags/ping/)

Ping endpoint

- [Ping endpoint](https://www.arroyo.dev/docs/api/ping/) — `GET /v1/ping`

## [connection_profiles](https://www.arroyo.dev/docs/api/tags/connection-profiles/)

Connection profiles management endpoints

- [List all connection profiles](https://www.arroyo.dev/docs/api/get-connection-profiles/) — `GET /v1/connection_profiles`
- [Create connection profile](https://www.arroyo.dev/docs/api/create-connection-profile/) — `POST /v1/connection_profiles`
- [Test connection profile](https://www.arroyo.dev/docs/api/test-connection-profile/) — `POST /v1/connection_profiles/test`
- [Delete a Connection Profile](https://www.arroyo.dev/docs/api/delete-connection-profile/) — `DELETE /v1/connection_profiles/{id}`
- [Get autocomplete suggestions for a connection profile](https://www.arroyo.dev/docs/api/get-connection-profile-autocomplete/) — `GET /v1/connection_profiles/{id}/autocomplete`

## [connection_tables](https://www.arroyo.dev/docs/api/tags/connection-tables/)

Connection tables management endpoints

- [List all connection tables](https://www.arroyo.dev/docs/api/get-connection-tables/) — `GET /v1/connection_tables`
- [Create a new connection table](https://www.arroyo.dev/docs/api/create-connection-table/) — `POST /v1/connection_tables`
- [Test a Connection Schema](https://www.arroyo.dev/docs/api/test-schema/) — `POST /v1/connection_tables/schemas/test`
- [Test a Connection Table](https://www.arroyo.dev/docs/api/test-connection-table/) — `POST /v1/connection_tables/test`
- [Delete a Connection Table](https://www.arroyo.dev/docs/api/delete-connection-table/) — `DELETE /v1/connection_tables/{id}`

## [pipelines](https://www.arroyo.dev/docs/api/tags/pipelines/)

Pipeline management endpoints

- [List all pipelines](https://www.arroyo.dev/docs/api/get-pipelines/) — `GET /v1/pipelines`
- [Create a new pipeline](https://www.arroyo.dev/docs/api/create-pipeline/) — `POST /v1/pipelines`
- [Create a new preview pipeline](https://www.arroyo.dev/docs/api/create-preview-pipeline/) — `POST /v1/pipelines/preview`
- [Validate a query and return pipeline graph](https://www.arroyo.dev/docs/api/validate-query/) — `POST /v1/pipelines/validate_query`
- [Get a single pipeline](https://www.arroyo.dev/docs/api/get-pipeline/) — `GET /v1/pipelines/{id}`
- [Create a new pipeline at a caller-supplied id](https://www.arroyo.dev/docs/api/put-pipeline/) — `PUT /v1/pipelines/{id}`
- [Delete a pipeline](https://www.arroyo.dev/docs/api/delete-pipeline/) — `DELETE /v1/pipelines/{id}`
- [Update a pipeline](https://www.arroyo.dev/docs/api/patch-pipeline/) — `PATCH /v1/pipelines/{id}`
- [List a pipeline's jobs](https://www.arroyo.dev/docs/api/get-pipeline-jobs/) — `GET /v1/pipelines/{id}/jobs`
- [Restart a pipeline](https://www.arroyo.dev/docs/api/restart-pipeline/) — `POST /v1/pipelines/{id}/restart`

## [jobs](https://www.arroyo.dev/docs/api/tags/jobs/)

Job management endpoints

- [Get all jobs](https://www.arroyo.dev/docs/api/get-jobs/) — `GET /v1/jobs`
- [List a job's checkpoints](https://www.arroyo.dev/docs/api/get-job-checkpoints/) — `GET /v1/pipelines/{pipeline_id}/jobs/{job_id}/checkpoints`
- [Get a checkpoint's details](https://www.arroyo.dev/docs/api/get-checkpoint-details/) — `GET /v1/pipelines/{pipeline_id}/jobs/{job_id}/checkpoints/{epoch}/operator_checkpoint_groups`
- [List a job's error messages](https://www.arroyo.dev/docs/api/get-job-errors/) — `GET /v1/pipelines/{pipeline_id}/jobs/{job_id}/errors`
- [Get a job's metrics](https://www.arroyo.dev/docs/api/get-operator-metric-groups/) — `GET /v1/pipelines/{pipeline_id}/jobs/{job_id}/operator_metric_groups`
- [Subscribe to a job's output](https://www.arroyo.dev/docs/api/get-job-output/) — `GET /v1/pipelines/{pipeline_id}/jobs/{job_id}/output`

## [connectors](https://www.arroyo.dev/docs/api/tags/connectors/)

Connector management endpoints

- [List all connectors](https://www.arroyo.dev/docs/api/get-connectors/) — `GET /v1/connectors`

## [udfs](https://www.arroyo.dev/docs/api/tags/udfs/)

- [Get Global UDFs](https://www.arroyo.dev/docs/api/get-udfs/) — `GET /v1/udfs`
- [Create a global UDF](https://www.arroyo.dev/docs/api/create-udf/) — `POST /v1/udfs`
- [Validate UDFs](https://www.arroyo.dev/docs/api/validate-udf/) — `POST /v1/udfs/validate`
- [Delete UDF](https://www.arroyo.dev/docs/api/delete-udf/) — `DELETE /v1/udfs/{id}`


Source: https://www.arroyo.dev/docs/api/index.md
