Skip to content

Pages domains API

Endpoints for connecting custom domain(s) and TLS certificates inGitLab Pages.

The GitLab Pages feature must be enabled to use these endpoints. Find out more aboutadministeringandusingthe feature.

List all pages domains

Get a list of all pages domains. The user must have admin permissions.

GET /pages/domains
旋度--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"https://gitlab.example.com/api/v4/pages/domains
[{"domain":"ssl.domain.example","url":"https://ssl.domain.example","project_id":1337,"certificate":{"expired":false,"expiration":"2020-04-12T14:32:00.000Z"}}]

List pages domains

Get a list of project pages domains. The user must have permissions to view pages domains.

GET /projects/:id/pages/domains
Attribute Type Required Description
id integer/string yes The ID orURL-encoded path of the projectowned by the authenticated user 
旋度--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"https://gitlab.example.com/api/v4/projects/5/pages/domains
[{"domain":"www.domain.example","url":"http://www.domain.example"},{"domain":"ssl.domain.example","url":"https://ssl.domain.example","certificate":{"subject":"/O=Example, Inc./OU=Example Origin CA/CN=Example Origin Certificate","expired":false,"certificate":"-----BEGIN CERTIFICATE-----\n…\n——结束CERTIFICATE-----","certificate_text":"Certificate:\n…\n"}}]

Single pages domain

Get a single project pages domain. The user must have permissions to view pages domains.

GET /projects/:id/pages/domains/:domain
Attribute Type Required Description
id integer/string yes The ID orURL-encoded path of the projectowned by the authenticated user
domain string yes 域 
旋度--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"https://gitlab.example.com/api/v4/projects/5/pages/domains/www.domain.example
{"domain":"www.domain.example","url":"http://www.domain.example"}
旋度--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example
{"domain":"ssl.domain.example","url":"https://ssl.domain.example","certificate":{"subject":"/O=Example, Inc./OU=Example Origin CA/CN=Example Origin Certificate","expired":false,"certificate":"-----BEGIN CERTIFICATE-----\n…\n——结束CERTIFICATE-----","certificate_text":"Certificate:\n…\n"}}

Create new pages domain

Creates a new pages domain. The user must have permissions to create new pages domains.

POST /projects/:id/pages/domains
Attribute Type Required Description
id integer/string yes The ID orURL-encoded path of the projectowned by the authenticated user
domain string yes 域
certificate 文件/字符串 no The certificate in PEM format with intermediates following in most specific to least specific order.
key 文件/字符串 no The certificate key in PEM format. 
旋度——请求POST--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"--form="domain=ssl.domain.example"--form="certificate=@/path/to/cert.pem"--form="key=@/path/to/key.pem"https://gitlab.example.com/api/v4/projects/5/pages/domains
旋度——请求POST--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"--form="domain=ssl.domain.example"--form="certificate=$CERT_PEM"--form="key=$KEY_PEM"https://gitlab.example.com/api/v4/projects/5/pages/domains
{"domain":"ssl.domain.example","url":"https://ssl.domain.example","certificate":{"subject":"/O=Example, Inc./OU=Example Origin CA/CN=Example Origin Certificate","expired":false,"certificate":"-----BEGIN CERTIFICATE-----\n…\n——结束CERTIFICATE-----","certificate_text":"Certificate:\n…\n"}}

Update pages domain

Updates an existing project pages domain. The user must have permissions to change an existing pages domains.

PUT /projects/:id/pages/domains/:domain
Attribute Type Required Description
id integer/string yes The ID orURL-encoded path of the projectowned by the authenticated user
domain string yes 域
certificate 文件/字符串 no The certificate in PEM format with intermediates following in most specific to least specific order.
key 文件/字符串 no The certificate key in PEM format. 
旋度——请求PUT--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"--form="certificate=@/path/to/cert.pem"--form="key=@/path/to/key.pem"https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example
旋度——请求PUT--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"--form="certificate=$CERT_PEM"--form="key=$KEY_PEM"https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example
{"domain":"ssl.domain.example","url":"https://ssl.domain.example","certificate":{"subject":"/O=Example, Inc./OU=Example Origin CA/CN=Example Origin Certificate","expired":false,"certificate":"-----BEGIN CERTIFICATE-----\n…\n——结束CERTIFICATE-----","certificate_text":"Certificate:\n…\n"}}

Delete pages domain

Deletes an existing project pages domain.

DELETE /projects/:id/pages/domains/:domain
Attribute Type Required Description
id integer/string yes The ID orURL-encoded path of the projectowned by the authenticated user
domain string yes 域 
旋度——请求DELETE--header"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"https://gitlab.example.com/api/v4/projects/5/pages/domains/ssl.domain.example
Baidu
map