API Overview - Goldsky Docs

The Goldsky API lets you create, deploy, monitor, and manage Turbo Pipelines programmatically — the same operations available through the CLI, exposed as a REST API.

Base URL

https://api.goldsky.com/api/v1

Authentication

All endpoints require a Bearer token. Create a Goldsky API key from your Project Settings and pass it in the Authorization header. API keys are scoped to a single project.

curl -H "Authorization: Bearer <your-api-key>" \
  https://api.goldsky.com/api/v1/pipelines/

Endpoints

Method	Path	Description
`GET`	`/pipelines/`	List all pipelines
`POST`	`/pipelines/`	Create a pipeline
`GET`	`/pipelines/{name}`	Get a pipeline
`DELETE`	`/pipelines/{name}`	Delete a pipeline
`POST`	`/pipelines/validate`	Validate a pipeline definition
`PUT`	`/pipelines/{name}/pause`	Pause a pipeline
`PUT`	`/pipelines/{name}/resume`	Resume a pipeline
`PUT`	`/pipelines/{name}/restart`	Restart a pipeline
`GET`	`/pipelines/{name}/logs`	Get pipeline logs
`GET`	`/pipelines/{name}/logs/error-count`	Get pipeline error count
`GET`	`/pipelines/{name}/status`	Get pipeline status
`GET`	`/pipelines/{name}/state`	Get pipeline state

Select any endpoint in the sidebar to see its parameters and try it interactively.

​Base URL

​Authentication

​Endpoints

Base URL

Authentication

Endpoints