GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation updates a specific domain for a project's pages in GitLab using the GitLab API. It is useful for managing custom domains associated with GitLab Pages for a project, allowing users to modify domain settings programmatically. For example, a user can update the domain configuration of their project's GitLab Pages to reflect changes in DNS or SSL settings.

Use Case Examples

  1. Updating the domain settings of a GitLab Pages site for a project to enable HTTPS or change the domain name.
  2. Automating domain management for multiple projects hosted on GitLab Pages.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, typically an API key credential.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is PUT.
Path Parameters Parameters for the API path, including the project ID and the domain to update.

Output

JSON

  • response - The JSON response from the GitLab API after updating the domain.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID and domain parameters are correctly specified and URL-encoded if necessary.
  • Verify that the authentication credentials are valid and have sufficient permissions to update project pages domains.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • Common error messages may include 401 Unauthorized (invalid credentials), 404 Not Found (project or domain does not exist), and 400 Bad Request (invalid request body). Resolving these involves correcting credentials, verifying resource existence, and validating request data.

Links

Discussion