GRgravitee-io
Portals

Create or update a Portal

Changed on

Create or update a Portal from PortalSpec

put/organizations/{orgId}/environments/{envId}/portals

Request

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

Path parameters

orgIdstring required
Example:dedd0e0f-b3e9-4d2f-89cd-b2a9de7cb145

organization ID

envIdstring required
Example:a44e0d1b-9fa9-4d64-8b76-3634623a2e27

environment ID

Query parameters

dryRunboolean
Example:true

For modifying requests, this parameter allow you to test the result of an endpoint without actually persisting the state of the underlying spec.

Request body

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.

Example request

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

Response

State of the successfully created/updated Portal

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
    • warning

      changed the pattern of the request property 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]$

    • info

      added the new optional request property

    • info

      added the new optional request property //

    • info

      added the new optional request property

    • info

      request property deprecated

    • 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

      changed the pattern of the request property 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]$

    • warning

      removed the request property

    • warning

      removed the request property //

    • warning

      removed the request property

    • 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

      request property reactivated

    • 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