GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves a specific deploy key from a GitLab project using the GitLab API. It is useful for scenarios where you need to access details about a deploy key associated with a project, such as verifying key information or managing project access keys.

Use Case Examples

  1. Fetching deploy key details for a project to audit access keys.
  2. Retrieving a deploy key to check its properties before updating or deleting it.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, defaulting to GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Path Parameters Parameters for the API path including project ID and deploy key ID.

Output

JSON

  • id - The ID of the deploy key.
  • title - The title of the deploy key.
  • key - The SSH key content.
  • created_at - Timestamp when the deploy key was created.
  • can_push - Boolean indicating if the deploy key has push access.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and deploy key ID are correct and accessible by the authenticated user.
  • Verify that the GitLab API key credential is valid and has sufficient permissions.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 404 Not Found if the deploy key or project does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion