GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node interacts with the GitLab API to retrieve dictionary table information from a specified database within the Admin resource. It is useful for administrators who need to query metadata about database tables in GitLab's internal databases, such as 'main' or 'ci'. For example, an admin can use this node to get schema details of a particular table in the 'main' database.

Use Case Examples

  1. Retrieve metadata for a specific table named 'users' in the 'main' database to understand its structure.
  2. Query the 'ci' database for a table's dictionary information to assist in CI/CD pipeline debugging.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated endpoints.
Authentication Type of authentication used, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the API request is sent, default is https://gitlab.com.
Method HTTP method used for the API request, default is GET.
Path Parameters Parameters to specify the database and table names for the API request.

Output

JSON

  • database_name - The name of the database queried.
  • table_name - The name of the table queried.
  • dictionary_table_info - The detailed dictionary information about the specified table returned from the API.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the 'database_name' and 'table_name' path parameters are correctly set and valid; otherwise, the API will return an error.
  • If authentication is required and 'Skip Authentication' is false, ensure the GitLab API key credential is correctly configured and has sufficient permissions.
  • Common error messages include 401 Unauthorized (due to missing or invalid API key) and 404 Not Found (if the database or table name does not exist).
  • Verify the baseUrl is correct and accessible from the network where the node is running.

Links

Discussion