Get a Snippet

Returns the configuration of a single custom snippet for this portal. Custom snippets can be used to display static content, documentation, or other information to developers.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

snippetIdstring(uuid)required

ID of the snippet.

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

Response

application/json

Details about a snippet in a portal.

PortalSnippetResponse

Details about a snippet in a portal.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

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

visibilitystringrequired

Whether the resource is publicly accessible to non-authenticated users.

Allowed values:publicprivate

Example:public

statusstringrequired

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

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

get/portals/{portalId}/snippets/{snippetId}
 
application/json

Update Snippet

Updates the configuration of a single custom snippet for this portal.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

snippetIdstring(uuid)required

ID of the snippet.

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

Body

application/json

Update a snippet in a portal.

UpdatePortalSnippetRequest

Update a snippet in a portal.

* Additional properties are NOT allowed.
namestring

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

contentstring

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Snippet

visibilitystring

Whether the resource is publicly accessible to non-authenticated users.

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

Response

application/json

Details about a snippet in a portal.

PortalSnippetResponse

Details about a snippet in a portal.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

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

visibilitystringrequired

Whether the resource is publicly accessible to non-authenticated users.

Allowed values:publicprivate

Example:public

statusstringrequired

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

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

patch/portals/{portalId}/snippets/{snippetId}

Body

{ "title": "About Us", "name": "about-us", "content": "Welcome to the About Us page. This is where you can learn about our company." }
 
application/json

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