Create a Dev Portal

1. In Dev Portal, click Dev Portal on the top right.
2. In the Create Dev Portal dialog, configure your Dev Portal settings:
   1. Enter general information for your Dev Portal, including a name and optional description.
   2. Select if you want the Dev Portal to be private or public. Anyone can see APIs published to a public portal while only registered and logged in users can see APIs in a private portal. Developers can only get credentials and start consuming APIs through self service in a private Dev Portal.
   3. Private Dev Portal only: Configure the following settings:
      • Auto Approve Developers: If you enable this setting, this will allow developers to automatically be approved when they sign up for your private Dev Portal. If you don’t enable this, you must configure single sign-on or manually approve developers as they register.
      • Auto Approve Applications: If you enable this setting, apps that developers create with your APIs will be automatically approved. If you don’t enable this, you must manually approve or deny application registrations.
      • Portal RBAC: Portal RBAC allows you to assign developers to teams and roles that determine if they can only view or view and consume the APIs in your Dev Portal.
      • Default Application Auth Strategy: Select the auth strategy you want the APIs in your Dev Portal to use if they require authentication. This auth strategy will be how developers authenticate when they register to consume your APIs. Selecting a default auth strategy makes it easier for your API Product owners to publish an API to a Dev Portal that requires authentication, because the default auth strategy will be auto selected for them. If you’re not sure which auth strategy to use, you can select the pre-created key-auth strategy.
   4. Optional: Configure the visual customization settings, such as a Dev Portal logo, favicon, and home page header image.
   5. Optional: Add labels to your Dev Portal. Labels will help you identify and search for your Dev Portal in Konnect.
3. Click Save.
4. Repeat steps 1-3 to create additional Dev Portals.

The Konnect API uses Personal Access Token (PAT) authentication. You can obtain your PAT from the personal access token page. The PAT must be passed in the Authorization header of all requests.

To create a Dev Portal, do one of the following:

• Create a private Dev Portal using the /portals endpoint:

    curl --request POST \
    --url https://{region}.api.konghq.com/v2/portals \
    --header 'Authorization: <personal-access-token>' \
    --header 'Content-Type: application/json' \
    --data '{
        "name": "DEV_PORTAL_NAME",
        "is_public": false,
        "rbac_enabled": true,
        "auto_approve_applications": true,
        "auto_approve_developers": true,
        "custom_domain": "api.example.com",
        "custom_client_domain": "portal.example.com",
        "default_application_auth_strategy_id": "41f3adcb-5f5b-4c97-ab08-3ac2777aa6ab"
    }'
  

  Be sure to replace the PAT as well as the following placeholders with your own values:

  • name
  • rbac_enabled
  • auto_approve_applications
  • auto_approve_developers
  • custom_domain
  • custom_client_domain
  • default_application_auth_strategy_id Refer to the API spec for more information.

  You should receive a 201 response containing information about your Dev Portal.

• Create a public Dev Portal using the /portals endpoint:

    curl --request POST \
    --url https://{region}.api.konghq.com/v2/portals \
    --header 'Authorization: <personal-access-token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "name": "DEV_PORTAL_NAME",
    "is_public": true,
    "custom_domain": "api.example.com",
    "custom_client_domain": "portal.example.com"
    }'
  

  Be sure to replace the PAT token and placeholder values. You can use the following two values to further configure the Dev Portal:

  • custom_domain: Optional, you can configure this if you want to use a different URL for hosting your Dev Portal instead of Konnect. 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.
  • custom_client_domain: Optional, you can configure this if you want to use a different URL for your Dev Portal other than the default one.