GRgravitee-io
Management UI

Get a portal menu link

Changed on

Get a portal menu link used in the given environment.

User must have the ENVIRONMENT_SETTINGS[READ] permission.

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

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/ui/portal-menu-links/{portalMenuLinkId}
  • Auth
    none declared

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
}

Changes