GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves detailed information about a specific project from the GitLab API (version 4). It is useful for scenarios where you need to fetch project metadata, including optional statistics, custom attributes, and license data, by specifying the project ID or URL-encoded path. For example, it can be used in automation workflows to monitor project details or integrate project data into other systems.

Use Case Examples

  1. Fetch project details by project ID to display in a dashboard.
  2. Retrieve project statistics and license information for reporting purposes.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, hidden unless Skip Authentication is false.
baseUrl The base URL of the GitLab instance to send the API request to.
Method The HTTP method to use for the API request (GET, POST, PUT, DELETE, HEAD, PATCH).
Parameter Schema Defines the parameters for the API request, including path and query parameters such as project ID, statistics, custom attributes, and license inclusion.
Request Body Schema Schema for the request body, if applicable (null for this operation).
Request Path The API endpoint path with a placeholder for the project ID.
Query Parameters Optional query parameters to include in the API request, such as statistics, custom attributes, and license.
Path Parameters Path parameters for the API request, specifically the project ID or URL-encoded path.

Output

JSON

  • id - The unique identifier of the project.
  • name - The name of the project.
  • description - The description of the project.
  • web_url - The web URL of the project.
  • statistics - Project statistics if requested.
  • custom_attributes - Custom attributes of the project if requested.
  • license - License information of the project if requested.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly provided in the path parameters; otherwise, the API request will fail.
  • If authentication is enabled, verify that the GitLab API credential is correctly configured and has sufficient permissions to access the project data.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If optional query parameters like statistics, custom attributes, or license are used, ensure they are correctly formatted as boolean strings ('true' or 'false').

Links

Discussion