Arroyo REST API
ping
Ping endpoint
connection_profiles
Connection profiles management endpoints
- List all connection profilesGET
/v1/connection_profiles - Create connection profilePOST
/v1/connection_profiles - Test connection profilePOST
/v1/connection_profiles/test - Delete a Connection ProfileDEL
/v1/connection_profiles/{id} - Get autocomplete suggestions for a connection profileGET
/v1/connection_profiles/{id}/autocomplete
connection_tables
Connection tables management endpoints
pipelines
Pipeline management endpoints
- List all pipelinesGET
/v1/pipelines - Create a new pipelinePOST
/v1/pipelines - Create a new preview pipelinePOST
/v1/pipelines/preview - Validate a query and return pipeline graphPOST
/v1/pipelines/validate_query - Get a single pipelineGET
/v1/pipelines/{id} - Create a new pipeline at a caller-supplied idPUT
/v1/pipelines/{id} - Delete a pipelineDEL
/v1/pipelines/{id} - Update a pipelinePATCH
/v1/pipelines/{id} - List a pipeline's jobsGET
/v1/pipelines/{id}/jobs - Restart a pipelinePOST
/v1/pipelines/{id}/restart
jobs
Job management endpoints
- Get all jobsGET
/v1/jobs - List a job's checkpointsGET
/v1/pipelines/{pipeline_id}/jobs/{job_id}/checkpoints - Get a checkpoint's detailsGET
/v1/pipelines/{pipeline_id}/jobs/{job_id}/checkpoints/{epoch}/operator_checkpoint_groups - List a job's error messagesGET
/v1/pipelines/{pipeline_id}/jobs/{job_id}/errors - Get a job's metricsGET
/v1/pipelines/{pipeline_id}/jobs/{job_id}/operator_metric_groups - Subscribe to a job's outputGET
/v1/pipelines/{pipeline_id}/jobs/{job_id}/output
connectors
Connector management endpoints