GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves the runners associated with a specific GitLab project using the GitLab API v4. It is useful for DevOps teams and developers who want to manage or monitor CI/CD runners assigned to their projects. For example, it can be used to list all active runners for a project or filter runners by status or tags.

Use Case Examples

  1. Retrieve all runners for a project with ID '123'.
  2. Filter runners by status 'active' and tag 'macos'.
  3. Paginate through runners with 20 runners per page.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Query Parameters Optional filters and pagination parameters for the runners list.
Path Parameters The ID or URL-encoded path of the project owned by the authenticated user.

Output

JSON

  • id - The unique identifier of the runner.
  • description - Description of the runner.
  • active - Whether the runner is active.
  • is_shared - Whether the runner is shared.
  • status - Current status of the runner.
  • tags - Tags associated with the runner.
  • version - Version of the runner.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the project ID is correct and accessible by the authenticated user to avoid 404 errors.
  • Check that the authentication token has sufficient permissions to read project runners.
  • If filtering by tags or status, verify the values are valid and supported by the GitLab API.
  • Pagination parameters must be integers; invalid values may cause request failures.

Links

Discussion