2.2.2OAS 3.0

The management API for Portals

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

    United-States Production region

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

    Europe Production region

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

    Australia Production region

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

    Middle-East Production region

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

    India Production region

  • Server 6:https://sg.api.konghq.com/v2

    Singapore 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

Portals

APIs related to Configuration of Konnect Developer Portals.

Get a portal configuration

Get the configuration of the portal

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Response for a portal configuration

PortalConfig

* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are allowed.
Show Child Parameters
get/portals/{portalId}/config
 
application/json

Replace a portal configuration

Update the configuration of the portal

put

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

PortalConfig

* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are allowed.
Show Child Parameters

Response

application/json

Response for a portal configuration

PortalConfig

* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are allowed.
Show Child Parameters
put/portals/{portalId}/config

Body

{ "data": {} }
 
application/json

Update a portal configuration

Update the configuration of the portal

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Request schema to replace the portal configuration.

PortalConfig

* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are allowed.
Show Child Parameters

Response

application/json

Response for a portal configuration

PortalConfig

* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are allowed.
Show Child Parameters
patch/portals/{portalId}/config

Body

{ "data": {} }
 
application/json