GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation interacts with the GitLab API to retrieve information about a specific Pages domain for a given project. It is useful for users who want to programmatically access details about a project's Pages domain, such as verifying domain settings or status. For example, a developer managing multiple GitLab projects can automate the retrieval of domain information for monitoring or integration purposes.

Use Case Examples

  1. Retrieve the Pages domain details for a project with a specific ID and domain name to verify domain configuration.
  2. Automate the process of checking the status of a Pages domain associated with a GitLab project.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API 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.
Path Parameters Parameters to specify the project ID and domain for the API request.

Output

JSON

  • id - The ID or URL-encoded path of the project.
  • domain - The domain name of the Pages domain.
  • status - The status of the Pages domain.
  • certificate - Information about the SSL certificate for the domain, if available.
  • auto_ssl_enabled - Indicates if automatic SSL is enabled for the domain.

Dependencies

  • GitLab API authentication token

Troubleshooting

  • Ensure the project ID and domain parameters are correctly specified and URL-encoded if necessary.
  • Verify that the authentication token has sufficient permissions to access the project and its Pages domains.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages include 404 Not Found if the project or domain does not exist, and 401 Unauthorized if authentication fails.

Links

Discussion