GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves pipeline schedules for a specific project in GitLab using the GitLab API v4. It is useful for users who want to programmatically access and manage pipeline schedules associated with a project, such as viewing active or inactive schedules, paginating through results, or filtering by scope. Practical examples include automating CI/CD pipeline management or integrating project pipeline schedules into other tools or dashboards.

Use Case Examples

  1. Fetch all pipeline schedules for project ID 18.
  2. Retrieve only active pipeline schedules for a given project.
  3. Paginate through pipeline schedules with custom page size.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated access scenarios.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to send the API request to, default is https://gitlab.com.
Method HTTP method to use for the API request, default is GET.
Query Parameters Optional query parameters to control pagination and filtering of pipeline schedules.
Path Parameters Path parameters required for the API endpoint, specifically the project ID or URL-encoded path.

Output

JSON

  • pipeline_schedules - List of pipeline schedules for the specified project, including details such as schedule ID, description, cron timing, and status.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the authenticated user.
  • Verify that the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • Check that the authentication credentials are valid and have sufficient permissions to access pipeline schedules.
  • If pagination parameters are used, ensure they are valid integers and within allowed ranges.

Links

Discussion