1.0.13OAS 3.0

Internal api for api builder to allow updating of entities in api-builder db.

API Base URL
  • Server 1:builder.apibuilder.svc.cluster.local:3000/v1

    Konnect cluster

Additional Information
Contact Kong

portal

Upsert Portal

Accepts a raw database representation of the Portal in the request body.
Accepts a raw database representation of any linked default App Auth Strategy in the response body or null if there is none.

put
builder.apibuilder.svc.cluster.local:3000/v1/internal/portals/{portalId}

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Portal

idstring(uuid)required
namestringrequired
display_namestring
uristringrequired
custom_domainstring | null
is_domain_verifiedboolean
logostring | null
logo_filenamestring | null
faviconstring | null
favicon_filenamestring | null
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 | null
* Additional properties are allowed.
versionstring
customizationobject | null
* 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 | null
default_application_auth_strategyobject | nullrequired
Show Child Parameters

Response

The portal has been updated

put/internal/portals/{portalId}

Body

{ "id": "id", "name": "name", "uri": "uri", "labels": { "env": "test" }, "default_application_auth_strategy": { "id": "id", "name": "name", "display_name": "display_name", "strategy_type": "strategy_type", "configs": {}, "labels": { "env": "test" }, "dcr_provider": { "id": "id", "name": "name", "provider_type": "provider_type", "issuer": "issuer", "dcr_config": {}, "labels": { "env": "test" } } } }
 

Delete Portal

Deletes portal specified in path

delete
builder.apibuilder.svc.cluster.local:3000/v1/internal/portals/{portalId}

Query Parameters

forcestring

If true, delete also related publications entities

Allowed values:truefalse

Default:false

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

No Content.

delete/internal/portals/{portalId}
 

DCR Providers