GitLab API

GitlabTool
Join our community

Actions1000

Overview

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

Use Case Examples

  1. Fetch a wiki page by its slug to display project documentation in an external app.
  2. Retrieve a specific version of a wiki page for audit or review purposes.
  3. Render the wiki page content as HTML for web display.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Query Parameters Optional query parameters for the request, including version hash and render_html flag.
Path Parameters Required path parameters identifying the project and wiki page slug.

Output

JSON

  • id - The unique identifier of the wiki page.
  • slug - The slug of the wiki page.
  • title - The title of the wiki page.
  • content - The content of the wiki page.
  • format - The format of the wiki page content.
  • version - The version hash of the wiki page.
  • created_at - The creation timestamp of the wiki page.
  • updated_at - The last update timestamp of the wiki page.

Dependencies

  • GitLab API authentication token or API key

Troubleshooting

  • Ensure the project ID and slug are correctly specified; incorrect values will result in a 404 Not Found error.
  • If authentication is skipped, the request may fail due to lack of permissions.
  • Check that the baseUrl is correct for your GitLab instance, especially if using a self-hosted GitLab server.

Links

Discussion