GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves pipeline schedules for a specific project from the GitLab API (version 4). It is useful for users who want to programmatically access and manage pipeline schedules associated with their GitLab projects, such as for automation or monitoring purposes. For example, a DevOps engineer might use this node to fetch active or inactive pipeline schedules to analyze or trigger CI/CD workflows.

Use Case Examples

  1. Fetch all pipeline schedules for project ID 18.
  2. Retrieve only active pipeline schedules for a given project.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API requests are sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Optional query parameters to filter or paginate the pipeline schedules.
Path Parameters Path parameters required for the API endpoint.

Output

JSON

  • ``
    • id - The unique identifier of each pipeline schedule.
    • description - Description of the pipeline schedule.
    • ref - The Git reference (branch or tag) the pipeline schedule runs on.
    • cron - The cron syntax defining the schedule timing.
    • cron_timezone - Timezone for the cron schedule.
    • active - Indicates if the pipeline schedule is active.
    • next_run_at - Timestamp of the next scheduled run.
    • owner - Information about the owner of the pipeline schedule.

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 GitLab API key credential is valid and has sufficient permissions to read pipeline schedules.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • If pagination parameters (page, per_page) are used, ensure they are valid integers to avoid API errors.

Links

Discussion