Pages

Create Page

Changed on

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/v3/portals/{portalId}/pages

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/pages
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

portalIdstring uuid required
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a

The Portal identifier

Request body

slugstring required

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.

titlestring

The title of a page in a portal.

contentstring required

The renderable markdown content of a page in a portal.

visibility'public' | 'private'

Whether a page is publicly accessible to non-authenticated users. If not provided, the default_page_visibility value of the portal will be used.

status'published' | 'unpublished'

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

descriptionstring
parent_page_idstring uuid nullable

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 request

{
  "slug": "/my-page",
  "title": "My Page",
  "content": "# Welcome to My Page",
  "visibility": "public",
  "status": "published",
  "description": "A custom page about developer portals"
}

Response

Details about a page in a portal.

idstring uuid required

Contains a unique identifier used for this resource.

slugstring required

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.

titlestring required

The title of a page in a portal.

contentstring required

The renderable markdown content of a page in a portal.

visibility'public' | 'private' required

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

status'published' | 'unpublished' required

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

descriptionstring
created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

parent_page_idstring uuid nullable 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 response

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "slug": "/my-page",
  "title": "My Page",
  "content": "# Welcome to My Page",
  "visibility": "public",
  "status": "published",
  "description": "A custom page about developer portals",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 5d2b35832e3fRevision changes
    • warning

      added the new type enum value to the /////// response property for the response status

  • ecce2daf9de6Revision changes
    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property /////// became nullable for the status