GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates a specific deployment within a GitLab project using the GitLab API. It is useful for managing deployment details programmatically, such as updating deployment status or metadata. For example, a DevOps engineer can automate deployment updates as part of a CI/CD pipeline.

Use Case Examples

  1. Updating deployment status after a successful release.
  2. Modifying deployment metadata for tracking purposes.

Properties

Name Meaning
Skip Authentication Determines whether to skip API authentication for the request.
Authentication Specifies the authentication method to use, typically a GitLab API key.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is PUT for this operation.
Path Parameters Parameters to specify the project ID and deployment ID for the update operation.

Output

JSON

  • response - The JSON response from the GitLab API after updating the deployment, containing updated deployment details.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and deployment ID are correct and accessible by the authenticated user.
  • Verify that the GitLab API key has sufficient permissions to update deployments.
  • Check the base URL if using a self-hosted GitLab instance instead of gitlab.com.
  • Common error: 401 Unauthorized - indicates authentication failure; verify API key and authentication settings.
  • Common error: 404 Not Found - indicates the project or deployment ID does not exist or is not accessible.

Links

Discussion