Get a Portal

Returns a raw database representation of the portal.

get
http://konnect-api.konnect.svc.cluster.local:300/v0/internal/portals/{portalId}

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

A raw database portal

Portal

* Additional properties are allowed.
idstring(uuid)required
namestringrequired
display_namestring
uristringrequired
custom_domainstring
is_domain_verifiedboolean
logostring
logo_filenamestring
faviconstring
favicon_filenamestring
is_publicboolean
authentication_enabledboolean
default_api_visibilitystring

Allowed values:publicprivate

default_page_visibilitystring

Allowed values:publicprivate

auto_approve_developersboolean
auto_approve_applicationsboolean
rbac_enabledboolean
configobject
* Additional properties are allowed.
versionstringrequired
customizationobject

The custom settings of this portal

* Additional properties are NOT allowed.
Show Child Parameters
labelsobjectrequired

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"}

descriptionstring
default_application_auth_strategyobjectrequired
Show Child Parameters
sipr_enabledboolean

Whether ip allow list is enabled for the organization.

Default:false

Example:true

get/internal/portals/{portalId}
 
application/json

App Auth Strategies

Get an Auth Strategy

Returns a raw database representation of the auth strategy.

get
http://konnect-api.konnect.svc.cluster.local:300/v0/internal/application-auth-strategies/{authStrategyId}

Path Parameters

authStrategyIdstring(uuid)required

ID of the auth strategy to use for the application

Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79

Response

application/json

A raw database auth strategy

AuthStrategy

idstring(uuid)required
namestringrequired
display_namestringrequired
strategy_typestringrequired
configsobjectrequired
labelsobjectrequired

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"}

dcr_providerobject | nullrequired
Show Child Parameters
get/internal/application-auth-strategies/{authStrategyId}
 
application/json

api-products

Get Product Version by CP/Service ID

retrieves a product version id by control plane and gateway service

get
http://konnect-api.konnect.svc.cluster.local:300/v0/internal/control-planes/{controlPlaneId}/gateway-services/{gatewayServiceId}/product-version

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

gatewayServiceIdstring(uuid)required

ID of the gateway service.

Response

application/json

A product version

ProductVersion

* Additional properties are NOT allowed.
idstring(uuid)required
get/internal/control-planes/{controlPlaneId}/gateway-services/{gatewayServiceId}/product-version
 
application/json