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

Create Page

Creates a new custom page for this portal. Custom pages 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 frontmatter will take precedence.

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Create a page in a portal.

CreatePortalPageRequest

Create a page in a portal.

* Additional properties are NOT allowed.
slugstringrequired

The slug of a page in a portal, used to compute its full URL path within the portal hierarchy.
When a page has a parent_page_id, its full path is built by joining the parent’s slug with its own.
For example, if a parent page has the slug slug1 and this page’s slug is slug2, the resulting path will be /slug1/slug2.
This enables nested page structures like /slug1/slug2/slug3.

<= 512 characters

Example:/my-page

titlestring

The title of a page in a portal.

<= 512 characters

Example:My Page

contentstringrequired

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Page

visibilitystring

Whether a page 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

statusstring

Whether the resource is visible on a given portal. Defaults to unpublished.

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

parent_page_idstring | null(uuid)

Pages may be rendered as a tree of files.

Specify the id of another page as the parent_page_id to add some hierarchy to your pages.

Example:null

Response

application/json

Details about a page in a portal.

PortalPageResponse

Details about a page in a portal.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

slugstringrequired

The slug of a page in a portal, used to compute its full URL path within the portal hierarchy.
When a page has a parent_page_id, its full path is built by joining the parent’s slug with its own.
For example, if a parent page has the slug slug1 and this page’s slug is slug2, the resulting path will be /slug1/slug2.
This enables nested page structures like /slug1/slug2/slug3.

<= 512 characters

Example:/my-page

titlestringrequired

The title of a page in a portal.

<= 512 characters

Example:My Page

contentstringrequired

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Page

visibilitystringrequired

Whether the resource is publicly accessible to non-authenticated users.

Allowed values:publicprivate

Example:public

statusstringrequired

Whether the resource is visible on a given portal. Defaults to unpublished.

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

parent_page_idstring | null(uuid)required

Pages may be rendered as a tree of files.

Specify the id of another page as the parent_page_id to add some hierarchy to your pages.

Example:null

post/portals/{portalId}/pages

Body

{ "title": "Getting Started", "slug": "/getting-started", "content": "Welcome to the Getting Started page. This is where you can learn how to use our APIs.", "visibility": "public", "status": "published" }
 
application/json

Get a Page

Returns the configuration of a single custom page for this portal. Custom pages can be used to display static content, documentation, or other information to developers.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

pageIdstring(uuid)required

ID of the page.

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

Response

application/json

Details about a page in a portal.

PortalPageResponse

Details about a page in a portal.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

slugstringrequired

The slug of a page in a portal, used to compute its full URL path within the portal hierarchy.
When a page has a parent_page_id, its full path is built by joining the parent’s slug with its own.
For example, if a parent page has the slug slug1 and this page’s slug is slug2, the resulting path will be /slug1/slug2.
This enables nested page structures like /slug1/slug2/slug3.

<= 512 characters

Example:/my-page

titlestringrequired

The title of a page in a portal.

<= 512 characters

Example:My Page

contentstringrequired

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Page

visibilitystringrequired

Whether the resource is publicly accessible to non-authenticated users.

Allowed values:publicprivate

Example:public

statusstringrequired

Whether the resource is visible on a given portal. Defaults to unpublished.

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

parent_page_idstring | null(uuid)required

Pages may be rendered as a tree of files.

Specify the id of another page as the parent_page_id to add some hierarchy to your pages.

Example:null

get/portals/{portalId}/pages/{pageId}
 
application/json

Update Page

Updates the configuration of a single custom page for this portal.

patch

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

Update a page in a portal.

UpdatePortalPageRequest

Update a page in a portal.

* Additional properties are NOT allowed.
slugstring

The slug of a page in a portal, used to compute its full URL path within the portal hierarchy.
When a page has a parent_page_id, its full path is built by joining the parent’s slug with its own.
For example, if a parent page has the slug slug1 and this page’s slug is slug2, the resulting path will be /slug1/slug2.
This enables nested page structures like /slug1/slug2/slug3.

<= 512 characters

Example:/my-page

titlestring

The title of a page in a portal.

<= 512 characters

Example:My Page

contentstring

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Page

visibilitystring

Whether the resource is publicly accessible to non-authenticated users.

Allowed values:publicprivate

Example:public

statusstring

Whether the resource is visible on a given portal. Defaults to unpublished.

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

parent_page_idstring | null(uuid)

Pages may be rendered as a tree of files.

Specify the id of another page as the parent_page_id to add some hierarchy to your pages.

Example:null

Response

application/json

Details about a page in a portal.

PortalPageResponse

Details about a page in a portal.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

slugstringrequired

The slug of a page in a portal, used to compute its full URL path within the portal hierarchy.
When a page has a parent_page_id, its full path is built by joining the parent’s slug with its own.
For example, if a parent page has the slug slug1 and this page’s slug is slug2, the resulting path will be /slug1/slug2.
This enables nested page structures like /slug1/slug2/slug3.

<= 512 characters

Example:/my-page

titlestringrequired

The title of a page in a portal.

<= 512 characters

Example:My Page

contentstringrequired

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Page

visibilitystringrequired

Whether the resource is publicly accessible to non-authenticated users.

Allowed values:publicprivate

Example:public

statusstringrequired

Whether the resource is visible on a given portal. Defaults to unpublished.

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

parent_page_idstring | null(uuid)required

Pages may be rendered as a tree of files.

Specify the id of another page as the parent_page_id to add some hierarchy to your pages.

Example:null

patch/portals/{portalId}/pages/{pageId}

Body

{ "title": "About Us", "slug": "/about-us", "content": "Welcome to the About Us page. This is where you can learn about our company." }
 
application/json