A pipeline is a named CI definition inside an organization — the thing
you push code against. Each pipeline owns its builds; its pipeline_slug
is unique within the org.
These endpoints list and create pipelines and fetch a single pipeline's
record (including its build_count). To run one, create a build under it
— see Builds.
List an organization's pipelines
Authorization
bearer A Harmont session bearer token.
In: header
Path Parameters
The organization slug.
Query Parameters
Page size (1–100, default 50).
Opaque cursor from a previous page's next_cursor.
Response Body
application/json
application/json
curl -X GET "https://api.harmont.dev/api/v0/organizations/string/pipelines"{
"data": [
{
"allow_manual": true,
"created_at": "2019-08-24T14:15:22Z",
"default_branch": "string",
"description": "string",
"name": "string",
"repo_name": "string",
"repository": "string",
"slug": "string",
"visibility": "private"
}
],
"next_cursor": "string"
}{
"error": {
"code": "string",
"doc_url": "string",
"message": "string",
"request_id": "string",
"type": "string"
}
}Create a pipeline
Authorization
bearer A Harmont session bearer token.
In: header
Path Parameters
The organization slug.
Request Body
application/json
Pipeline attributes
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://api.harmont.dev/api/v0/organizations/string/pipelines" \ -H "Content-Type: application/json" \ -d '{ "default_branch": "string", "name": "string", "repository": "string" }'{
"allow_manual": true,
"created_at": "2019-08-24T14:15:22Z",
"default_branch": "string",
"description": "string",
"name": "string",
"repo_name": "string",
"repository": "string",
"slug": "string",
"visibility": "private"
}{
"error": {
"code": "string",
"doc_url": "string",
"message": "string",
"request_id": "string",
"type": "string"
}
}{
"error": {
"code": "string",
"doc_url": "string",
"message": "string",
"request_id": "string",
"type": "string"
}
}Get a pipeline
Authorization
bearer A Harmont session bearer token.
In: header
Path Parameters
The organization slug.
The pipeline slug.
Response Body
application/json
application/json
curl -X GET "https://api.harmont.dev/api/v0/organizations/string/pipelines/string"{
"allow_manual": true,
"created_at": "2019-08-24T14:15:22Z",
"default_branch": "string",
"description": "string",
"name": "string",
"repo_name": "string",
"repository": "string",
"slug": "string",
"visibility": "private"
}{
"error": {
"code": "string",
"doc_url": "string",
"message": "string",
"request_id": "string",
"type": "string"
}
}