Cloud SDKReference
Generated @harmont/cloud reference for the Jobs endpoints.
getJob
GET /api/v0/organizations/{org}/pipelines/{pipeline}/builds/{number}/jobs/{job_id}
Get a job
Returns a single job within the build. A job_id that belongs to another build is reported as 404.
import { getJob } from "@harmont/cloud";getJob(options): RequestResult<GetJobResponse>| Parameter | In | Type | Description |
|---|---|---|---|
org | path | string | The organization slug. |
pipeline | path | string | The pipeline slug. |
number | path | number | The build number. |
job_id | path | string | The job id. |
Returns GetJobResponse
See GET /api/v0/organizations/{org}/pipelines/{pipeline}/builds/{number}/jobs/{job_id} for the full request and response schema.
listJobs
GET /api/v0/organizations/{org}/pipelines/{pipeline}/builds/{number}/jobs
List a build's jobs
Returns the build's jobs in DAG creation order.
import { listJobs } from "@harmont/cloud";listJobs(options): RequestResult<ListJobsResponse>| Parameter | In | Type | Description |
|---|---|---|---|
org | path | string | The organization slug. |
pipeline | path | string | The pipeline slug. |
number | path | number | The build number. |
Returns ListJobsResponse
See GET /api/v0/organizations/{org}/pipelines/{pipeline}/builds/{number}/jobs for the full request and response schema.