GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation updates a specific deployment in a GitLab project using the GitLab API. It is useful for scenarios where you need to modify deployment details such as status or environment for a given deployment ID within a project. For example, updating deployment information after a new release or correcting deployment metadata.

Use Case Examples

  1. Updating deployment status for a project in GitLab
  2. Modifying deployment environment details for a specific deployment ID

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Specifies the authentication method to use, defaulting to GitLab API authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but can be set to PUT for this operation.
Path Parameters Parameters for the API path including project ID and deployment ID to identify the deployment to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the deployment.

Dependencies

  • GitLab API authentication token

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 GitLab API deployment update schema to avoid validation errors.

Links

Discussion