Harmont docs
Overview

Organizations

Organizations, pipelines, builds, jobs, artifacts.

/api/v2/organizations

GET
/api/v2/organizations

Response Body

application/json;charset=utf-8

curl -X GET "https://loading/api/v2/organizations"
null

/api/v2/organizations/{org_slug}

GET
/api/v2/organizations/{org_slug}

Path Parameters

org_slug*string

Response Body

application/json;charset=utf-8

curl -X GET "https://loading/api/v2/organizations/string"
null
Empty

/api/v2/organizations/{org_slug}/github/installations

GET
/api/v2/organizations/{org_slug}/github/installations

Path Parameters

org_slug*string

Response Body

application/json;charset=utf-8

curl -X GET "https://loading/api/v2/organizations/string/github/installations"
null
Empty

/api/v2/organizations/{org_slug}/github/installations

POST
/api/v2/organizations/{org_slug}/github/installations

Path Parameters

org_slug*string

Request Body

application/json;charset=utf-8

TypeScript Definitions

Use the request body type in TypeScript.

body?unknown

Response Body

application/json;charset=utf-8

curl -X POST "https://loading/api/v2/organizations/string/github/installations"
null
Empty
Empty

/api/v2/organizations/{org_slug}/github/installations/{installation_id}

DELETE
/api/v2/organizations/{org_slug}/github/installations/{installation_id}

Path Parameters

org_slug*string
installation_id*integer
Range-9223372036854776000 <= value <= 9223372036854776000

Response Body

curl -X DELETE "https://loading/api/v2/organizations/string/github/installations/-9223372036854776000"
Empty
Empty

/api/v2/organizations/{org_slug}/github/installations/{installation_id}/repos

GET
/api/v2/organizations/{org_slug}/github/installations/{installation_id}/repos

Path Parameters

org_slug*string
installation_id*integer
Range-9223372036854776000 <= value <= 9223372036854776000

Response Body

application/json;charset=utf-8

curl -X GET "https://loading/api/v2/organizations/string/github/installations/-9223372036854776000/repos"
null
Empty

/api/v2/organizations/{org_slug}/github/installations/{installation_id}/sync

POST
/api/v2/organizations/{org_slug}/github/installations/{installation_id}/sync

Path Parameters

org_slug*string
installation_id*integer
Range-9223372036854776000 <= value <= 9223372036854776000

Response Body

application/json;charset=utf-8

curl -X POST "https://loading/api/v2/organizations/string/github/installations/-9223372036854776000/sync"
null
Empty

/api/v2/organizations/{org_slug}/github/repos

GET
/api/v2/organizations/{org_slug}/github/repos

Path Parameters

org_slug*string

Response Body

application/json;charset=utf-8

curl -X GET "https://loading/api/v2/organizations/string/github/repos"
null
Empty

/api/v2/organizations/{org_slug}/pipelines

GET
/api/v2/organizations/{org_slug}/pipelines

Path Parameters

org_slug*string

Query Parameters

repository?string

Response Body

application/json;charset=utf-8

curl -X GET "https://loading/api/v2/organizations/string/pipelines"
null
Empty
Empty

/api/v2/organizations/{org_slug}/pipelines

POST
/api/v2/organizations/{org_slug}/pipelines

Path Parameters

org_slug*string

Request Body

application/json;charset=utf-8

TypeScript Definitions

Use the request body type in TypeScript.

body?unknown

Response Body

application/json;charset=utf-8

curl -X POST "https://loading/api/v2/organizations/string/pipelines"
null
Empty
Empty

/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}

GET
/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}

Path Parameters

org_slug*string
pipeline_slug*string

Response Body

application/json;charset=utf-8

curl -X GET "https://loading/api/v2/organizations/string/pipelines/string"
null
Empty

/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds

GET
/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds

Path Parameters

org_slug*string
pipeline_slug*string

Response Body

application/json;charset=utf-8

curl -X GET "https://loading/api/v2/organizations/string/pipelines/string/builds"
null
Empty

/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds

POST
/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds

Path Parameters

org_slug*string
pipeline_slug*string

Request Body

application/json;charset=utf-8

TypeScript Definitions

Use the request body type in TypeScript.

body?unknown

Response Body

application/json;charset=utf-8

curl -X POST "https://loading/api/v2/organizations/string/pipelines/string/builds"
null
Empty
Empty

/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{build_number}

GET
/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{build_number}

Path Parameters

org_slug*string
pipeline_slug*string
build_number*integer
Range-9223372036854776000 <= value <= 9223372036854776000

Response Body

application/json;charset=utf-8

curl -X GET "https://loading/api/v2/organizations/string/pipelines/string/builds/-9223372036854776000"
null
Empty

/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{build_number}/artifacts

GET
/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{build_number}/artifacts

Path Parameters

org_slug*string
pipeline_slug*string
build_number*integer
Range-9223372036854776000 <= value <= 9223372036854776000

Response Body

application/json;charset=utf-8

curl -X GET "https://loading/api/v2/organizations/string/pipelines/string/builds/-9223372036854776000/artifacts"
null
Empty

/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{build_number}/cancel

PUT
/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{build_number}/cancel

Path Parameters

org_slug*string
pipeline_slug*string
build_number*integer
Range-9223372036854776000 <= value <= 9223372036854776000

Response Body

application/json;charset=utf-8

curl -X PUT "https://loading/api/v2/organizations/string/pipelines/string/builds/-9223372036854776000/cancel"
null
Empty

/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{build_number}/jobs

GET
/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{build_number}/jobs

Path Parameters

org_slug*string
pipeline_slug*string
build_number*integer
Range-9223372036854776000 <= value <= 9223372036854776000

Response Body

application/json;charset=utf-8

curl -X GET "https://loading/api/v2/organizations/string/pipelines/string/builds/-9223372036854776000/jobs"
null
Empty

/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{build_number}/jobs/{job_id}

GET
/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{build_number}/jobs/{job_id}

Path Parameters

org_slug*string
pipeline_slug*string
build_number*integer
Range-9223372036854776000 <= value <= 9223372036854776000
job_id*string

Response Body

application/json;charset=utf-8

curl -X GET "https://loading/api/v2/organizations/string/pipelines/string/builds/-9223372036854776000/jobs/string"
null
Empty

/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{build_number}/jobs/{job_id}/artifacts

GET
/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{build_number}/jobs/{job_id}/artifacts

Path Parameters

org_slug*string
pipeline_slug*string
build_number*integer
Range-9223372036854776000 <= value <= 9223372036854776000
job_id*string

Response Body

application/json;charset=utf-8

curl -X GET "https://loading/api/v2/organizations/string/pipelines/string/builds/-9223372036854776000/jobs/string/artifacts"
null
Empty

/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{build_number}/jobs/{job_id}/log

GET
/api/v2/organizations/{org_slug}/pipelines/{pipeline_slug}/builds/{build_number}/jobs/{job_id}/log

Path Parameters

org_slug*string
pipeline_slug*string
build_number*integer
Range-9223372036854776000 <= value <= 9223372036854776000
job_id*string

Query Parameters

since_idx?integer
Range-9223372036854776000 <= value <= 9223372036854776000

Response Body

application/json;charset=utf-8

curl -X GET "https://loading/api/v2/organizations/string/pipelines/string/builds/-9223372036854776000/jobs/string/log"
null
Empty
Empty

Internal

Previous Page

Ping GET

Next Page