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

Delete Page

Deletes a single custom page for this portal.

delete

Path Parameters

portalIdstring(uuid)required

ID of the portal.

pageIdstring(uuid)required

ID of the page.

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

Response

No Content

delete/portals/{portalId}/pages/{pageId}
 

Move Page

This api allows the user to move a page within the page tree using the parameters parent_page_id and index. If parent_page_id is not provided, the page will be placed at the top level of the page tree. index represents a zero-indexed page order relative to its siblings under the same parent. For example, if we want to put the page at top level in first position we would send parent_page_id: null and index: 0. This api also supports using a negative index to count backwards from the end of the page list, which means you can put the page in last position by using index: -1.

post

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

move page

MovePage

move page request payload

parent_page_idstring(uuid)

parent page id

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

indexinteger

index of the document in the parent document’s children

Example:1

Response

The document has been moved

post/portals/{portalId}/pages/{pageId}/move

Body

{}
 

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.

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Summary of created default content

DefaultContent

Summary of created default content

* Additional properties are NOT allowed.
pagesarray[string]required
snippetsarray[string]required
post/portals/{portalId}/default-content
 
application/json