ACLs7

Add-Ons5

AI Gateway Agents5

AI Gateway Auth Strategies5

AI Gateway CA Certificates5

AI Gateway Certificates5

AI Gateway Config Stores10

AI Gateway Consumer Groups8

AI Gateway Consumers11

AI Gateway DataPlane Certificates4

AI Gateway Identity Providers5

AI Gateway MCP Servers5

AI Gateway Model Providers5

AI Gateway Models5

AI Gateway Nodes3

AI Gateway Policies5

AI Gateway SNIs10

AI Gateway Vaults5

AI Gateways6

API6

API Attributes1

API Documentation6

API Image4

API Implementation4

API Operations2

API Package Documentation6

API Package Image4

API Package Operations4

API Package Specification4

API Packages5

API Publication8

API Specification6

API Version5

API-keys7

App Auth Strategies6

Application Registrations8

Applications8

Assets6

Auth Settings17

Authentication1

Basic-auth credentials7

CA Certificates5

Catalog Integrations1

Catalog Resource Mappings4

Catalog Resource Services1

Catalog Resources3

Catalog Service API Mappings5

Catalog Service Resources1

Catalog Services5

Certificates5

Cloud Gateways Resource Quotas3

Config Store Secrets5

Config Stores5

Consumer Groups9

Consumers9

Control Plane Groups6

Control Planes5

Criteria Templates1

Custom Domains5

Custom Plugin Schemas5

CustomPlugins5

Dashboards5

Data-Plane Group Configurations3

DCR Providers6

Degraphql_routes7

DP Certificates5

DP Nodes6

Event Gateway Backend Clusters5

Event Gateway DataPlane Certificates5

Event Gateway Listener Policies9

Event Gateway Listeners5

Event Gateway Nodes4

Event Gateway Schema Registries5

Event Gateway Static Keys4

Event Gateway TLS Trust Bundles5

Event Gateway Virtual Cluster Consume Policies9

Event Gateway Virtual Cluster Policies9

Event Gateway Virtual Cluster Produce Policies9

Event Gateway Virtual Clusters5

Event Gateways6

GraphQL Cost Decorations7

HMAC-auth credentials7

Impersonation Settings2

Integration Instance Auth Config3

Integration Instance Auth Credentials3

Integration Instances5

Invites1

JWTs7

Keys10

KeySets5

MCP Server Runtime1

MCP Servers6

Me2

Metering Events2

Meters6

MTLS-auth credentials7

Networks6

Notifications11

OpenMeter Apps2

OpenMeter Billing Settings5

OpenMeter Customers19

OpenMeter Defaults2

OpenMeter Entitlements1

OpenMeter Features6

OpenMeter LLM Cost5

OpenMeter Product Catalog19

OpenMeter Subscriptions8

OpenMeter Tax5

Pages7

Partial Links1

Partials5

Personal Access Tokens6

Plugins26

Portal Audit Logs6

Portal Auth Settings13

Portal Custom Domains4

Portal Customization3

Portal Developers5

Portal Emails19

Portal Integrations3

Portal Team Membership4

Portal Team Roles4

Portal Teams5

Portals5

Portals IP Allow List6

Private DNS5

Provider Accounts2

Resource Availability1

Resource Configurations3

Roles9

Routes10

Schemas2

Scorecards11

Services5

Skills2

Snippets5

SNIs10

System Accounts5

System Accounts - Access Tokens5

System Accounts - Roles4

System Accounts - Team Membership4

Targets6

Team Membership4

Teams5

Transit Gateways5

Upstreams5

Users4

Vaults5

Portal Customization

Update Customization

Update the portal customization options, merging properties.

patch/v3/portals/{portalId}/customization

Path parameters

portalIdstring uuid required

Example:f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Request body

layoutstring

cssstring nullable

robotsstring nullable

Example request

{
  "theme": {
    "colors": {
      "primary": "#000000"
    }
  },
  "menu": {
    "main": [
      {
        "path": "/about/company",
        "title": "My Page",
        "visibility": "public"
      }
    ],
    "footer_sections": [
      {
        "items": [
          {
            "path": "/about/company",
            "title": "My Page",
            "visibility": "public"
          }
        ]
      }
    ],
    "footer_bottom": [
      {
        "path": "/about/company",
        "title": "My Page",
        "visibility": "public"
      }
    ]
  }
}

Response

The current customization options for a portal.

layoutstring

cssstring nullable

robotsstring nullable

Example response

{
  "theme": {
    "colors": {
      "primary": "#000000"
    }
  },
  "menu": {
    "main": [
      {
        "path": "/about/company",
        "title": "My Page",
        "visibility": "public"
      }
    ],
    "footer_sections": [
      {
        "items": [
          {
            "path": "/about/company",
            "title": "My Page",
            "visibility": "public"
          }
        ]
      }
    ],
    "footer_bottom": [
      {
        "path": "/about/company",
        "title": "My Page",
        "visibility": "public"
      }
    ]
  }
}

Changes

Changed in 7 of the 75 revisions of this API.23142

