GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves a specific custom attribute of a project from the GitLab API. It is useful for scenarios where you need to access detailed metadata or custom information associated with a GitLab project, such as project-specific tags or custom fields defined by the user. For example, you might use this node to fetch a custom attribute by its key for a given project ID to display or process that information in your workflow.

Use Case Examples

  1. Fetch a custom attribute 'environment' for project ID 123 to determine deployment settings.
  2. Retrieve a custom attribute 'priority' for project ID 456 to prioritize project tasks automatically.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated API access.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method HTTP method used for the API request, defaulting to GET to retrieve data.
Path Parameters Parameters used in the API request path to specify the project ID and the key of the custom attribute to retrieve.

Output

JSON

  • id - The ID of the project.
  • key - The key of the custom attribute.
  • value - The value of the custom attribute.
  • created_at - Timestamp when the custom attribute was created.
  • updated_at - Timestamp when the custom attribute was last updated.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID and custom attribute key are correctly specified; incorrect values will result in API errors.
  • If authentication is enabled, verify that the GitLab API key credential is valid and has sufficient permissions to access project custom attributes.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct and accessible.
  • Common error messages include 404 Not Found if the project or custom attribute does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion