1. Packages
  2. Konnect Provider
  3. API Docs
  4. PortalPage
konnect 3.4.1 published on Wednesday, Oct 29, 2025 by kong
kong/terraform-provider-konnect

konnect.PortalPage

Get Started
konnect logo
konnect 3.4.1 published on Wednesday, Oct 29, 2025 by kong
kong/terraform-provider-konnect

    PortalPage Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as konnect from "@pulumi/konnect";

const myPortalpage = new konnect.PortalPage("myPortalpage", {
    content: "# Welcome to My Page",
    description: "A custom page about developer portals",
    parentPageId: "824a28d9-7024-426a-aed4-03b504521824",
    portalId: "f32d905a-ed33-46a3-a093-d8f536af9a8a",
    slug: "/my-page",
    status: "published",
    title: "My Page",
    visibility: "public",
});

    import pulumi
import pulumi_konnect as konnect

my_portalpage = konnect.PortalPage("myPortalpage",
    content="# Welcome to My Page",
    description="A custom page about developer portals",
    parent_page_id="824a28d9-7024-426a-aed4-03b504521824",
    portal_id="f32d905a-ed33-46a3-a093-d8f536af9a8a",
    slug="/my-page",
    status="published",
    title="My Page",
    visibility="public")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v3/konnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := konnect.NewPortalPage(ctx, "myPortalpage", &konnect.PortalPageArgs{
			Content:      pulumi.String("# Welcome to My Page"),
			Description:  pulumi.String("A custom page about developer portals"),
			ParentPageId: pulumi.String("824a28d9-7024-426a-aed4-03b504521824"),
			PortalId:     pulumi.String("f32d905a-ed33-46a3-a093-d8f536af9a8a"),
			Slug:         pulumi.String("/my-page"),
			Status:       pulumi.String("published"),
			Title:        pulumi.String("My Page"),
			Visibility:   pulumi.String("public"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;

return await Deployment.RunAsync(() => 
{
    var myPortalpage = new Konnect.PortalPage("myPortalpage", new()
    {
        Content = "# Welcome to My Page",
        Description = "A custom page about developer portals",
        ParentPageId = "824a28d9-7024-426a-aed4-03b504521824",
        PortalId = "f32d905a-ed33-46a3-a093-d8f536af9a8a",
        Slug = "/my-page",
        Status = "published",
        Title = "My Page",
        Visibility = "public",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.PortalPage;
import com.pulumi.konnect.PortalPageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var myPortalpage = new PortalPage("myPortalpage", PortalPageArgs.builder()
            .content("# Welcome to My Page")
            .description("A custom page about developer portals")
            .parentPageId("824a28d9-7024-426a-aed4-03b504521824")
            .portalId("f32d905a-ed33-46a3-a093-d8f536af9a8a")
            .slug("/my-page")
            .status("published")
            .title("My Page")
            .visibility("public")
            .build());

    }
}

    resources:
  myPortalpage:
    type: konnect:PortalPage
    properties:
      content: '# Welcome to My Page'
      description: A custom page about developer portals
      parentPageId: 824a28d9-7024-426a-aed4-03b504521824
      portalId: f32d905a-ed33-46a3-a093-d8f536af9a8a
      slug: /my-page
      status: published
      title: My Page
      visibility: public

    Create PortalPage Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PortalPage(name: string, args: PortalPageArgs, opts?: CustomResourceOptions);
    @overload
def PortalPage(resource_name: str,
               args: PortalPageArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def PortalPage(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               content: Optional[str] = None,
               portal_id: Optional[str] = None,
               slug: Optional[str] = None,
               description: Optional[str] = None,
               parent_page_id: Optional[str] = None,
               status: Optional[str] = None,
               title: Optional[str] = None,
               visibility: Optional[str] = None)
    func NewPortalPage(ctx *Context, name string, args PortalPageArgs, opts ...ResourceOption) (*PortalPage, error)
    public PortalPage(string name, PortalPageArgs args, CustomResourceOptions? opts = null)
    public PortalPage(String name, PortalPageArgs args)
public PortalPage(String name, PortalPageArgs args, CustomResourceOptions options)

    type: konnect:PortalPage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PortalPageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PortalPageArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PortalPageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PortalPageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PortalPageArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var portalPageResource = new Konnect.PortalPage("portalPageResource", new()
{
    Content = "string",
    PortalId = "string",
    Slug = "string",
    Description = "string",
    ParentPageId = "string",
    Status = "string",
    Title = "string",
    Visibility = "string",
});

    example, err := konnect.NewPortalPage(ctx, "portalPageResource", &konnect.PortalPageArgs{
	Content:      pulumi.String("string"),
	PortalId:     pulumi.String("string"),
	Slug:         pulumi.String("string"),
	Description:  pulumi.String("string"),
	ParentPageId: pulumi.String("string"),
	Status:       pulumi.String("string"),
	Title:        pulumi.String("string"),
	Visibility:   pulumi.String("string"),
})

    var portalPageResource = new PortalPage("portalPageResource", PortalPageArgs.builder()
    .content("string")
    .portalId("string")
    .slug("string")
    .description("string")
    .parentPageId("string")
    .status("string")
    .title("string")
    .visibility("string")
    .build());

    portal_page_resource = konnect.PortalPage("portalPageResource",
    content="string",
    portal_id="string",
    slug="string",
    description="string",
    parent_page_id="string",
    status="string",
    title="string",
    visibility="string")

    const portalPageResource = new konnect.PortalPage("portalPageResource", {
    content: "string",
    portalId: "string",
    slug: "string",
    description: "string",
    parentPageId: "string",
    status: "string",
    title: "string",
    visibility: "string",
});

    type: konnect:PortalPage
properties:
    content: string
    description: string
    parentPageId: string
    portalId: string
    slug: string
    status: string
    title: string
    visibility: string

    PortalPage Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PortalPage resource accepts the following input properties:

    Content string
    The renderable markdown content of a page in a portal.
    PortalId string
    The Portal identifier
    Slug string
    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.
    Description string
    ParentPageId string
    Pages may be rendered as a tree of files.
    Status string
    Whether the resource is visible on a given portal. Defaults to unpublished. must be one of ["published", "unpublished"]
    Title string
    The title of a page in a portal.
    Visibility string
    Whether a page is publicly accessible to non-authenticated users. If not provided, the default_page_visibility value of the portal will be used. must be one of ["public", "private"]
    Content string
    The renderable markdown content of a page in a portal.
    PortalId string
    The Portal identifier
    Slug string
    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.
    Description string
    ParentPageId string
    Pages may be rendered as a tree of files.
    Status string
    Whether the resource is visible on a given portal. Defaults to unpublished. must be one of ["published", "unpublished"]
    Title string
    The title of a page in a portal.
    Visibility string
    Whether a page is publicly accessible to non-authenticated users. If not provided, the default_page_visibility value of the portal will be used. must be one of ["public", "private"]
    content String
    The renderable markdown content of a page in a portal.
    portalId String
    The Portal identifier
    slug String
    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.
    description String
    parentPageId String
    Pages may be rendered as a tree of files.
    status String
    Whether the resource is visible on a given portal. Defaults to unpublished. must be one of ["published", "unpublished"]
    title String
    The title of a page in a portal.
    visibility String
    Whether a page is publicly accessible to non-authenticated users. If not provided, the default_page_visibility value of the portal will be used. must be one of ["public", "private"]
    content string
    The renderable markdown content of a page in a portal.
    portalId string
    The Portal identifier
    slug string
    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.
    description string
    parentPageId string
    Pages may be rendered as a tree of files.
    status string
    Whether the resource is visible on a given portal. Defaults to unpublished. must be one of ["published", "unpublished"]
    title string
    The title of a page in a portal.
    visibility string
    Whether a page is publicly accessible to non-authenticated users. If not provided, the default_page_visibility value of the portal will be used. must be one of ["public", "private"]
    content str
    The renderable markdown content of a page in a portal.
    portal_id str
    The Portal identifier
    slug str
    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.
    description str
    parent_page_id str
    Pages may be rendered as a tree of files.
    status str
    Whether the resource is visible on a given portal. Defaults to unpublished. must be one of ["published", "unpublished"]
    title str
    The title of a page in a portal.
    visibility str
    Whether a page is publicly accessible to non-authenticated users. If not provided, the default_page_visibility value of the portal will be used. must be one of ["public", "private"]
    content String
    The renderable markdown content of a page in a portal.
    portalId String
    The Portal identifier
    slug String
    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.
    description String
    parentPageId String
    Pages may be rendered as a tree of files.
    status String
    Whether the resource is visible on a given portal. Defaults to unpublished. must be one of ["published", "unpublished"]
    title String
    The title of a page in a portal.
    visibility String
    Whether a page is publicly accessible to non-authenticated users. If not provided, the default_page_visibility value of the portal will be used. must be one of ["public", "private"]

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PortalPage resource produces the following output properties:

    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Look up Existing PortalPage Resource

    Get an existing PortalPage resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PortalPageState, opts?: CustomResourceOptions): PortalPage
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        content: Optional[str] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        parent_page_id: Optional[str] = None,
        portal_id: Optional[str] = None,
        slug: Optional[str] = None,
        status: Optional[str] = None,
        title: Optional[str] = None,
        updated_at: Optional[str] = None,
        visibility: Optional[str] = None) -> PortalPage
    func GetPortalPage(ctx *Context, name string, id IDInput, state *PortalPageState, opts ...ResourceOption) (*PortalPage, error)
    public static PortalPage Get(string name, Input<string> id, PortalPageState? state, CustomResourceOptions? opts = null)
    public static PortalPage get(String name, Output<String> id, PortalPageState state, CustomResourceOptions options)
    resources:  _:    type: konnect:PortalPage    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Content string
    The renderable markdown content of a page in a portal.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Description string
    ParentPageId string
    Pages may be rendered as a tree of files.
    PortalId string
    The Portal identifier
    Slug string
    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.
    Status string
    Whether the resource is visible on a given portal. Defaults to unpublished. must be one of ["published", "unpublished"]
    Title string
    The title of a page in a portal.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    Visibility string
    Whether a page is publicly accessible to non-authenticated users. If not provided, the default_page_visibility value of the portal will be used. must be one of ["public", "private"]
    Content string
    The renderable markdown content of a page in a portal.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Description string
    ParentPageId string
    Pages may be rendered as a tree of files.
    PortalId string
    The Portal identifier
    Slug string
    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.
    Status string
    Whether the resource is visible on a given portal. Defaults to unpublished. must be one of ["published", "unpublished"]
    Title string
    The title of a page in a portal.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    Visibility string
    Whether a page is publicly accessible to non-authenticated users. If not provided, the default_page_visibility value of the portal will be used. must be one of ["public", "private"]
    content String
    The renderable markdown content of a page in a portal.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    description String
    parentPageId String
    Pages may be rendered as a tree of files.
    portalId String
    The Portal identifier
    slug String
    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.
    status String
    Whether the resource is visible on a given portal. Defaults to unpublished. must be one of ["published", "unpublished"]
    title String
    The title of a page in a portal.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    visibility String
    Whether a page is publicly accessible to non-authenticated users. If not provided, the default_page_visibility value of the portal will be used. must be one of ["public", "private"]
    content string
    The renderable markdown content of a page in a portal.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    description string
    parentPageId string
    Pages may be rendered as a tree of files.
    portalId string
    The Portal identifier
    slug string
    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.
    status string
    Whether the resource is visible on a given portal. Defaults to unpublished. must be one of ["published", "unpublished"]
    title string
    The title of a page in a portal.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    visibility string
    Whether a page is publicly accessible to non-authenticated users. If not provided, the default_page_visibility value of the portal will be used. must be one of ["public", "private"]
    content str
    The renderable markdown content of a page in a portal.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    description str
    parent_page_id str
    Pages may be rendered as a tree of files.
    portal_id str
    The Portal identifier
    slug str
    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.
    status str
    Whether the resource is visible on a given portal. Defaults to unpublished. must be one of ["published", "unpublished"]
    title str
    The title of a page in a portal.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    visibility str
    Whether a page is publicly accessible to non-authenticated users. If not provided, the default_page_visibility value of the portal will be used. must be one of ["public", "private"]
    content String
    The renderable markdown content of a page in a portal.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    description String
    parentPageId String
    Pages may be rendered as a tree of files.
    portalId String
    The Portal identifier
    slug String
    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.
    status String
    Whether the resource is visible on a given portal. Defaults to unpublished. must be one of ["published", "unpublished"]
    title String
    The title of a page in a portal.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    visibility String
    Whether a page is publicly accessible to non-authenticated users. If not provided, the default_page_visibility value of the portal will be used. must be one of ["public", "private"]

    Import

    In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

    terraform

    import {

    to = konnect_portal_page.my_konnect_portal_page

    id = jsonencode({

    id = "ebbac5b0-ac89-45c3-9d2e-c4542c657e79"

portal_id = "f32d905a-ed33-46a3-a093-d8f536af9a8a"

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import konnect:index/portalPage:PortalPage my_konnect_portal_page '{"id": "ebbac5b0-ac89-45c3-9d2e-c4542c657e79", "portal_id": "f32d905a-ed33-46a3-a093-d8f536af9a8a"}'

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    konnect kong/terraform-provider-konnect
    License
    Notes
    This Pulumi package is based on the konnect Terraform Provider.
    konnect logo
    konnect 3.4.1 published on Wednesday, Oct 29, 2025 by kong
    kong/terraform-provider-konnect
      Meet Neo: Your AI Platform Teammate