Portal Custom Domains

Get Custom Domain

Changed on

Get the custom domain associated to the portal.

get/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

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

  • ecce2daf9de6Revision changes
    • info

      added the optional property / to the response with the status

  • 0f6e0fa4241cRevision changes
    • warning

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

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status