GRgravitee-io
Portals

Get one Portal

Changed on

Get a Portal using HRID

get/organizations/{orgId}/environments/{envId}/portals/{hrid}

Request

  • Base URL
    https://eu.cloudgate.gravitee.io/apim/automation
  • URL
    https://eu.cloudgate.gravitee.io/apim/automation/organizations/{orgId}/environments/{envId}/portals/{hrid}
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or HTTP bearer

Response

Portal successfully retrieved

hridstring required

A unique human readable id identifying this resource

namestring required

Display name of the portal

activeThemeHridstring

HRID of the Theme this portal should use as its active theme. When set, applying the portal marks the referenced theme as active (enabled) and disables every other PORTAL_NEXT theme in the environment. Leaving this field unset clears the reference and disables the previously-active theme; the portal-next UI will then lazily fall back to a fresh default theme.

idstring

Resource UUID.

environmentIdstring

The environment ID.

organizationIdstring

The organization ID.

Example response

{
  "hrid": "demo_api",
  "name": "Default Portal",
  "structure": {
    "topNavbar": [
      {
        "path": "/projects/alpha",
        "displayName": "Alpha"
      }
    ]
  },
  "navigation": [
    {
      "path": "/projects/alpha",
      "displayName": "Alpha"
    }
  ],
  "activeThemeHrid": "brand-theme"
}

Changes

  • 460368511daeRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      response property allOf[PortalSpec]/navigation deprecated

    • info

      the //// response's property pattern was changed from ^[a-zA-Z0-9][a-zA-Z0-9_-]+[a-zA-Z0-9]$ to ^[a-zA-Z0-9][a-zA-Z0-9_.-]+[a-zA-Z0-9]$ for the status

  • ecefec7d65f9Revision changes
    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      the //// response's property pattern was changed from ^[a-zA-Z0-9][a-zA-Z0-9_.-]+[a-zA-Z0-9]$ to ^[a-zA-Z0-9][a-zA-Z0-9_-]+[a-zA-Z0-9]$ for the status

    • info

      response property allOf[PortalSpec]/navigation reactivated