Delete Portal

Deletes a single portal, along with all related entities.

delete

Query Parameters

forcestring

If true, the portal will be deleted, automatically deleting all API publications. If the force param is not set, the deletion will only succeed if there are no APIs currently published.

Allowed values:truefalse

Default:false

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

No Content

delete/portals/{portalId}
 

Portal Custom Domains

APIs related to configuration of Konnect Developer Portals custom domains.

Get Custom Domain

Get the custom domain associated to the portal.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Portal custom domain

PortalCustomDomain

* Additional properties are NOT allowed.
hostnamestringrequired
enabledbooleanrequired
sslobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
cname_statusstringrequiredread-only

Allowed values:verifiedpending

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/portals/{portalId}/custom-domain
 
application/json

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

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Create a portal custom domain.

CreatePortalCustomDomainRequest

* Additional properties are NOT allowed.
hostnamestringrequired
enabledbooleanrequired
sslOne Of
objectrequired
custom_certificaterequired
* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Portal custom domain

PortalCustomDomain

* Additional properties are NOT allowed.
hostnamestringrequired
enabledbooleanrequired
sslobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
cname_statusstringrequiredread-only

Allowed values:verifiedpending

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

post/portals/{portalId}/custom-domain

Body

{ "hostname": "hostname", "enabled": false, "ssl": {} }
 
application/json

Enable or Disable Domain

Updates the portal domain associated with the portal.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Create a portal custom domain.

UpdatePortalCustomDomainRequest

* Additional properties are NOT allowed.
enabledboolean

Response

application/json

Portal custom domain

PortalCustomDomain

* Additional properties are NOT allowed.
hostnamestringrequired
enabledbooleanrequired
sslobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
cname_statusstringrequiredread-only

Allowed values:verifiedpending

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

patch/portals/{portalId}/custom-domain

Body

{}
 
application/json