Update a portal configuration

Update the configuration of the portal

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Request schema to replace the portal configuration.

PortalConfig

* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are allowed.
Show Child Parameters

Response

application/json

Response for a portal configuration

PortalConfig

* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are allowed.
Show Child Parameters
patch/portals/{portalId}/config

Body

{ "data": {} }
 
application/json

Portal Developers

APIs related to Konnect Developer Portal Developers.

Copy Developers

Copies developers from the source portal (specified in the path) to the target portal (specified in the request body). The source portal must be a v2 portal, and the target portal must be a v3 portal. This operation copies developer accounts. Both portals must be accessible to the authenticated user.

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Copy developers in a portal. The portalId in parameters is the source portal.

PortalCopyDevelopersRequest

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.

Response

application/json

Developers successfully copied to target portal

developer_countinteger

Number of developers copied to target portal

post/portals/{portalId}/developer-copy

Body

{ "target_portal_id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7", "overwrite_developers": true }
 
application/json

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