GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves information about a specific table in the dictionary of a specified database within the GitLab Admin API. It is useful for administrators who need to query metadata or schema details of database tables managed by GitLab, such as the 'main' or 'ci' databases. For example, an admin can use this node to get details about a table's structure or properties for auditing or management purposes.

Use Case Examples

  1. Retrieve metadata for a table named 'users' in the 'main' database to understand its schema.
  2. Fetch details of a 'builds' table in the 'ci' database to monitor continuous integration data storage.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used for the request, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance to which the request is sent. Defaults to https://gitlab.com.
Method The HTTP method used for the request. Defaults to GET.
Parameter Schema Defines the required path parameters for the request: 'database_name' (the database to query) and 'table_name' (the specific table to retrieve information about).
Request Body Schema Schema for the request body, which is null for this GET operation.
Request Path The API endpoint path template used for the request, including placeholders for database and table names.
Path Parameters Collection of path parameters specifying the database name and table name for the API call.

Output

JSON

  • response - The JSON response from the GitLab Admin API containing details about the specified database table.

Dependencies

  • Requires GitLab API authentication credentials (an API key or token).

Troubleshooting

  • Ensure the 'database_name' and 'table_name' path parameters are correctly set and correspond to existing resources in the GitLab instance.
  • If authentication is enabled, verify that the API key or token has sufficient permissions to access admin database endpoints.
  • Check the baseUrl to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common errors include 401 Unauthorized (due to missing or invalid credentials), 404 Not Found (if the database or table does not exist), and 400 Bad Request (if path parameters are malformed).

Links

Discussion