Delete Page
Deletes a single custom page for this portal.
Path Parameters
ID of the portal.
ID of the page.
Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79
Response
Response
No Content
Authentication
Path Parameters
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.
Path Parameters
ID of the portal.
ID of the page.
Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79
Body
application/json
Body
move page
MovePage
move page request payload
parent page id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
index of the document in the parent document’s children
Example:1
Response
Response
The document has been moved
Authentication
Path Parameters
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.
Path Parameters
ID of the portal.
Response
application/json
Response
Summary of created default content
DefaultContent
Summary of created default content
Authentication
Path Parameters
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.
Query Parameters
Sorts a collection of portal snippets. Supported sort attributes are:
- created_at
- updated_at
- name
- title
- visibility
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filter snippets returned in the response.
Show Child Parameters
Path Parameters
ID of the portal.
Response
application/json
Response
A paginated list of custom snippets in a portal.
ListPortalSnippetsResponse
A paginated list of custom snippets in a portal.
Information about a snippet in a portal.
Show Child Parameters
returns the pagination information