Oct 30, 2025845120e19d457See the full diff
- ▲
  the request property menu became not nullable
  request-property-became-not-nullable
- ▲
  the request property menu/footer_bottom became not nullable
  request-property-became-not-nullable
- ▲
  the request property menu/footer_sections became not nullable
  request-property-became-not-nullable
- ▲
  the request property menu/main became not nullable
  request-property-became-not-nullable
- ▲
  the request property spec_renderer became not nullable
  request-property-became-not-nullable
- ▲
  the request property theme became not nullable
  request-property-became-not-nullable
- ▲
  the request property theme/colors became not nullable
  request-property-became-not-nullable
Oct 23, 20258ab3ec3ed3011See the full diff
- ●
  added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400
  response-property-enum-value-added
Sep 11, 2025396c243e49dc2See the full diff
- ○
  added the new optional request property spec_renderer/allow_custom_server_urls
  new-optional-request-property
- ○
  added the optional property spec_renderer/allow_custom_server_urls to the response with the 200 status
  response-optional-property-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 22, 20253c0154b2053a1619See the full diff
- ▲
  the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400
  response-property-became-nullable
- ▲
  the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400
  response-property-became-nullable
- ▲
  the response property detail became nullable for the status 401
  response-property-became-nullable
- ▲
  the response property instance became nullable for the status 401
  response-property-became-nullable
- ▲
  the response property menu became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property menu/footer_bottom became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property menu/footer_sections became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property menu/main became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property spec_renderer became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property status became nullable for the status 401
  response-property-became-nullable
- ▲
  the response property theme became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property theme/colors became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property title became nullable for the status 401
  response-property-became-nullable
- ○
  the request property menu became nullable
  request-property-became-nullable
- ○
  the request property menu/footer_bottom became nullable
  request-property-became-nullable
- ○
  the request property menu/footer_sections became nullable
  request-property-became-nullable
- ○
  the request property menu/main became nullable
  request-property-became-nullable
- ○
  the request property spec_renderer became nullable
  request-property-became-nullable
- ○
  the request property theme became nullable
  request-property-became-nullable
- ○
  the request property theme/colors became nullable
  request-property-became-nullable
- ○
  the hide_deprecated request property default value false was added
  request-property-default-value-added
- ○
  the hide_internal request property default value false was added
  request-property-default-value-added
- ○
  the infinite_scroll request property default value true was added
  request-property-default-value-added
- ○
  the show_schemas request property default value true was added
  request-property-default-value-added
- ○
  the try_it_insomnia request property default value true was added
  request-property-default-value-added
- ○
  the try_it_ui request property default value true was added
  request-property-default-value-added
- ○
  the hide_deprecated response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the hide_internal response's property default value false was added for the status 200
  response-property-default-value-added
- ○
  the infinite_scroll response's property default value true was added for the status 200
  response-property-default-value-added
- ○
  the show_schemas response's property default value true was added for the status 200
  response-property-default-value-added
- ○
  the try_it_insomnia response's property default value true was added for the status 200
  response-property-default-value-added
- ○
  the try_it_ui response's property default value true was added for the status 200
  response-property-default-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 14, 20256333a0d3b09512See the full diff
- ○
  added the new optional request property spec_renderer/hide_deprecated
  new-optional-request-property
- ○
  added the new optional request property spec_renderer/hide_internal
  new-optional-request-property
- ○
  the infinite_scroll request property default value true was removed
  request-property-default-value-removed
- ○
  the show_schemas request property default value true was removed
  request-property-default-value-removed
- ○
  the try_it_insomnia request property default value true was removed
  request-property-default-value-removed
- ○
  the try_it_ui request property default value true was removed
  request-property-default-value-removed
- ○
  added the optional property spec_renderer/hide_deprecated to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property spec_renderer/hide_internal to the response with the 200 status
  response-optional-property-added
- ○
  the infinite_scroll response's property default value true was removed for the status 200
  response-property-default-value-removed
- ○
  the show_schemas response's property default value true was removed for the status 200
  response-property-default-value-removed
- ○
  the try_it_insomnia response's property default value true was removed for the status 200
  response-property-default-value-removed
- ○
  the try_it_ui response's property default value true was removed for the status 200
  response-property-default-value-removed
This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 202576b0fefddb0d8See the full diff
- ○
  the infinite_scroll request property default value true was added
  request-property-default-value-added
- ○
  the show_schemas request property default value true was added
  request-property-default-value-added
- ○
  the try_it_insomnia request property default value true was added
  request-property-default-value-added
- ○
  the try_it_ui request property default value true was added
  request-property-default-value-added
- ○
  the infinite_scroll response's property default value true was added for the status 200
  response-property-default-value-added
- ○
  the show_schemas response's property default value true was added for the status 200
  response-property-default-value-added
- ○
  the try_it_insomnia response's property default value true was added for the status 200
  response-property-default-value-added
- ○
  the try_it_ui response's property default value true was added for the status 200
  response-property-default-value-added
Jul 1, 20259a3d26a000881See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history