---
title: "Portal"
url: "https://nov18-dev.movespot.fyi/apis/portal-dev-3/versions/311d23f9-6037-4a0a-98d0-73df6a38f29f"
---

# Portal

OpenAPI specification document.

```json
{"openapi":"3.0.0","info":{"title":"Portal","version":"3.3.1","description":"N/A (this description is removed during bundling)","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"paths":{"/api/v3/customization":{"get":{"operationId":"get-portal-customization","summary":"Get Portal Customization Settings","description":"Returns the portal's custom settings.","responses":{"200":{"$ref":"#/components/responses/PortalCustomizationResponse"}},"security":[{}],"tags":["Portal"]}},"/api/v3/integrations":{"get":{"operationId":"get-portal-integrations","summary":"Get Portal Integration Configurations","description":"Returns the portal's integration configurations.","responses":{"200":{"$ref":"#/components/responses/PortalIntegrationsResponse"}},"security":[{}],"tags":["Portal"]}}},"components":{"schemas":{"PortalCustomization":{"description":"The custom settings of this portal","type":"object","properties":{"theme":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","nullable":false},"mode":{"type":"string","enum":["light","dark","system"]},"colors":{"type":"object","additionalProperties":false,"properties":{"primary":{"type":"string","example":"#000000","nullable":false,"pattern":"^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$","x-validation-message":"must be a valid hex color value"}}}}},"layout":{"type":"string","nullable":false},"css":{"type":"string","nullable":true},"js":{"type":"object","additionalProperties":false,"properties":{"custom":{"type":"string","nullable":true},"scripts":{"type":"array","items":{"type":"string","pattern":"^https://[^:.]+\\..+$"},"maxItems":20}}},"menu":{"type":"object","additionalProperties":false,"properties":{"main":{"type":"array","items":{"$ref":"#/components/schemas/PortalMenuItem"}},"footer_sections":{"type":"array","items":{"$ref":"#/components/schemas/PortalFooterMenuSection"}},"footer_bottom":{"type":"array","items":{"$ref":"#/components/schemas/PortalMenuItem"}}}},"spec_renderer":{"type":"object","additionalProperties":false,"properties":{"try_it_ui":{"description":"Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured.","type":"boolean","default":true},"try_it_insomnia":{"description":"Enables users to open API specifications in Insomnia to explore and send requests with the native client. Only public API specifications are supported.","type":"boolean","default":true},"infinite_scroll":{"description":"Display the full spec on a single, scrollable page. If disabled, documentation, endpoints, and schemas appear on separate pages.","type":"boolean","default":true},"show_schemas":{"description":"Control whether schemas are visible in your API specs. When enabled, schemas appear in the side navigation below the endpoints.","type":"boolean","default":true},"hide_internal":{"description":"Manage visibility of internal endpoints and models.","type":"boolean","default":false},"hide_deprecated":{"description":"Manage visibility of deprecated endpoints and models.","type":"boolean","default":false},"allow_custom_server_urls":{"description":"Let users define a custom server URL for endpoints. This will be used to generate code snippets and to test the API. The URL is client-side only and is not saved.","type":"boolean","default":true}}},"robots":{"type":"string","nullable":true}},"additionalProperties":false,"title":"PortalCustomization"},"PortalIntegrations":{"description":"Configuration data for Dev Portal integrations","type":"object","properties":{"google_tag_manager":{"$ref":"#/components/schemas/GoogleTagManagerIntegration"},"google_analytics_4":{"$ref":"#/components/schemas/GoogleAnalytics4Integration"}},"default":{},"additionalProperties":false,"title":"Portal Integrations"},"PortalMenuItem":{"type":"object","properties":{"path":{"description":"The absolute path of a page in a portal with a leading slash.","type":"string","example":"/about/company","maxLength":512},"title":{"description":"The link display text","type":"string","example":"My Page"},"visibility":{"description":"Whether a menu item is public or private. Private menu items are only accessible to authenticated users.","type":"string","example":"public","enum":["public","private"]},"external":{"description":"When clicked, open the link in a new window","type":"boolean"}},"additionalProperties":false,"required":["path","title","visibility","external"]},"PortalFooterMenuSection":{"type":"object","properties":{"title":{"description":"The footer menu section title","type":"string","maxLength":512},"items":{"type":"array","items":{"$ref":"#/components/schemas/PortalMenuItem"}}},"additionalProperties":false,"required":["title","items"]},"GoogleTagManagerIntegration":{"description":"Google Tag Manager integration configuration","type":"object","properties":{"enabled":{"description":"Whether the integration is enabled","type":"boolean"},"type":{"description":"The type of the integration for categorization","type":"string","enum":["tracking"]},"consent_required":{"description":"Whether the integration requires user consent in order to send or utilize related data","type":"boolean"},"config_data":{"description":"Configuration data for the Google Tag Manager integration","type":"object","additionalProperties":false,"properties":{"id":{"description":"The Google Tag Manager container ID","type":"string","example":"GTM-XXXXXX","maxLength":20,"minLength":5,"pattern":"^GTM-[A-Za-z0-9]+$","x-validation-message":"must be a valid GTM container ID (format: GTM-XXXXXX)"},"l":{"description":"Optional dataLayer variable name","type":"string","example":"myNewName","maxLength":100,"nullable":true},"preview":{"description":"Preview environment name","type":"string","example":"preview","maxLength":100,"nullable":true},"cookies_win":{"description":"Forces GTM cookies to take precedence when true","type":"boolean","nullable":true},"debug":{"description":"Enables debug mode when true","type":"boolean","nullable":true},"npa":{"description":"No Personal Advertising - disables advertising features when true","type":"boolean","nullable":true},"data_layer":{"description":"Custom dataLayer name (alternative to \"l\" property)","type":"string","example":"myNewName","maxLength":100,"nullable":true},"env_name":{"description":"Environment name for environment-specific container","type":"string","example":"production","maxLength":100,"nullable":true},"auth_referrer_policy":{"description":"Referrer policy for analytics requests","type":"string","example":"no-referrer","maxLength":100,"nullable":true}},"required":["id"]}},"additionalProperties":false,"nullable":true,"required":["enabled","type","consent_required","config_data"]},"GoogleAnalytics4Integration":{"description":"Google Analytics integration configuration","type":"object","properties":{"enabled":{"description":"Whether the integration is enabled","type":"boolean"},"type":{"description":"The type of the integration for categorization","type":"string","enum":["analytics"]},"consent_required":{"description":"Whether the integration requires user consent in order to send or utilize related data","type":"boolean"},"config_data":{"description":"Configuration data for the Google Analytics integration","type":"object","additionalProperties":false,"properties":{"id":{"description":"The Google Analytics measurement ID","type":"string","example":"G-XXXXXXX","maxLength":20,"minLength":5,"pattern":"^G-[A-Za-z0-9-]+$","x-validation-message":"must be a valid Google Analytics ID (format: G-XXXXXXX)"},"l":{"description":"The datalayer's name you want data to be associated with","type":"string","example":"myNewName","maxLength":100,"nullable":true}},"required":["id"]}},"additionalProperties":false,"nullable":true,"required":["enabled","type","consent_required","config_data"]}},"responses":{"PortalCustomizationResponse":{"description":"Response for custom portal settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalCustomization"}}}},"PortalIntegrationsResponse":{"description":"Response for portal integration configurations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalIntegrations"}}}}}},"tags":[{"name":"Portal","description":"The API for retrieving details about a single Konnect Portal."}]}
```
