Generated @harmont/cloud reference for the Pipelines endpoints.
createPipeline
POST /api/v0/organizations/{org}/pipelines
Create a pipeline
Creates a pipeline in the organization. The slug is derived from the name; a colliding slug within the organization yields 422.
import { createPipeline } from "@harmont/cloud";createPipeline(options): RequestResult<CreatePipelineResponse>| Parameter | In | Type | Description |
|---|---|---|---|
org | path | string | The organization slug. |
Body CreatePipelineRequest (optional)
Returns CreatePipelineResponse
See POST /api/v0/organizations/{org}/pipelines for the full request and response schema.
getPipeline
GET /api/v0/organizations/{org}/pipelines/{pipeline}
Get a pipeline
Returns the pipeline identified by the path slug within the organization. An unknown slug (or one in another organization) is reported as 404.
import { getPipeline } from "@harmont/cloud";getPipeline(options): RequestResult<GetPipelineResponse>| Parameter | In | Type | Description |
|---|---|---|---|
org | path | string | The organization slug. |
pipeline | path | string | The pipeline slug. |
Returns GetPipelineResponse
See GET /api/v0/organizations/{org}/pipelines/{pipeline} for the full request and response schema.
listPipelines
GET /api/v0/organizations/{org}/pipelines
List an organization's pipelines
Returns the organization's non-archived pipelines, paginated. A slug the user cannot access is reported as 404.
import { listPipelines } from "@harmont/cloud";listPipelines(options): RequestResult<ListPipelinesResponse>| Parameter | In | Type | Description |
|---|---|---|---|
org | path | string | The organization slug. |
limit | query | number | Page size (1–100, default 50). |
cursor | query | string | Opaque cursor from a previous page's next_cursor. |
Returns ListPipelinesResponse
See GET /api/v0/organizations/{org}/pipelines for the full request and response schema.