GitLab API

GitlabTool

Actions1000

Overview

This node interacts with the GitLab API to retrieve details of a specific pipeline schedule for a given project. It is useful for users who want to programmatically access pipeline schedule information within their GitLab projects, such as for automation or monitoring purposes. For example, a DevOps engineer might use this node to fetch pipeline schedule details to trigger notifications or integrate with other CI/CD tools.

Use Case Examples

  1. Retrieve pipeline schedule details for project ID 18 and pipeline schedule ID 13 to monitor scheduled CI/CD jobs.
  2. Automate fetching of pipeline schedule information to update dashboards or reports.

Properties

Name Meaning
Skip Authentication Option to bypass 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.
Path Parameters Parameters required in the URL path to specify the project ID and pipeline schedule ID.

Output

JSON

  • id - The unique identifier of the pipeline schedule.
  • description - Description of the pipeline schedule.
  • ref - The Git reference (branch or tag) the pipeline schedule runs on.
  • cron - The cron schedule expression defining when the pipeline runs.
  • cron_timezone - Timezone for the cron schedule.
  • next_run_at - Timestamp of the next scheduled run.
  • active - Boolean indicating if the pipeline schedule is active.
  • owner
    • id - ID of the owner of the pipeline schedule.
    • name - Name of the owner of the pipeline schedule.
    • username - Username of the owner of the pipeline schedule.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and pipeline schedule ID are correctly provided and URL-encoded if necessary.
  • Verify that the GitLab API authentication credentials are valid and have sufficient permissions to access the project and pipeline schedule.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 404 Not Found if the project or pipeline schedule does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion