CreatePortalSnippetRequest

object

Create a snippet in a portal.

* Additional properties are NOT allowed.
namestringrequired

The unique name of a snippet in a portal.

<= 512 characters

Example:my-snippet

titlestring

The display title of a snippet in a portal.

<= 512 characters

Example:My Snippet

contentstringrequired

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Snippet

visibilitystring

Whether a snippet is publicly accessible to non-authenticated users.
If not provided, the default_page_visibility value of the portal will be used.

Allowed values:publicprivate

Example:public

statusstring

Whether the resource is visible on a given portal. Defaults to unpublished.

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

Example

UpdateApplicationRequest

object
* Additional properties are NOT allowed.
ownerobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

ListApplicationsResponse

object
* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataOne Of
arrayrequired

Example:{"id":"b15e2460-ba40-431d-9df0-4957fcffacda","labels":{"env":"test"},"name":"App 1","description":"An easy to manage app in a Konnect developer portal","registration_count":4,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"auth_strategy":{"id":"45606071-49c7-4c2e-ae49-8a86d72a8110","name":"API Key","credential_type":"key_auth","key_names":["apikey"]},"created_at":"2022-12-22T19:09:30.712Z","updated_at":"2022-12-22T19:09:30.712Z","owner":{"id":"8cd9feff-b4da-4a9f-ba49-cbe83c75ff22","type":"developer"}}

Client Credentials Applicationobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

Application

One Of
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

namestringrequired

The name of the application.

descriptionstringrequired

A description of the application.

labelsobjectrequired

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

client_idstringrequiredread-only

The ID used to linked the portal application to an Identity Provider application.

registration_countnumberrequiredread-only

The number of API registrations that are associated with the application. Registrations of any status are included in the count.

dcr_providerobjectrequired

Information about the DCR provider this application uses, if using DCR.

* Additional properties are NOT allowed.
Show Child Parameters
portalobjectrequired

Information about the portal the application is in.

* Additional properties are NOT allowed.
Show Child Parameters
auth_strategyobjectrequired

Client Credential Auth strategy that the application uses.

* Additional properties are NOT allowed.
Show Child Parameters
granted_scopesarray[string]required

List of granted scopes for the application. Null if application type does not support returning granted scopes.

ownerobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

ListApplicationDevelopersResponse

object
* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

List of developers that have a registered application.

Example:{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"user@email.com","full_name":"API Developer"}

* Additional properties are NOT allowed.
Show Child Parameters
Example