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.

post/api/v0/organizations/{org}/pipelines

Request

  • Base URL: https://api.harmont.dev
  • URL: https://api.harmont.dev/api/v0/organizations/{org}/pipelines
  • Auth: HTTP bearer

Path parameters

orgstring required

The organization slug.

Request body

default_branchstring required

The branch built by default.

descriptionstring nullable

Optional human description.

namestring required

Display name.

repo_namestring nullable

Optional owner/repo label. When omitted it is derived from repository.

repositorystring required

The source repository this pipeline builds.

Response

The created pipeline

allow_manualboolean required

Whether manual (e.g. hm run) builds are permitted.

created_atstring date-time required

When the pipeline was created.

default_branchstring required

The branch built by default.

descriptionstring nullable

Optional human description.

namestring required

Display name.

repo_namestring nullable

The pipeline's repo as owner/repo — from the mirrored GitHub repo when known, else parsed from the clone URL. null when unknown.

repositorystring required

The source repository this pipeline builds.

slugstring required

URL-safe slug, unique within the organization. Derived from the name.

visibility'private' | 'public' required

Whether the pipeline is private or public.

Changes

No recorded changes to this operation across all 1 revision of this API.