GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation performs an approval action on a specific deployment within a GitLab project. It is useful for automating deployment approval workflows in CI/CD pipelines, where a deployment needs to be programmatically approved as part of the process. For example, it can be used to approve a deployment after successful tests or manual review.

Use Case Examples

  1. Approving a deployment in a GitLab project after automated tests pass.
  2. Automating deployment approvals in a GitLab CI/CD pipeline.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used for the request, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is POST for this operation.
Path Parameters Parameters required in the request path to identify the project and deployment.

Output

JSON

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

Dependencies

  • GitLab API authentication token

Troubleshooting

  • Ensure the project ID and deployment ID are correct and accessible by the authenticated user.
  • Verify that the API token has sufficient permissions to approve deployments.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include authentication failures, resource not found (invalid project or deployment ID), and permission denied errors. Resolving these typically involves verifying credentials, IDs, and user permissions.

Links

Discussion