Sign in

v5

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

Create or update a Portal Listing

Create or update a Portal Listing from PortalListingSpec

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

Path parameters

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

organization ID

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

environment ID

portalHridstring required
Example:default-portal

Human-readable ID of a portal

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

Example request

{
  "hrid": "demo_api",
  "apis": [
    {
      "apiHrid": "pets-api",
      "location": "/projects/alpha",
      "order": 1
    }
  ]
}

Response

State of the successfully created/updated Portal Listing

hridstring required

A unique human readable id identifying this resource

idstring

Resource UUID.

environmentIdstring

The environment ID.

organizationIdstring

The organization ID.

portalHridstring

The HRID of the portal this listing belongs to.

Example response

{
  "hrid": "demo_api",
  "apis": [
    {
      "apiHrid": "pets-api",
      "location": "/projects/alpha",
      "order": 1
    }
  ]
}