Runners are external processes used to run CI jobs. They are deployed by the administrator and registered to the GitLab instance.

Shared runners are available for all projects. Specific runners are enabled for a list of projects.

• v4 API:
  • :class:`gitlab.v4.objects.Runner`
  • :class:`gitlab.v4.objects.RunnerManager`
  • :attr:`gitlab.Gitlab.runners`
• GitLab API: https://docs.gitlab.com/ce/api/runners.html

Use the list() and all() methods to list runners.

Both methods accept a scope parameter to filter the list. Allowed values for this parameter are:

• active
• paused
• online
• specific (all() only)
• shared (all() only)

# List owned runners
runners = gl.runners.list()
# With a filter
runners = gl.runners.list(scope='active')
# List all runners, using a filter
runners = gl.runners.all(scope='paused')

Get a runner's detail:

runner = gl.runners.get(runner_id)

Register a new runner:

runner = gl.runners.create({'token': secret_token})

Update a runner:

runner = gl.runners.get(runner_id)
runner.tag_list.append('new_tag')
runner.save()

Remove a runner:

gl.runners.delete(runner_id)
# or
runner.delete()

Verify a registered runner token:

try:
    gl.runners.verify(runner_token)
    print("Valid token")
except GitlabVerifyError:
    print("Invalid token")

• v4 API:
  • :class:`gitlab.v4.objects.ProjectRunner`
  • :class:`gitlab.v4.objects.ProjectRunnerManager`
  • :attr:`gitlab.v4.objects.Project.runners`
• GitLab API: https://docs.gitlab.com/ce/api/runners.html

List the runners for a project:

runners = project.runners.list()

Enable a specific runner for a project:

p_runner = project.runners.create({'runner_id': runner.id})

Disable a specific runner for a project:

project.runners.delete(runner.id)

• v4 API:
  • :class:`gitlab.v4.objects.RunnerJob`
  • :class:`gitlab.v4.objects.RunnerJobManager`
  • :attr:`gitlab.v4.objects.Runner.jobs`
• GitLab API: https://docs.gitlab.com/ce/api/runners.html

List for jobs for a runner:

jobs = runner.jobs.list()

Filter the list using the jobs status:

# status can be 'running', 'success', 'failed' or 'canceled'
active_jobs = runner.jobs.list(status='running')