GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation allows users to approve a specific deployment within a GitLab project via the GitLab API. It is useful in continuous deployment workflows where manual approval is required before a deployment proceeds. For example, a DevOps engineer can automate the approval process of deployments in a GitLab project to streamline release management.

Use Case Examples

  1. Approving a deployment in a GitLab project to trigger subsequent pipeline steps.
  2. Automating deployment approvals as part of a CI/CD pipeline in GitLab.

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.
Path Parameters Parameters for the API path including project ID and deployment ID.

Output

JSON

  • approval_status - Status of the deployment approval returned by the API.
  • deployment_id - ID of the deployment that was approved.
  • project_id - ID of the project containing the deployment.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and deployment ID are correct and accessible by the authenticated user.
  • Verify that the API key has sufficient permissions to approve deployments.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error: 401 Unauthorized - indicates authentication failure, check API key validity.
  • Common error: 404 Not Found - indicates the project or deployment ID does not exist or is not accessible.

Links

Discussion