Version 4.0.25.20 (latest)
Fetches a CI Run.
Request
GET
/projects/{project_id}/ci/runs/{run_id}
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
project_id
string
Project Id
run_id
string
Run Id
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields
Response
200: CI Run
Datatype
Description
(object)
Expand Run definition...
run_id
lock
string
ID of the CI run
created_at
lock
string
Time and date that the CI run was initiated
started_at
lock
string
Time and date that the CI run began executing
finished_at
lock
string
Time and date that the CI run completed
status_url
lock
string
Git provider URL where you can view the commit status. This is the status URL that you specify when you create a CI suite
status
lock
string
Status of the CI run (unknown, failed, passed, skipped, errored, cancelled, queued, running)
git_service
lock
string
Git service for CI run (e.g. GitHub)
Expand CIGitState definition...
branch
lock
string
Git branch that the CI run validates
repository
lock
string
Git repository that contains the Git branch being validated
commit_ref
lock
string
Git commit that the CI run validates
target
lock
string
For incremental runs, the Git branch that the CI run compares against during validation
Expand RunResult definition...
Expand CIScheduleTrigger definition...
enabled
lock
boolean
Whether the CI run schedule is active
day
lock
string
For scheduled runs, day of the week that the CI run is scheduled
hour
lock
string
For schedules runs, the hour of the day (24 hour format) that the CI run is scheduled
frequency
lock
string
For scheduled runs, how often the CI run is scheduled to run (hourly, daily, weekly)
target_branch
lock
string
Git branch that the CI run compares against during validation, used for incremental runs
title
lock
string
Name of the CI suite
trigger
lock
string
Trigger for CI run (unknown, manual, schedule, change_request)
change_request
lock
Details of the change request, if the CI run was triggered by a change request
Expand CIChangeRequest definition...
change_request_number
lock
integer
Numeric identifier of the change request
change_request_url
lock
string
URL of the change request
change_request_name
lock
string
Name of the change request
change_request_commits_url
lock
string
For PR-triggered CI runs, the URL to the change request commit that triggered the run.
suite_id
lock
string
ID of the CI suite
username
lock
string
Username of the user who triggered the CI run, if the CI run was manually triggered
400: Bad Request
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link

