GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves information about a specific domain associated with a project's pages in GitLab using the GitLab API v4. It is useful for scenarios where you need to manage or verify domain settings for GitLab Pages within a particular project, such as checking domain status or configuration details.

Use Case Examples

  1. Fetch details of a custom domain used in GitLab Pages for a project to verify its setup.
  2. Retrieve domain information to automate monitoring or updating domain configurations in a CI/CD pipeline.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public endpoints or testing.
Authentication Select the authentication method, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Path Parameters Parameters to specify the project ID or URL-encoded path and the domain name to query.

Output

JSON

  • id - The project ID or URL-encoded path used in the request
  • domain - The domain name queried in the request
  • response - The JSON response from the GitLab API containing domain details

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID and domain parameters are correctly URL-encoded and valid.
  • If authentication is enabled, verify that the GitLab API key has sufficient permissions to access project pages domains.
  • Common errors include 404 Not Found if the project or domain does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion