Portal Customization

APIs related to Konnect Developer Portal Customization.

Get Customization

Returns the portal customization options.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Response for a portal customization

PortalCustomization

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring | null
jsobject
* Additional properties are NOT allowed.
Show Child Parameters
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring | null
get/portals/{portalId}/customization
 
application/json

Replace Customization

Replace the portal customization options.

put

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

PortalCustomization

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring | null
jsobject
* Additional properties are NOT allowed.
Show Child Parameters
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring | null

Response

application/json

Response for a portal customization

PortalCustomization

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring | null
jsobject
* Additional properties are NOT allowed.
Show Child Parameters
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring | null
put/portals/{portalId}/customization

Body

{}
 
application/json

Update Portal Customization

Update the portal customization options, merging properties.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

PortalCustomization

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring | null
jsobject
* Additional properties are NOT allowed.
Show Child Parameters
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring | null

Response

application/json

Response for a portal customization

PortalCustomization

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring | null
jsobject
* Additional properties are NOT allowed.
Show Child Parameters
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring | null
patch/portals/{portalId}/customization

Body

{}
 
application/json

PortalCopyDevelopersRequest

object

Request body for copying developers from one portal to another.

* Additional properties are NOT allowed.
target_portal_idstring(uuid)required

The ID of the destination portal to copy developers to.

overwrite_developersbooleanrequired

If true, existing developers in the destination portal with the same email will be updated to match the source portal developer data. If false, existing developers with the same email will not be modified.

Example