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.
Path Parameters
ID of the portal.
Body
application/json
Body
Create a page in a portal.
CreatePortalPageRequest
Create a page in a portal.
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
The title of a page in a portal.
<= 512 characters
Example:My Page
The renderable markdown content of a page in a portal.
<= 1000000 characters
Example:# Welcome to My Page
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
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
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
Response
Details about a page in a portal.
PortalPageResponse
Details about a page in a portal.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
The title of a page in a portal.
<= 512 characters
Example:My Page
The renderable markdown content of a page in a portal.
<= 1000000 characters
Example:# Welcome to My Page
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
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
Authentication
Path Parameters
Body
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.
Path Parameters
ID of the portal.
ID of the page.
Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79
Response
application/json
Response
Details about a page in a portal.
PortalPageResponse
Details about a page in a portal.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
The title of a page in a portal.
<= 512 characters
Example:My Page
The renderable markdown content of a page in a portal.
<= 1000000 characters
Example:# Welcome to My Page
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
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
Authentication
Path Parameters
Update Page
Updates the configuration of a single custom page for this portal.
Path Parameters
ID of the portal.
ID of the page.
Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79
Body
application/json
Body
Update a page in a portal.
UpdatePortalPageRequest
Update a page in a portal.
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
The title of a page in a portal.
<= 512 characters
Example:My Page
The renderable markdown content of a page in a portal.
<= 1000000 characters
Example:# Welcome to My Page
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
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
Response
Details about a page in a portal.
PortalPageResponse
Details about a page in a portal.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
The title of a page in a portal.
<= 512 characters
Example:My Page
The renderable markdown content of a page in a portal.
<= 1000000 characters
Example:# Welcome to My Page
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
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
Authentication
Path Parameters
Body
Delete Page
Deletes a single custom page for this portal.
Path Parameters
ID of the portal.
ID of the page.
Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79
Response
Response
No Content
Authentication
Path Parameters
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.
Path Parameters
ID of the portal.
ID of the page.
Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79
Body
application/json
Body
move page
MovePage
move page request payload
parent page id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
index of the document in the parent document’s children
Example:1
Response
Response
The document has been moved