AccessAudit4

AccessRole4

AccessRoleBinding4

Add-Ons4

AI Gateway Agents4

AI Gateway Auth Strategies4

AI Gateway CA Certificates4

AI Gateway Certificates4

AI Gateway Config Stores8

AI Gateway Consumer Groups6

AI Gateway Consumers7

AI Gateway DataPlane Certificates3

AI Gateway Identity Providers4

AI Gateway MCP Servers4

AI Gateway Model Providers4

AI Gateway Models4

AI Gateway Policies4

AI Gateway SNIs4

AI Gateway Vaults4

AI Gateways4

API4

API Documentation4

API Implementation3

API Publication3

API Specification4

API Version4

Application Registrations4

Applications4

Assets4

Auth Server4

Auth Server Claims4

Auth Server Clients8

Auth Server Scopes4

Auth Server Trusted IdPs3

Dashboards4

Event Gateway Backend Clusters4

Event Gateway DataPlane Certificates4

Event Gateway Listener Policies8

Event Gateway Listeners4

Event Gateway Schema Registries4

Event Gateway Static Keys3

Event Gateway TLS Trust Bundles4

Event Gateway Vaults4

Event Gateway Virtual Cluster Consume Policies20

Event Gateway Virtual Cluster Policies4

Event Gateway Virtual Cluster Produce Policies16

Event Gateway Virtual Clusters4

Event Gateways4

HostnameGenerator4

Kong Identity Directories4

Mesh9

MeshAccessLog4

MeshCircuitBreaker4

MeshExternalService4

MeshFaultInjection4

MeshGateway4

MeshGlobalRateLimit4

MeshHealthCheck4

MeshHTTPRoute4

MeshIdentity4

MeshLoadBalancingStrategy4

MeshMetric4

MeshMultiZoneService4

MeshOPA4

MeshOpenTelemetryBackend4

MeshPassthrough4

MeshProxyPatch4

MeshRateLimit4

MeshRetry4

MeshService4

MeshTCPRoute4

MeshTimeout4

MeshTLS4

MeshTrace4

MeshTrafficPermission4

MeshTrust4

MeshZoneAddress4

Pages4

Personal Access Tokens2

Portal Audit Logs3

Portal Auth Settings9

Portal Custom Domains4

Portal Customization2

Portal Developers4

Portal Team Roles2

Portal Teams4

Portals5

Portals IP Allow List4

Secret4

Snippets4

Workload4

ZoneEgress4

ZoneIngress4

Portal Customization

Replace Customization

Replace the portal customization options.

put/v3/portals/{portalId}/customization

Path parameters

portalIdstring uuid required

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

The Portal identifier

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"
      }
    ]
  },
  "portal_layout": {
    "footer": {
      "snippet_name": "my-snippet"
    }
  }
}

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"
      }
    ]
  },
  "portal_layout": {
    "footer": {
      "snippet_name": "my-snippet"
    }
  }
}

Changes

Changed in 4 of the 30 revisions of this API.9124

Aug 18, 2026658ffb748f952See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 6, 20255d2b35832e3f1See the full diff
- ●
  added the new type enum value to the /////// response property for the response status
  response-property-enum-value-added
This revision also has 57 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 2, 2025ecce2daf9de6918See the full diff
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  the request property / became nullable
  request-property-became-nullable
- ○
  the request property / became nullable
  request-property-became-nullable
- ○
  the request property / became nullable
  request-property-became-nullable
- ○
  the request property / became nullable
  request-property-became-nullable
- ○
  the request property default value false was added
  request-property-default-value-added
- ○
  the request property default value false was added
  request-property-default-value-added
- ○
  the request property default value true was added
  request-property-default-value-added
- ○
  the request property default value true was added
  request-property-default-value-added
- ○
  the request property default value true was added
  request-property-default-value-added
- ○
  the request property default value true was added
  request-property-default-value-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  the response's property default value false was added for the status
  response-property-default-value-added
- ○
  the response's property default value false was added for the status
  response-property-default-value-added
- ○
  the response's property default value true was added for the status
  response-property-default-value-added
- ○
  the response's property default value true was added for the status
  response-property-default-value-added
- ○
  the response's property default value true was added for the status
  response-property-default-value-added
- ○
  the response's property default value true was added for the status
  response-property-default-value-added
Aug 12, 2025b2800570b3e24See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history