GitLab API icon

GitLab API

Gitlab

Actions1062

Projects → putApiV4ProjectsIdPagesDomainsDomain

AI-generated

Summary

Update an existing domain configuration for GitLab Pages on a specific project by project ID or URL-encoded path and domain name, using the provided domain settings in the request body.

Inputs

  • Id (required) — The ID or URL-encoded path of the project owned by the authenticated user.
  • Domain (required) — The domain to update for the project's GitLab Pages.
  • Request Body (required) — The configuration settings to apply when updating the GitLab Pages domain.
  • Skip Authentication — Optionally skip authentication; defaults to false requiring authentication.
  • Base URL — The base URL of the GitLab instance; defaults to https://gitlab.com.

Output shape

a single record

The operation returns the updated domain configuration object for the specified project and domain. Authentication is required unless explicitly skipped. The request follows the PUT HTTP method at the path /api/v4/projects/{id}/pages/domains/{domain}.

Examples

Example 1: Update a GitLab Pages domain configuration

Provide project ID or path, domain name, and the domain settings in the request body to update the domain settings of GitLab Pages for that project.

Links

Discussion