GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation fetches the forks of a specific project from the GitLab API (v4). It is useful for users who want to retrieve information about all the forks of a given project, such as in scenarios where they need to analyze forked repositories, track contributions, or manage project forks programmatically.

Use Case Examples

  1. Retrieve all forks of a project by specifying the project ID or URL-encoded path.
  2. Filter forks by various query parameters like order, visibility, archived status, and more to get customized results.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip authentication when making the API request.
Authentication The authentication method used for the API request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters A collection of optional query parameters to filter and customize the list of forks returned by the API, such as order_by, sort, archived, visibility, search, owned, starred, membership, and pagination options.
Path Parameters The path parameter 'id' specifies the ID or URL-encoded path of the project whose forks are to be retrieved.

Output

JSON

  • id - The unique identifier of each forked project.
  • name - The name of each forked project.
  • path - The path or URL-encoded path of each forked project.
  • created_at - The creation date of each forked project.
  • updated_at - The last update date of each forked project.
  • visibility - The visibility level of each forked project (e.g., private, internal, public).
  • archived - Indicates if the forked project is archived.
  • star_count - Number of stars the forked project has received.
  • last_activity_at - Timestamp of the last activity in the forked project.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly specified in the path parameters; otherwise, the API request will fail.
  • Verify that the authentication credentials (API key) are valid and have sufficient permissions to access the project forks.
  • Check the base URL if using a self-hosted GitLab instance to ensure the API endpoint is reachable.
  • If query parameters are used, ensure they conform to the expected types and values to avoid API errors.

Links

Discussion