GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves a list of runners associated with a specific GitLab project. It is useful for DevOps teams and project managers who want to monitor or manage 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 active or paused runners, or those matching 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.
Authentication The authentication method used, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance to connect to.
Method The HTTP method to use for the request, default is GET.
Query Parameters Optional filters and pagination parameters for the runners list.
Path Parameters The project ID or URL-encoded path to identify the project whose runners are being retrieved.

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).
  • created_at - Timestamp when the runner was created.

Dependencies

  • GitLab API authentication

Troubleshooting

  • Ensure the project ID or path is correctly specified; an incorrect ID will result in a 'not found' error.
  • Verify that the authentication credentials are valid and have sufficient permissions to access project runners.
  • Check that the base URL is correct for the GitLab instance being accessed.
  • If filtering by tags or status, ensure the values are valid and supported by the GitLab API.

Links

Discussion