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
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create Snippet
Creates a new custom snippet for this portal. Custom snippets can be used to display static content, documentation, or other information to developers. Title and Description properties may be provided in the frontmatter section of content. If you set values in both the POST request and in the frontmatter, the values in the frontmatter will take precedence.
Path Parameters
ID of the portal.
Body
application/json
Body
Create a snippet in a portal.
CreatePortalSnippetRequest
Create a snippet in a portal.
The unique name of a snippet in a portal.
<= 512 characters
Example:my-snippet
The display title of a snippet in a portal.
<= 512 characters
Example:My Snippet
The renderable markdown content of a page in a portal.
<= 1000000 characters
Example:# Welcome to My Snippet
Whether a snippet is publicly accessible to non-authenticated users.
If not provided, the default_page_visibility value of the portal will be used.
Allowed values:publicprivate
Example:public
Whether the resource is visible on a given portal. Defaults to unpublished.
Allowed values:publishedunpublished
Example:published
<= 160 characters
Example:A custom page about developer portals
Response
application/json
Response
Details about a snippet in a portal.
PortalSnippetResponse
Details about a snippet in a portal.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The unique name of a snippet in a portal.
<= 512 characters
Example:my-snippet
The display title of a snippet in a portal.
<= 512 characters
Example:My Snippet
The renderable markdown content of a page in a portal.
<= 1000000 characters
Example:# Welcome to My Snippet
Whether the resource is publicly accessible to non-authenticated users.
Allowed values:publicprivate
Example:public
Whether the resource is visible on a given portal. Defaults to unpublished.
Allowed values:publishedunpublished
Example:published
<= 160 characters
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
Authentication
Path Parameters
Body
Get a Snippet
Returns the configuration of a single custom snippet for this portal. Custom snippets can be used to display static content, documentation, or other information to developers.
Path Parameters
ID of the portal.
ID of the snippet.
Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79
Response
application/json
Response
Details about a snippet in a portal.
PortalSnippetResponse
Details about a snippet in a portal.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The unique name of a snippet in a portal.
<= 512 characters
Example:my-snippet
The display title of a snippet in a portal.
<= 512 characters
Example:My Snippet
The renderable markdown content of a page in a portal.
<= 1000000 characters
Example:# Welcome to My Snippet
Whether the resource is publicly accessible to non-authenticated users.
Allowed values:publicprivate
Example:public
Whether the resource is visible on a given portal. Defaults to unpublished.
Allowed values:publishedunpublished
Example:published
<= 160 characters
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