GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation updates a deploy key for a specific project in GitLab using the GitLab API. It is useful for managing deploy keys programmatically, such as enabling or disabling keys or updating their properties without manually accessing the GitLab web interface. For example, a DevOps engineer can automate the update of deploy keys across multiple projects to maintain security and access control.

Use Case Examples

  1. Updating the title or access level of a deploy key for a project.
  2. Enabling or disabling a deploy key for automated deployment processes.

Properties

Name Meaning
Skip Authentication If true, the node will skip authentication when making the API request.
Authentication The authentication method used for the API 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 used for the request, here it is set to PUT for updating resources.
Parameter Schema Defines the parameters required for the operation, including project ID and deploy key ID.
Request Body Schema The schema defining the structure of the request body for updating the deploy key.
Request Path The API endpoint path for the update operation, including placeholders for project ID and deploy key ID.
Path Parameters Collection of path parameters including 'id' (project ID or URL-encoded path) and 'key_id' (deploy key ID) required to identify the resource to update.

Output

JSON

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

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and deploy key ID are correct and exist in GitLab to avoid 404 errors.
  • Verify that the API token used has sufficient permissions to update deploy keys in the specified project.
  • Check the request body schema to ensure all required fields are provided and correctly formatted to prevent validation errors.

Links

Discussion