GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation updates a specific deployment within a GitLab project using the GitLab API. It is useful for scenarios where you need to modify deployment details programmatically, such as updating deployment status or metadata. For example, a DevOps engineer might use this node to 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 based on environment changes.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, here it is set to PUT for updating resources.
Path Parameters Parameters used in the API request path to specify the project and deployment to update.

Output

JSON

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

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the project ID and deployment ID are correct and exist in GitLab to avoid 404 errors.
  • Verify that the authentication token has sufficient permissions to update deployments.
  • Check the request body schema matches the expected structure to prevent validation errors from the API.

Links

Discussion