Portal
objectContains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
The name of the portal, used to distinguish it from other portals. Name must be unique.
>= 1 characters<= 255 characters
The display name of the portal. This value will be the portal’s name in Portal API.
>= 1 characters<= 255 characters
The description of the portal.
<= 512 characters
The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``.
Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.
Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for products until unless assigned to teams with access to view and consume specific products.
Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.
Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.
The custom domain to access the developer portal. A CNAME for the portal’s default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal’s web client and API.
The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal client will no longer be available. custom_domain must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.
Default strategy ID applied on applications for the portal
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Number of applications created in the portal.
Number of developers using the portal.
Number of api products published to the portal
Portal
objectContains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
The name of the portal, used to distinguish it from other portals. Name must be unique.
>= 1 characters<= 255 characters
The display name of the portal. This value will be the portal’s name in Portal API.
>= 1 characters<= 255 characters
The description of the portal.
<= 512 characters
The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``.
Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.
Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for products until unless assigned to teams with access to view and consume specific products.
Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.
Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.
The custom domain to access the developer portal. A CNAME for the portal’s default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal’s web client and API.
The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal client will no longer be available. custom_domain must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.
Default strategy ID applied on applications for the portal
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Number of applications created in the portal.
Number of developers using the portal.
Number of api products published to the portal
GetAppearanceDefaultsResponse
objectThe built-in appearance settings available for portals.
The set of built-in appearance themes that are provided for portals.
Example:{"mint_rocket":{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}},"dark_mode":{"colors":{"section":{"header":{"value":"#0A161E","description":"Background for header"},"body":{"value":"#0C0C0C","description":"Background for main content"},"hero":{"value":"#1A1D21","description":"Background for hero section"},"accent":{"value":"#1F1F1F","description":"Subtle background"},"tertiary":{"value":"#222529","description":"Tertiary background"},"stroke":{"value":"#34393F","description":"Border color"},"footer":{"value":"#212429","description":"Background for footer"}},"text":{"header":{"value":"#FFFFFF","description":"Header text"},"hero":{"value":"rgba(255,255,255,0.8)","description":"Hero text"},"headings":{"value":"#FFFFFF","description":"Headings text"},"primary":{"value":"#C8C8C9","description":"Main content text"},"secondary":{"value":"#919294","description":"Supporting text"},"accent":{"value":"#FFFFFF","description":"Subtle text"},"link":{"value":"#2977FF","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}}}
Show Child Parameters
Font selections to render text in the portal user interface. Must set use_custom_fonts to true to enable using custom font values.
Show Child Parameters
Values to display for customizable text in the portal user interface
Show Child Parameters
GetPortalAppearanceResponse
Select a pre-existing default theme or specify ‘custom’ to use custom_theme variables.
Allowed values:mint_rocketdark_modecustom
Example:mint_rocket
Groups of variables for configuring visual details of the portal user interface. Set theme_name to ‘custom’ to use custom values for theme variables.
Example:{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}}
Show Child Parameters
Font selections to render text in the portal user interface. Must set use_custom_fonts to true to enable using custom font values.
Show Child Parameters
If true, fonts in custom_fonts will be used over the theme’s default fonts
Values to display for customizable text in the portal user interface
Example:{"catalog":{"welcome_message":"Welcome to our service catalog","primary_header":"Find All of Our Services in a Single Place"}}
Show Child Parameters
A collection of binary image data to customize images in the portal
Example:{"logo":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"favicon":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"catalog_cover":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="}}
Show Child Parameters
UpdatePortalAppearanceResponse
Select a pre-existing default theme or specify ‘custom’ to use custom_theme variables.
Allowed values:mint_rocketdark_modecustom
Example:mint_rocket
Groups of variables for configuring visual details of the portal user interface. Set theme_name to ‘custom’ to use custom values for theme variables.
Example:{"colors":{"section":{"header":{"value":"#F8F8F8","description":"Background for header"},"body":{"value":"#FFFFFF","description":"Background for main content"},"hero":{"value":"#F8F8F8","description":"Background for hero section"},"accent":{"value":"#F8F8F8","description":"Subtle background"},"tertiary":{"value":"#FFFFFF","description":"Tertiary background"},"stroke":{"value":"rgba(0,0,0,0.1)","description":"Border color"},"footer":{"value":"#07A88D","description":"Background for footer"}},"text":{"header":{"value":"rgba(0,0,0,0.8)","description":"Header text"},"hero":{"value":"#FFFFFF","description":"Hero text"},"headings":{"value":"rgba(0,0,0,0.8)","description":"Headings text"},"primary":{"value":"rgba(0,0,0,0.8)","description":"Main content text"},"secondary":{"value":"rgba(0,0,0,0.8)","description":"Supporting text"},"accent":{"value":"#07A88D","description":"Subtle text"},"link":{"value":"#07A88D","description":"Link text"},"footer":{"value":"#FFFFFF","description":"Footer text"}},"button":{"primary_fill":{"value":"#1155CB","description":"Background for Primary Button"},"primary_text":{"value":"#FFFFFF","description":"Text for Primary Button"}}}}
Show Child Parameters
Font selections to render text in the portal user interface. Must set use_custom_fonts to true to enable using custom font values.
Show Child Parameters
If true, fonts in custom_fonts will be used over the theme’s default fonts
Values to display for customizable text in the portal user interface
Example:{"catalog":{"welcome_message":"Welcome to our service catalog","primary_header":"Find All of Our Services in a Single Place"}}
Show Child Parameters
A collection of binary image data to customize images in the portal
Example:{"logo":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"favicon":{"data":"data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU="},"catalog_cover":{"data":"data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="}}