Get Portal Integration Configurations
Returns the portal’s integration configurations.
Response
200 application/json
Response
Response for portal integration configurations
Portal Integrations
Configuration data for Dev Portal integrations
Default:{}
Google Tag Manager integration configuration
Show Child Parameters
Google Analytics integration configuration
Show Child Parameters
Content
The API for retrieving content for a Konnect Portal.
List Pages
Returns a tree view of pages for the portal. Each page has a slug, title, and content. The full tree is returned in one response; this endpoint is not paginated. Public pages will be returned for non-authenticated users, while both private and public pages will be returned for authenticated users.
Query Parameters
Sorts a collection of portal pages. Supported sort attributes are:
- created_at
- updated_at
- slug
- title
- visibility
Filter by direct equality comparison of the title property with a supplied value.
Example:Good Page
Filter by direct equality comparison (short-hand) of the title property with a supplied value.
Example:Good Page
Filter by contains comparison of the title property with a supplied substring
Example:Good
Filter by direct equality comparison of the slug property with a supplied value.
Example:good-page
Filter by direct equality comparison (short-hand) of the slug property with a supplied value.
Example:good-page
Filter by contains comparison of the slug property with a supplied substring
Example:good
Filter by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.
Allowed values:publicprivate
Example:public
Filter (short-hand) by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.
Allowed values:publicprivate
Example:private
Response
200 application/json
Response
Tree of portal pages for the portal
ListPortalPages
Tree of pages for the portal (nested children). Not paginated.
A single page for the portal
Show Child Parameters
Get a Page
Returns a single page for the portal. Each page has a slug, title, and content. Public pages will be returned for non-authenticated users, while both private and public pages will be returned for authenticated users.
Path Parameters
Targeted page, url-encoded.
Example:%2Fmypage
Response
application/json
Response
A single portal page
PortalPage
A single page for the portal
The unique identifier of the page
Example:582b9327-3eba-4bfe-9438-6066840dbbca
The title of the page
Example:My Page
The slug of the page.
Example:/my-page
The renderable markdown content of the page
Example:# Welcome to the Developer Portal
Whether the page or snippet is public or private. Private pages and snippets are only accessible to authenticated users.
Allowed values:publicprivate
Example:public
Example:A custom page about developer portals
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Pages may be rendered as a tree of files.
List Snippets
Returns a paginated list of snippets for the portal. Each snippet has a name, title, and content. Public snippets will be returned for non-authenticated users, while both private and public snippets will be returned for authenticated users.
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 by direct equality comparison of the title property with a supplied value.
Example:Good Page
Filter by direct equality comparison (short-hand) of the title property with a supplied value.
Example:Good Page
Filter by contains comparison of the title property with a supplied substring
Example:Good
Filter by direct equality comparison of the name property with a supplied value.
Example:good service
Filter by direct equality comparison (short-hand) of the name property with a supplied value.
Example:good service
Filter by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.
Allowed values:publicprivate
Example:public
Filter (short-hand) by whether the pages returned are public or private. Private pages are only accessible to authenticated users. For authenticated users, results will include both public and private pages if not specified.
Allowed values:publicprivate
Example:private
Response
200 application/json
Response
Paginated list of portal snippets
ListPortalSnippets
A paginated list of snippets for the portal
A single snippet for the portal
Show Child Parameters
returns the pagination information