v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-263064641.4 MB
Portal Custom Domains

Create Custom Domain

Creates the custom domain associated with the portal. Only one custom domain can be associated with a portal at a time.

post/v3/portals/{portalId}/custom-domain

Request body

hostnamestring required
enabledboolean required

Response

Portal custom domain

hostnamestring required
enabledboolean required
cname_status'verified' | 'pending' required
created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "ssl": {
    "uploaded_at": "2022-11-04T20:10:06.927Z",
    "expires_at": "2022-11-04T20:10:06.927Z"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}