GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation triggers the play action on a specific job within a GitLab project. It is useful for automating CI/CD workflows by programmatically starting jobs in GitLab pipelines. For example, it can be used to restart a failed job or trigger a manual job in a pipeline without using the GitLab web interface.

Use Case Examples

  1. Trigger a manual job in a GitLab project pipeline to start deployment.
  2. Restart a failed CI job automatically as part of a workflow.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is 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 specify the project ID and job ID for the job to be played.

Output

JSON

  • response - The JSON response from GitLab API after triggering the job play action, typically containing job details and status.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and job ID are correct and exist in GitLab.
  • Verify that the API key has sufficient permissions to trigger jobs in the project.
  • Check network connectivity to the GitLab instance specified by baseUrl.
  • Common error: 401 Unauthorized - indicates invalid or missing API key.
  • Common error: 404 Not Found - indicates the project or job ID does not exist.

Links

Discussion