GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves information about a specific namespace from the GitLab API (version 4). It is useful for scenarios where you need to fetch details about a namespace by its ID or URL-encoded path, such as managing projects, groups, or user namespaces within GitLab.

Use Case Examples

  1. Fetch details of a GitLab namespace by providing its ID or URL-encoded path to integrate namespace data into a workflow.
  2. Use the node to verify namespace information before performing further operations like project creation or access control.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the request.
Authentication The authentication method used for the request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the request, defaulting to GET.
Path Parameters The path parameters for the request, specifically the 'id' which is the ID or URL-encoded path of the namespace to retrieve.

Output

JSON

  • id - The unique identifier of the namespace.
  • name - The name of the namespace.
  • path - The URL-encoded path of the namespace.
  • kind - The type of namespace (e.g., user, group).
  • full_path - The full path of the namespace.
  • parent_id - The ID of the parent namespace, if any.
  • avatar_url - URL to the avatar image of the namespace.
  • web_url - The web URL to access the namespace in GitLab.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the 'id' path parameter is correctly provided and URL-encoded if necessary, as missing or incorrect IDs will cause request failures.
  • If authentication is enabled, verify that the GitLab API key credential is valid and has sufficient permissions to access namespace information.
  • Check the baseUrl property to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages include 404 Not Found if the namespace ID does not exist, and 401 Unauthorized if authentication fails. Resolving these involves verifying the ID and authentication credentials respectively.

Links

Discussion