GitLab API

GitlabTool

Actions1000

Overview

This node operation retrieves deploy keys for a specific GitLab project using the GitLab API. It is useful for scenarios where you need to manage or audit deploy keys associated with a project, such as verifying access or automating key management tasks. For example, a DevOps engineer might use this node to list all deploy keys for a project to ensure only authorized keys are present.

Use Case Examples

  1. Retrieve deploy keys for a project to audit access.
  2. Automate fetching deploy keys to integrate with other security tools.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key.
baseUrl The base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Query Parameters Optional query parameters for pagination, including page number and items per page.
Path Parameters Path parameters specifying the project ID or URL-encoded path to identify the project.

Output

JSON

  • deployKeys - Array of deploy keys retrieved from the GitLab project.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID or path is correctly specified in the path parameters to avoid 404 errors.
  • Verify that the API key has sufficient permissions to access the project's deploy keys to prevent authorization errors.
  • Check the base URL if using a self-hosted GitLab instance to ensure the request is sent to the correct server.

Links

Discussion