Create Pages domain

POST

/api/v4/projects/{id}/pages/domains

• GitLab REST API

Creates a Pages domain in a specified project. You must have permissions to create Pages domains.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

One of:

string

string

integer

integer

The ID or URL-encoded path of the project owned by the authenticated user

Request Body ^required

Media type application/json

object

domain

required

The domain

string

nullable

certificate

One of:

string

string

nullable

string

string

nullable

key

One of:

string

string

nullable

string

string

nullable

auto_ssl_enabled

Enables automatic generation of SSL certificates issued by Let’s Encrypt for custom domains.

boolean

nullable

user_provided_certificate

string

nullable

user_provided_key

string

nullable

Example ^generated

{
  "domain": "example",
  "certificate": "example",
  "key": "example",
  "auto_ssl_enabled": true,
  "user_provided_certificate": "example",
  "user_provided_key": "example"
}

Responses

201

Created

Media type application/json

object

domain

string

url

string

verified

string

verification_code

string

enabled_until

string

auto_ssl_enabled

string

certificate

object

subject

string

expired

string

certificate

string

certificate_text

string

Example ^generated

{
  "domain": "example",
  "url": "example",
  "verified": "example",
  "verification_code": "example",
  "enabled_until": "example",
  "auto_ssl_enabled": "example",
  "certificate": {
    "subject": "example",
    "expired": "example",
    "certificate": "example",
    "certificate_text": "example"
  }
}

400

Bad Request

404

Not Found