GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows users to create a new pipeline schedule for a specific project in GitLab by making a POST request to the GitLab API endpoint `/api/v4/projects/{id}/pipeline_schedules`. It is useful for automating and managing pipeline schedules programmatically within GitLab projects, such as setting up recurring CI/CD pipelines.

Use Case Examples

  1. Automate the creation of pipeline schedules for a project to run CI/CD pipelines at specific times.
  2. Integrate GitLab pipeline scheduling into a larger workflow automation system to manage project pipelines dynamically.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated API access.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but POST is used for this operation.
Path Parameters Parameters to be included in the request path, specifically the project ID or URL-encoded path required to identify the project for which the pipeline schedule is created.

Output

JSON

  • id - The unique identifier of the created pipeline schedule.
  • description - Description of the pipeline schedule.
  • ref - The Git reference (branch or tag) the pipeline schedule runs on.
  • cron - The cron syntax string defining the schedule timing.
  • cron_timezone - The timezone for the cron schedule.
  • active - Boolean indicating if the pipeline schedule is active.
  • next_run_at - Timestamp of the next scheduled run.
  • owner
    • id - ID of the user who owns the pipeline schedule.
    • name - Name of the user who owns 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 authentication credentials (GitLab API key) are valid and have sufficient permissions to create pipeline schedules.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • If the API returns an error, review the request body schema to ensure all required fields for creating a pipeline schedule are included and correctly formatted.

Links

Discussion