Sign in

v5

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-0330110112.1 KB
Portals

Create or update a Portal

Create or update a Portal from PortalSpec

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

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

Example request

{
  "hrid": "demo_api",
  "name": "Default Portal",
  "navigation": [
    {
      "path": "/projects/alpha",
      "displayName": "Alpha"
    }
  ]
}

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

idstring

Resource UUID.

environmentIdstring

The environment ID.

organizationIdstring

The organization ID.

Example response

{
  "hrid": "demo_api",
  "name": "Default Portal",
  "navigation": [
    {
      "path": "/projects/alpha",
      "displayName": "Alpha"
    }
  ]
}