GitLab API icon

GitLab API

Gitlab

Actions917

Overview

This node interacts with the GitLab API to retrieve deploy keys using the GitLab API v4 endpoint. It is useful for automating the management and retrieval of deploy keys in GitLab projects, which are SSH keys that allow read-only or read-write access to repositories. Common scenarios include fetching deploy keys for auditing, synchronization, or integration with other systems.

Use Case Examples

  1. Fetch all deploy keys from a GitLab instance for auditing purposes.
  2. Retrieve only public deploy keys to display in a dashboard.
  3. Paginate through deploy keys to process them in batches.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the API requests are sent.
Method HTTP method used for the API request, default is GET.
Query Parameters Parameters to filter and paginate the deploy keys retrieved from the API.

Output

JSON

  • deploy_keys - Array of deploy key objects retrieved from the GitLab API, each containing details about a deploy key such as id, title, key, and access level.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access deploy keys.
  • Verify the baseUrl is correct and points to a valid GitLab instance.
  • Check query parameters for correct types and values to avoid API errors.
  • Common error messages may include authentication failures, invalid endpoint paths, or rate limiting by the GitLab API.

Links

Discussion