Sign in

v2

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-07-21130282381.6 KB
API Documentation

Publish API Documentation Page

Publish API Documentation Page

Publish API Documentation Page. Returns the published page.

Low-value for routine assistant workflows; prefer higher-level API inspection tools first.

post/environments/{envId}/apis/{apiId}/pages/{pageId}/_publish

Response

API Documentation Page

idstring

Page's uuid.

crossIdstring

Page's cross uuid.

namestring

Page's name.

type'ASCIIDOC' | 'ASYNCAPI' | 'MARKDOWN' | 'MARKDOWN_TEMPLATE' | 'SWAGGER' | 'FOLDER' | 'LINK' | 'ROOT' | 'SYSTEM_FOLDER' | 'TRANSLATION'

The type of the page.

contentstring

Page's content.

orderinteger

Page's order.

lastContributorstring

Page's last contributor. Id of a user.

publishedboolean

Page's published status.

visibility'PUBLIC' | 'PRIVATE'

The visibility of the resource regarding the portal.

updatedAtstring date-time

Page's last update date.

contentTypestring

Page's content type.

configurationobject

Page's configuration.

homepageboolean

Page's homepage status.

parentIdstring

Page's parent id.

parentPathstring

Page's parent path.

excludedAccessControlsboolean

Flag to restrict access to user matching the restrictions.

metadataobject

Page's metadata.

hiddenboolean

If folder is published but not shown in Portal.

generalConditionsboolean

If page is used as General Conditions of an active plan.