Sign in

v58

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-036490116.2 KB
Portal Navigation Items

Create a portal navigation item

User must have the ENVIRONMENT_DOCUMENTATION[update] permission.

post/portal-navigation-items

Request body

OR
OR
OR
OR

Example request

{
  "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "type": "FOLDER",
  "area": "TOP_NAVBAR",
  "order": 2,
  "parentId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "visibility": "PUBLIC",
  "portalPageContentId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "source": {
    "type": "github-fetcher",
    "fetchCron": "0 */10 * * * *",
    "lastFetchedAt": "2026-07-17T00:00:00.000Z"
  }
}

Response

Portal navigation item created. Newly created items are unpublished by default.

OR
OR
OR
OR

Example response

{
  "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "organizationId": "DEFAULT",
  "environmentId": "DEFAULT",
  "type": "FOLDER",
  "area": "TOP_NAVBAR",
  "parentId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "rootId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "order": 2,
  "published": true,
  "visibility": "PUBLIC",
  "portalPageContentId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "source": {
    "type": "github-fetcher",
    "fetchCron": "0 */10 * * * *",
    "lastFetchedAt": "2026-07-17T00:00:00.000Z"
  }
}