GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation enables a deploy key for a specific project in GitLab. It is useful for automating the process of activating deploy keys, which are SSH keys that allow read-only or read-write access to a repository, facilitating secure and automated deployments or integrations.

Use Case Examples

  1. Automatically enable a deploy key for a project after it has been created to allow deployment scripts to access the repository.
  2. Enable a specific deploy key for a project as part of a CI/CD pipeline setup.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
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 The HTTP method to use for the request, defaulting to GET but can be set to POST, PUT, DELETE, HEAD, or PATCH.
Path Parameters Parameters to specify the project ID or URL-encoded path and the deploy key ID to enable.

Output

JSON

  • response - The response from the GitLab API after enabling the deploy key.

Dependencies

  • GitLab API authentication

Troubleshooting

  • Ensure the project ID and deploy key ID are correctly specified and exist in GitLab.
  • Verify that the authentication credentials are valid and have the necessary permissions to enable deploy keys.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.

Links

Discussion