GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves deploy keys from the GitLab API (version 4). It is useful for scenarios where you need to list or manage deploy keys associated with GitLab projects, such as automating access control or auditing keys. For example, you can fetch all public deploy keys or paginate through deploy keys for a project.

Use Case Examples

  1. Fetch the first page of deploy keys with 20 items per page.
  2. Retrieve only public deploy keys by setting the 'public' query parameter to true.

Properties

Name Meaning
Skip Authentication If true, the node skips authentication when making the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Optional query parameters to filter or paginate the deploy keys list.

Output

JSON

  • deployKeys - Array of deploy key objects returned from the GitLab API, including details such as key ID, title, and public status.

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 accessible, especially if using a self-hosted GitLab instance.
  • Check query parameter values for correct types (e.g., integers for page and per_page, boolean for public).
  • Common error messages include authentication failures (401 Unauthorized) and invalid parameters (400 Bad Request). Resolving these involves verifying credentials and parameter formats.

Links

Discussion