GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves a list of runners associated with a specific GitLab project. It is useful for DevOps teams and developers who want to manage or monitor the runners assigned to their projects in GitLab. For example, it can be used to filter runners by type, status, tags, or version prefix, helping to identify which runners are active, paused, or match specific criteria.

Use Case Examples

  1. Retrieve all runners for a project with ID '123'.
  2. Filter runners to show only active project-type runners.
  3. Get runners tagged with 'macos' and 'shell' for a specific project.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to connect to, default is 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, including scope, type, paused status, runner status, tag list, version prefix, page number, and items per page.
Path Parameters The ID or URL-encoded path of the project owned by the authenticated user, required to specify which project's runners to retrieve.

Output

JSON

  • id - The unique identifier of the runner.
  • description - Description of the runner.
  • active - Indicates if the runner is active.
  • is_shared - Indicates if the runner is shared across projects.
  • status - Current status of the runner (e.g., active, paused).
  • tags - List of tags associated with the runner.
  • version - Version of the runner software.
  • runner_type - Type of the runner (instance, group, project).

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible by the authenticated user.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access project runners.
  • Check that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • If filtering by tags or other query parameters, ensure the values are correctly formatted and valid according to GitLab API specifications.
  • Common error messages include 401 Unauthorized (invalid or missing authentication), 404 Not Found (project or runners not found), and 400 Bad Request (invalid query parameters). Resolving these involves correcting authentication, verifying project existence, and validating input parameters.

Links

Discussion