GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves detailed user agent information for a specific snippet from the GitLab API. It is useful for scenarios where you need to analyze or audit the user agent data associated with a particular snippet, such as tracking usage patterns or debugging access issues.

Use Case Examples

  1. Fetch user agent details for a snippet with ID 123 to understand which clients accessed it.
  2. Audit user agent information for snippets to monitor access sources.

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 request is sent.
Method The HTTP method used for the API request, defaulting to GET.
Parameter Schema Defines the path parameter 'id' which is the ID of the snippet to retrieve user agent details for.
Request Body Schema Schema for the request body, which is null for this GET operation.
Request Path The API endpoint path template used to fetch user agent details for a snippet.
Path Parameters Collection of path parameters including 'id' which specifies the snippet ID.

Output

JSON

  • user_agent_detail - Detailed information about the user agent associated with the snippet.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the snippet ID provided in the path parameters is valid and exists in the GitLab instance.
  • If authentication is enabled, verify that the GitLab API key credential is correctly configured and has sufficient permissions.
  • Check the baseUrl 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 snippet ID does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion