GitLab API icon

GitLab API

Gitlab

Actions880

Overview

This node operation allows users to create a new domain for GitLab Pages within a specific project. It is useful for managing custom domains associated with GitLab Pages, enabling users to add domains to their projects programmatically. For example, a user can automate the process of adding a new domain to a project’s GitLab Pages site via this operation.

Use Case Examples

  1. Automate adding a custom domain to a GitLab Pages project.
  2. Manage multiple project domains programmatically in GitLab.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Path Parameters Parameters to be included in the request path, specifically the project ID or URL-encoded path.

Output

JSON

  • id - The ID or URL-encoded path of the project owned by the authenticated user, used in the request path.
  • postApiV4ProjectsIdPagesDomains - The request body schema for creating a new domain for GitLab Pages in the specified project.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in path parameters is correct and accessible by the authenticated user.
  • Verify that the authentication token has sufficient permissions to create domains for GitLab Pages.
  • Check the baseUrl if using a self-hosted GitLab instance to ensure it is correct.
  • Common errors include authentication failures, invalid project ID, or malformed request body. Verify all required fields are provided and correctly formatted.

Links

Discussion