Fetch details for multiple APIs (internal)

Accepts an array of API ids in body
Returns a list of APIs with their details

post
builder.apibuilder.svc.cluster.local:3000/v1/internal/apis/details-by-id

Body

application/json

ApiIds

api_idsarray[string](uuid)required

Response

application/json

A response containing a single DCR provider object.

ApisDetailsById

apisarray[object]required
Show Child Parameters
post/internal/apis/details-by-id

Body

{ "api_ids": [ "93f8380e-7798-4566-99e3-2edf2b57d289", "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7" ] }
 
application/json

Portal

object
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.
versionstring
customizationobject
* Additional properties are allowed.
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
Example

NullableAuthStrategy

object
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_providerobjectrequired
Show Child Parameters
Example

NullableDcrProvider

object
idstring(uuid)required
namestringrequired
provider_typestringrequired
issuerstringrequired
dcr_configobjectrequired
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"}

Example

UpdateDcrProviderRequest

object

Updates a DCR provider.

idstring(uuid)required
org_idstring(uuid)required
namestringrequired

The name of the DCR provider. This is used to identify the DCR provider in the Konnect UI.

>= 1 characters<= 256 characters

provider_typestringrequired

The type of DCR provider. Can be one of the following - auth0, azureAd, curity, okta, http, kongIdentity

Allowed values:auth0azureAdcurityoktahttpkongIdentity

issuerstring(url)required

<= 256 characters

labelsobject

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 “_”.

Example:{"env":"test"}

dcr_configAny Of
required
DcrConfigAuth0InRequestobject

Payload to update an Auth0 DCR provider.

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)required
updated_atstring(date-time)required
Example