Delete Portal
Deletes a single portal, along with all related entities.
Query Parameters
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
ID of the portal.
Response
Response
No Content
Authentication
Path Parameters
Query Parameters
Portal Custom Domains
APIs related to configuration of Konnect Developer Portals custom domains.
Get Custom Domain
Get the custom domain associated to the portal.
Path Parameters
ID of the portal.
Response
application/json
Response
Portal custom domain
PortalCustomDomain
Show Child Parameters
Allowed values:verifiedpending
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Create Custom Domain
Creates the custom domain associated with the portal. Only one custom domain can be associated with a portal at a time.
Path Parameters
ID of the portal.
Body
application/json
Body
Create a portal custom domain.
CreatePortalCustomDomainRequest
One OfShow Child Parameters
Response
application/json
Response
Portal custom domain
PortalCustomDomain
Show Child Parameters
Allowed values:verifiedpending
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Enable or Disable Domain
Updates the portal domain associated with the portal.
Path Parameters
ID of the portal.
Body
application/json
Body
Create a portal custom domain.
UpdatePortalCustomDomainRequest
Response
application/json
Response
Portal custom domain
PortalCustomDomain
Show Child Parameters
Allowed values:verifiedpending
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z