Skip to content
Kong Docs are moving soon! Our docs are migrating to a new home. You'll be automatically redirected to the new site in the future. In the meantime, view this page on the new site!
|

Portal Management

v3.0.8OAS 3.0

The management API for Portals

API Base URL
  • Server 1:https://us.api.konghq.com/v3

    United-States Production region

  • Server 2:https://eu.api.konghq.com/v3

    Europe Production region

  • Server 3:https://au.api.konghq.com/v3

    Australia Production region

  • Server 4:https://me.api.konghq.com/v3

    Middle-East Production region

  • Server 5:https://in.api.konghq.com/v3

    India Production region

Security
personalAccessToken (http)

The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.
You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.
The PAT token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'

systemAccountAccessToken (http)

The system account access token is meant for automations and integrations that are not directly associated with a human identity.
You can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.
The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'

Additional Information
Contact Kong

List Portals

Pre-release Endpoint
This endpoint is currently in beta and is subject to change.

Lists developer portals defined in this region for this organization. Each developer portal is available at a unique address and has isolated configuration, customization, developers, and applications.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

sortstring

Sorts a collection of portals. Supported sort attributes are:

  • name
  • description
  • authentication_enabled
  • rbac_enabled
  • auto_approve_applications
  • auto_approve_developers
  • default_domain
  • canonical_domain
  • created_at
  • updated_at
filterobject

Filter portals returned in the response.

Show Child Parameters

Response

application/json

A paginated list of portals in the current region of an organization.

* Additional properties are NOT allowed.
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/portals
 
application/json