Hanzo AI
OpenapiGit

Get runs

Returns one run.

GET /v1/git/runs/{id}

Addresshttps://api.hanzo.ai/v1/git/runs/{id}
MethodGET
Operationget_git_runs_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one run.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the run to read, from the :id path segment.

Response

StatusBodyMeaning
200git.workflowRunok
defaultproblem-detailsrefused

200 body — 11 fields.

FieldInTypeAlwaysDescription
actorbodystringActor is who caused it.
commitbodystringCommit is the commit being run, in full.
createdAtbodyinteger (int64)CreatedAt is when the run was opened, in unix seconds.
eventbodystringEvent is what caused the run, e.g.
idbodystringID addresses this run.
numberbodyinteger (int64)Number is the run's position in its repository, counting from 1 — the handle a person uses ("#4").
refbodystringRef is the full ref, e.g.
repobodystringRepo is the repository the run is for.
statusbodystringStatus is waiting, running, success, failure, cancelled or skipped.
updatedAtbodyinteger (int64)UpdatedAt is when its status last changed, in unix seconds.
workflowbodystringWorkflow is the path of the document being run, e.g.

Failure carries the platform error shape — see Errors.

Examples

hanzo git runs get <id>

Git API · All Hanzo APIs · Interactive reference

How is this guide?

On this page