Sign in

v18

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-05-21112432.1 KB
Management UI

Get a portal menu link

Get a portal menu link used in the given environment.

User must have the ENVIRONMENT_SETTINGS[READ] permission.

get/ui/portal-menu-links/{portalMenuLinkId}

Query parameters

pageinteger

The page number for pagination.

perPageinteger

The number of items per page for pagination.

Response

The requested portal menu link

idstring required

Portal menu link id

namestring required

Displayed name of the menu link

type'EXTERNAL' required

type of the menu link

targetstring

target of the menu link

visibility'PUBLIC' | 'PRIVATE'

visibility of the menu link

orderinteger required

The order of the menu link.

Example response

{
  "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "name": "My custom link",
  "type": "EXTERNAL",
  "target": "https://gravitee.io",
  "visibility": "PRIVATE",
  "order": 2
}