GitLab API

GitlabTool

Actions1095

Projects → putApiV4ProjectsIdPagesDomainsDomain

AI-generated

Summary

Update the domain configuration for a GitLab project's Pages domain using the specified project ID (or URL-encoded path) and domain name.

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 Pages.
  • putApiV4ProjectsIdPagesDomainsDomain (required) — The request body schema containing the domain update details according to GitLab API specifications.
  • baseUrl — Override the GitLab base URL; defaults to 'https://gitlab.com'.
  • skipAuthentication — Option to skip authentication if set to true; otherwise, requires valid GitLab API credentials.

Output shape

a JSON object representing the updated Pages domain resource for the specified project as returned by the GitLab API

Returns the updated domain resource per the GitLab API. The operation requires authentication unless 'Skip Authentication' is enabled. The Path Parameters 'id' and 'domain' are mandatory. The request body must comply with the defined 'putApiV4ProjectsIdPagesDomainsDomain' schema.

Examples

Example 1: Update a Pages domain

Set 'id' to project ID, 'domain' to the domain name, supply the domain update object in the request body, and ensure authentication is configured.

Links

Discussion