Portals

Create Portal

Changed on

Creates a new developer portal scoped in this region for this organization.

post/v3/portals

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

idstring uuid

Contains a unique identifier used for this resource.

created_atstring date-time

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time

An ISO-8601 timestamp representation of entity update date.

namestring required

The name of the portal, used to distinguish it from other portals. Name must be unique.

display_namestring

The display name of the portal. This value will be the portal's name in Portal API.

descriptionstring nullable

A description of the portal.

authentication_enabledboolean

Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications.

rbac_enabledboolean

Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC.

sipr_enabledboolean

Whether ip allow list is enabled for the portal.

default_api_visibility'public' | 'private'

The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers.

default_page_visibility'public' | 'private'

The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers.

default_application_auth_strategy_idstring uuid nullable

The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.

auto_approve_developersboolean

Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

auto_approve_applicationsboolean

Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin.

default_domainstring hostname

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``.

canonical_domainstring hostname

The canonical domain of the developer portal

labelsLabelsUpdate nullable

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

notifications_developer_pii_visibility_enabledboolean

When enabled, portal registration notifications include the registering developer's identifying information (such as name and email).

Example request

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z",
  "sipr_enabled": true,
  "labels": {
    "env": "test"
  }
}

Response

Details about a portal.

idstring uuid required

Contains a unique identifier used for this resource.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

namestring required

The name of the portal, used to distinguish it from other portals. Name must be unique.

display_namestring required

The display name of the portal. This value will be the portal's name in Portal API.

descriptionstring nullable required

A description of the portal.

authentication_enabledboolean required

Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications.

rbac_enabledboolean required

Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC.

sipr_enabledboolean required

Whether ip allow list is enabled for the portal.

default_api_visibility'public' | 'private' required

The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers.

default_page_visibility'public' | 'private' required

The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers.

default_application_auth_strategy_idstring uuid nullable required

The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.

auto_approve_developersboolean required

Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

auto_approve_applicationsboolean required

Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin.

default_domainstring hostname required

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``.

canonical_domainstring hostname required

The canonical domain of the developer portal

labelsLabels

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 "_".

notifications_developer_pii_visibility_enabledboolean

When enabled, portal registration notifications include the registering developer's identifying information (such as name and email).

Example response

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z",
  "sipr_enabled": true,
  "labels": {
    "env": "test"
  }
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status