Get Favicon

Returns the favicon of the portal.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Image asset for the portal. Can be either png, jpeg or svg

* Additional properties are NOT allowed.
dataOne Of
required
ImagePNGDataUristring(uri)

must be a data URL with base64 PNG image data, e.g., data:image/png;base64,<BASE64_IMAGE_DATA>

Match pattern:^data:image/png(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

Example:data:image/png,YW5faW1hZ2VfZmlsZQ==

get/portals/{portalId}/assets/favicon
 
application/json

Replace Favicon

Replaces the favicon of the portal. The favicon is used in the browser tab of the portal.

put

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Update an image asset for the portal.

ReplacePortalImageAsset

The image data to upload. Images must be a data URL with binary image data in base 64 format. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs.

* Additional properties are NOT allowed.
dataOne Of
required
ImagePNGDataUristring(uri)

must be a data URL with base64 PNG image data, e.g., data:image/png;base64,<BASE64_IMAGE_DATA>

Match pattern:^data:image/png(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

Example:data:image/png,YW5faW1hZ2VfZmlsZQ==

Response

application/json

Image asset for the portal. Can be either png, jpeg or svg

* Additional properties are NOT allowed.
dataOne Of
required
ImagePNGDataUristring(uri)

must be a data URL with base64 PNG image data, e.g., data:image/png;base64,<BASE64_IMAGE_DATA>

Match pattern:^data:image/png(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

Example:data:image/png,YW5faW1hZ2VfZmlsZQ==

put/portals/{portalId}/assets/favicon

Body

{ "data": "data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU=" }
 
application/json

Get Favicon (Raw)

Returns the raw favicon of the portal.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

Logo of the portal. Can be either png, jpeg or svg

PortalImageAsset

PortalImageAssetstring

Raw binary image data

get/portals/{portalId}/assets/favicon/raw
 

Pages

APIs related to Konnect Developer Portal Custom Pages.

List Pages

Returns the tree view of custom pages that have been created for this portal. The full tree is returned in one response; this endpoint is not paginated.

get

Query Parameters

sortstring

Sorts a collection of portal pages. Supported sort attributes are:

  • created_at
  • updated_at
  • slug
  • title
  • visibility
filterobject

Filter pages returned in the response.

* Additional properties are NOT allowed.
Show Child Parameters

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Tree of custom pages in a portal (nested children). Not paginated.

ListPortalPagesResponse

Tree of custom pages in a portal. Not paginated.

* Additional properties are NOT allowed.
dataarray[object]required

Information about a page in a portal.

* Additional properties are NOT allowed.
Show Child Parameters
get/portals/{portalId}/pages
 
application/json