GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves a specific wiki page from a GitLab group using the GitLab API. It is useful for accessing the content of a wiki page identified by its slug within a particular group, optionally specifying a version or rendering the content as HTML. Practical examples include fetching documentation pages or project notes stored in GitLab wikis for display or processing in automation workflows.

Use Case Examples

  1. Retrieve the latest version of a wiki page by providing the group ID and the page slug.
  2. Fetch a specific version of a wiki page by specifying the version hash in the query parameters.
  3. Get the wiki page content rendered as HTML by setting the render_html query parameter to true.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used for the request, hidden unless Skip Authentication is false. Defaults to GitLab API key authentication.
baseUrl The base URL of the GitLab instance. Defaults to https://gitlab.com.
Method The HTTP method to use for the request. Defaults to GET.
Query Parameters Optional query parameters for the request, including version (string) to specify the version hash of the wiki page and render_html (string) to render content as HTML.
Path Parameters Required path parameters including slug (string) for the wiki page slug and id (string) for the group ID.

Output

JSON

  • slug - The slug of the wiki page retrieved.
  • id - The group ID associated with the wiki page.
  • version - The version hash of the wiki page if specified.
  • render_html - Indicates if the content is rendered as HTML.
  • content - The content of the wiki page retrieved from the GitLab group.

Dependencies

  • GitLab API key credential for authentication unless Skip Authentication is true.

Troubleshooting

  • Ensure the group ID and slug are correctly specified; otherwise, the API will return an error indicating the resource was not found.
  • If authentication is required and the API key is missing or invalid, the node will fail with an authentication error.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct and accessible.
  • If specifying a version hash, ensure it exists; otherwise, the API may return a not found or version error.

Links

Discussion