Pipelines

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>

Body CreatePipelineRequest (optional)

Returns CreatePipelineResponse

See POST /api/v0/organizations/{org}/pipelines for the full request and response schema.

deletePipeline

DELETE /api/v0/organizations/{org}/pipelines/{pipeline}

Delete a pipeline

Permanently deletes the pipeline identified by the path slug within the organization. Existing builds are retained but detached from the pipeline. An unknown slug (or one in another organization) is 404.

import { deletePipeline } from "@harmont/cloud";

deletePipeline(options): RequestResult<DeletePipelineResponse>

Returns DeletePipelineResponse

See DELETE /api/v0/organizations/{org}/pipelines/{pipeline} 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>

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>

Returns ListPipelinesResponse

See GET /api/v0/organizations/{org}/pipelines for the full request and response schema.