Delete Snippet

Deletes a single custom snippet for this portal.

delete

Path Parameters

portalIdstring(uuid)required

ID of the portal.

snippetIdstring(uuid)required

ID of the snippet.

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

Response

No Content

delete/portals/{portalId}/snippets/{snippetId}
 

Applications

APIs related to Konnect Developer Portal Applications.

List Applications

Lists applications in this portal. Each application can be registered for various APIs, issuing credentials for API access. If using DCR, an application will be linked to an Identity Provider’s application by its client_id.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

sortstring

Sorts a collection of applications. Supported sort attributes are:

  • created_at
  • developer_id
  • name
filterobject

Filter applications returned in the response.

Show Child Parameters

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

A paginated list of applications in a portal.

ListApplicationsResponse

* 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
get/portals/{portalId}/applications
 
application/json

Get an Application by Portal

Returns the configuration of a single application in this portal. If an application is linked to a DCR Provider, the dcr_provider.id and client_id can be used to correlate it. An application manages a set of credentials and registrations for specific APIs.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

applicationIdstring(uuid)required

ID of the application.

Response

application/json

Details about an application in a portal.

GetApplicationResponse

GetApplicationResponse
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.

descriptionstring | nullrequired

A description of the application.

labelsobject | nullrequired

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_providerobject | nullrequired

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 | null[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
get/portals/{portalId}/applications/{applicationId}
 
application/json

Update Application

Updates an application.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

applicationIdstring(uuid)required

ID of the application.

Body

application/json

Update an application.

UpdateApplicationRequest

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

Response

application/json

Details about an application in a portal.

GetApplicationResponse

GetApplicationResponse
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.

descriptionstring | nullrequired

A description of the application.

labelsobject | nullrequired

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_providerobject | nullrequired

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 | null[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
patch/portals/{portalId}/applications/{applicationId}

Body

{}
 
application/json