Portal Pages

Patch portal page

User must have the ENVIRONMENT_DOCUMENTATION[update] permission.

patch/portal-pages/{pageId}

Request

  • Base URL
    /management/v2/environments/DEFAULT (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /management/v2/environments/DEFAULT/portal-pages/{pageId}
  • Auth
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

Path parameters

pageIdstring required

The unique ID of the portal page

Request body

contentstring

The content of the page in Gravitee Markdown format

Response

A portal page

idstring

The unique ID of the portal page

contentstring

Page contents

type'gravitee_markdown'

Content type

context'homepage'

The portal context (eg. "homepage", "api_list")

publishedboolean

Whether the page is published or not

Changes

No recorded changes to this operation across all 65 revisions of this API.