Delete Page

Deletes a single custom page for this portal.

delete

Path Parameters

portalIdstring(uuid)required

ID of the portal.

pageIdstring(uuid)required

ID of the page.

Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79

Response

No Content

delete/portals/{portalId}/pages/{pageId}
 

Move Page

This api allows the user to move a page within the page tree using the parameters parent_page_id and index. If parent_page_id is not provided, the page will be placed at the top level of the page tree. index represents a zero-indexed page order relative to its siblings under the same parent. For example, if we want to put the page at top level in first position we would send parent_page_id: null and index: 0. This api also supports using a negative index to count backwards from the end of the page list, which means you can put the page in last position by using index: -1.

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

pageIdstring(uuid)required

ID of the page.

Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79

Body

application/json

move page

MovePage

move page request payload

parent_page_idstring(uuid)

parent page id

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

indexinteger

index of the document in the parent document’s children

Example:1

Response

The document has been moved

post/portals/{portalId}/pages/{pageId}/move

Body

{}
 

Create Boilerplate Content

Creates a default collection of pages, snippets, and customization config for a portal if they do not already exist. This endpoint is optional, you can call it to populate a newly created developer portal with default content, but it is not required. Existing pages and snippets will not be modified or deleted. If used, it is typically called once per portal shortly after creation.

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Summary of created default content

DefaultContent

Summary of created default content

* Additional properties are NOT allowed.
pagesarray[string]required
snippetsarray[string]required
post/portals/{portalId}/default-content
 
application/json

Snippets

APIs related to Konnect Developer Portal Custom Snippets.

List Snippets

Returns the paginated list of custom snippets that have been created for this portal.

get

Query Parameters

sortstring

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

  • created_at
  • updated_at
  • name
  • title
  • visibility
page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filter snippets returned in the response.

* Additional properties are NOT allowed.
Show Child Parameters

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

A paginated list of custom snippets in a portal.

ListPortalSnippetsResponse

A paginated list of custom snippets in a portal.

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

Information about a snippet in a portal.

* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/portals/{portalId}/snippets
 
application/json