Portal Custom Domains

Create Custom Domain

Changed on

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

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/custom-domain
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

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"
}

Changes

  • 5d2b35832e3fRevision changes
    • warning

      added the new type enum value to the /////// response property for the response status

    • info

      added the new optional request property /

  • ecce2daf9de6Revision changes
    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • info

      added the optional property / to the response with the status