GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API to manage deploy keys, specifically supporting the operation to create (POST) deploy keys via the /api/v4/deploy_keys endpoint. It is useful for automating the addition of deploy keys to GitLab projects, which can be used for secure, read-only or read-write access to repositories without using user credentials.

Use Case Examples

  1. Automatically add deploy keys to multiple GitLab projects during CI/CD pipeline setup.
  2. Create deploy keys programmatically to enable secure repository access for deployment servers.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API requests are sent.
Method HTTP method to use for the API request, defaulting to GET but supporting POST for creating deploy keys.
Parameter Schema Defines the schema for the parameters required by the postApiV4DeployKeys operation, specifying the request body structure.
Request Body Schema Schema for the request body sent when creating deploy keys, defining required fields and structure.
Request Path The API endpoint path for creating deploy keys, fixed to /api/v4/deploy_keys.

Output

JSON

  • id - Unique identifier of the created deploy key.
  • title - 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 write access.
  • fingerprint - Fingerprint of the SSH key.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Authentication errors if the API key is missing or invalid. Ensure the GitLab API key credential is correctly configured.
  • Validation errors if the request body does not conform to the expected schema for deploy keys. Verify the request body fields and types.
  • Network or connectivity issues if the baseUrl is incorrect or the GitLab instance is unreachable.

Links

Discussion