GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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 deploy keys for multiple projects in bulk as part of a CI/CD pipeline setup.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated API access.
Authentication Specifies the authentication method to use, defaulting to GitLab API key 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 POST is used for this operation.
Path Parameters Parameters required in the API path to identify the project and deploy key to enable.

Output

JSON

  • statusCode - HTTP status code of the API response indicating success or failure.
  • body - The response body from the GitLab API, typically containing details about the enabled deploy key or error information.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and deploy key ID are correct and the authenticated user has permission to enable deploy keys on the project.
  • If authentication is skipped, verify that the GitLab instance allows unauthenticated access for this operation.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion