API docs by Redocly

Portal API (2.1.0)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

Portal API

Application Analytics

The API for querying Application Analytics. Application Analytics is only available for private portals.

Query Application Analytics

Query

Authorizations:
portalAccessToken
Request Body schema: application/json

Object describing the query sent to analytics API.

start_ms
required
integer

Unix timestamp in milliseconds specifying the lower bound to return data for the query, inclusive.

end_ms
required
integer

Unix timestamp in milliseconds specifying upper bound to return data for the query, inclusive.

metrics
required
Array of strings = 1 items
Items Enum: "REQUEST_COUNT" "REQUEST_PER_MINUTE" "RESPONSE_LATENCY_P99" "RESPONSE_LATENCY_P95" "RESPONSE_LATENCY_P50" "RESPONSE_SIZE_P99" "RESPONSE_SIZE_P95" "RESPONSE_SIZE_P50" "REQUEST_SIZE_P99" "REQUEST_SIZE_P95" "REQUEST_SIZE_P50"

A property of your API (such as request count or latency) that you wish to query on. Your chosen metric is aggregated within the specified dimensions, meaning that if you query 'request count by application', you'll receive the total number of requests each application received within the given time frame. Some metrics, such as latency and response size, have more complicated aggregations: selecting P99 will result in the 99th percentile of the chosen metric.

dimensions
Array of strings [ 0 .. 2 ] items
Default: []
Items Enum: "API_PRODUCT_VERSION" "APPLICATION" "STATUS_CODE" "STATUS_CODE_GROUPED" "TIME"

The dimensions for the query. A query may have up to 2 dimensions, including time. If no dimensions are provided, the report will simply return the provided metric aggregated across all available data.

granularity_ms
integer
Default: 86400000

granularity_ms is only valid for queries that include a time dimension, and it specifies the time buckets in for the returned data.

Array of any
Default: []

Responses

Request samples

Content type
application/json
Example
{
  • "start_ms": 1691158080000,
  • "end_ms": 1691158980000,
  • "metrics": [
    ],
  • "filter": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "meta": {
    },
  • "records": [
    ]
}

Application Analytics Config

Get config for application analytics

Authorizations:
portalAccessToken

Responses

Response samples

Content type
application/json
Example
{
  • "analytics": null
}

applications

The API for Konnect Portal developer applications within a private portal (i.e. requires registration/authentication). When a portal is in public mode, all of the described endpoints will return a 404 error. A public portal means that applications and registrations are not available/needed. In this API's context, "you" and "your" refers to the developer consuming the API.

List Applications

List applications owned by the developer currently logged in.

Authorizations:
portalAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

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

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

filter[name][eq]
string
Example: filter[name][eq]=good service

Filter by direct equality comparison of the name property with a supplied value.

filter[name]
string
Example: filter[name]=good service

Filter by direct equality comparison (short-hand) of the name property with a supplied value.

filter[name][contains]
string
Example: filter[name][contains]=good service

Filter by contains comparison of the name property with a supplied substring

filter[auth_strategy_id][eq]
string
Example: filter[auth_strategy_id][eq]=5be86298-147b-45ab-bfaf-a1bff97dce39

Filter by the id of the auth strategy supported by the application.

filter[auth_strategy_id]
string
Example: filter[auth_strategy_id]=5be86298-147b-45ab-bfaf-a1bff97dce39

Filter by the id of the auth strategy supported by the application (short-hand).

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create an Application

Creates a new Application.

Authorizations:
portalAccessToken
Request Body schema: application/json

Create an application

name
required
string <= 255 characters

The name of the application

reference_id
string (ApplicationReferenceId) <= 255 characters

An identifier to correlate the application with an external system. Cannot be set when using Dynamic Client Registration.

redirect_uri
string <uri>

URL to redirect to after completing an OIDC auth flow

description
string <= 255 characters

A brief description of the application

auth_strategy_id
string or null <uuid> (AuthStrategyId)

ID of the auth strategy to use for the application. If null or not included, the default application auth strategy will be used.

scopes
Array of strings (Scopes)

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

The granted scopes for the application. Will only be included if supported by the application's auth strategy.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "reference_id": "string",
  • "redirect_uri": "http://example.com",
  • "description": "string",
  • "auth_strategy_id": "e5dd1b68-9505-4524-a9e0-e088d563e7e6",
  • "scopes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "string",
  • "reference_id": "string",
  • "description": "string",
  • "redirect_uri": "string",
  • "credentials": {
    },
  • "auth_strategy": {
    },
  • "scopes": [
    ],
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Get an Application

Gets the details for an existing application. You need only supply the unique application identifier that was returned upon application creation or by the list-applications endpoint.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

Responses

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "string",
  • "reference_id": "string",
  • "description": "string",
  • "redirect_uri": "string",
  • "auth_strategy": {
    },
  • "scopes": [
    ],
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete Application

Deletes an application and all of its associated entities (registrations).

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

Responses

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "instance": "konnect:trace:8988732526256293040",
  • "detail": "The provided token is invalid",
  • "invalid_parameters": [
    ]
}

Update Application

Updates an application, replacing specified properties with any new values supplied in the request body.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

Request Body schema: application/json

Update an application

name
string <= 255 characters

The name of the application

reference_id
string (ApplicationReferenceId) <= 255 characters

An identifier to correlate the application with an external system. Cannot be set when using Dynamic Client Registration.

redirect_uri
string <uri>

URL to redirect to after completing an OIDC auth flow

description
string <= 255 characters

A brief description of the application

scopes
Array of strings (Scopes)

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

The granted scopes for the application. Will only be included if supported by the application's auth strategy.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "reference_id": "string",
  • "redirect_uri": "http://example.com",
  • "description": "string",
  • "scopes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "string",
  • "reference_id": "string",
  • "description": "A brief description of the application",
  • "redirect_uri": "https://example.com/callback",
  • "auth_strategy": {
    },
  • "scopes": [
    ],
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Get the granted scopes

Retrieves the granted scopes of a specified application and product version directly from the IDP. Scopes shared between product versions will be returned, even if not currently registered for given product version. Will return 422 if this feature is not supported by the application.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

productVersionId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

Content type
application/json
{
  • "scopes": [
    ]
}

List the available auth strategies

Retrieve the available Auth Strategies on this portal. An Auth Strategy is a set of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version. It may reference to Key-Auth or an OIDC configuration (with or without DCR).

Authorizations:
portalAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

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

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

filter[name][eq]
string
Example: filter[name][eq]=good service

Filter by direct equality comparison of the name property with a supplied value.

filter[name]
string
Example: filter[name]=good service

Filter by direct equality comparison (short-hand) of the name property with a supplied value.

filter[name][contains]
string
Example: filter[name][contains]=good service

Filter by contains comparison of the name property with a supplied substring

filter[credential_type][eq]
string
Enum: "client_credentials" "self_managed_client_credentials" "key_auth"
Example: filter[credential_type][eq]=key_auth

Filter by direct equality comparison of the credential_type with a supplied value.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

credentials

The API for Konnect Portal developer credentials within a private portal (i.e. requires registration/authentication).

List credentials

Lists the credentials for an application they own.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

query Parameters
page[size]
integer
Example: page[size]=10

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

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create Credential for Application

Allows a developer to create a credential for an application they own.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

Request Body schema: application/json

Create a credential

display_name
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "display_name": "string"
}

Response samples

Content type
application/json
{
  • "credential": "string",
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "display_name": "string"
}

Update Credential

Updates a credential for an application owned by the current logged in developer.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

credentialId
required
string <uuid>

Id of the targeted credential

Request Body schema: application/json

Update a credential

display_name
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "display_name": "string"
}

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "instance": "konnect:trace:8988732526256293040",
  • "detail": "The provided token is invalid",
  • "invalid_parameters": [
    ]
}

Delete Credential

Deletes a credential for an application they own.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

credentialId
required
string <uuid>

Id of the targeted credential

Responses

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "instance": "konnect:trace:8988732526256293040",
  • "detail": "The provided token is invalid",
  • "invalid_parameters": [
    ]
}

Refresh Client Secret

Resets the client secret for an application.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

Responses

Response samples

Content type
application/json
{
  • "client_id": "string",
  • "client_secret": "string"
}

developer

API for managing a Konnect Portal Developer.

Register

Register to the developer portal.

Authorizations:
None
Request Body schema: application/json

Developer registration

email
required
string <email>
full_name
required
string [ 1 .. 256 ] characters
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "email": "dev@company.com",
  • "full_name": "Dev Smith"
}

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "instance": "konnect:trace:8988732526256293040",
  • "detail": "The provided token is invalid",
  • "invalid_parameters": [
    ]
}

Authenticate

This endpoint allows a developer to authenticate to their portal using a username and password.

Request Body schema: application/json

The request schema for the authenticate endpoint.

username
required
string <email>
password
required
string <password>

Responses

Request samples

Content type
application/json
{
  • "username": "developer@example.com",
  • "password": "<!N0taP@$$w0rd!>"
}

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "instance": "konnect:trace:8988732526256293040",
  • "detail": "The provided token is invalid",
  • "invalid_parameters": [
    ]
}

Authenticate SSO

This endpoint allows a developer to authenticate to their portal using an external IdP.

Responses

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "instance": "konnect:trace:8988732526256293040",
  • "detail": "The provided token is invalid",
  • "invalid_parameters": [
    ]
}

Forgot Password

Starts the password reset flow for the desired account. An email will be sent to the email address to initiate the password reset flow.

Authorizations:
None
Request Body schema: application/json

Developer registration

email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "email": "developer@konghq.com"
}

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "instance": "konnect:trace:8988732526256293040",
  • "detail": "The provided token is invalid",
  • "invalid_parameters": [
    ]
}

Logout

This endpoint allows a developer to logout of the portal. This operation revokes all active tokens and clears the portal cookies.

Responses

Retrieve My Account

Returns info about the current developer.

Authorizations:
portalAccessToken

Responses

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "email": "developer@email.com",
  • "full_name": "API Developer",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Refresh Access Token

This endpoint allows a developer to refresh their existing access token.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "Unauthorized",
  • "invalid_parameters": [ ]
}

Reset Password

This endpoint allows a developer to reset their password, using a reset token.

Request Body schema: application/json

The request schema for the reset password endpoint.

password
required
string <password>
token
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "password": "<!D3finitelyN0taP@$$w0rd!>",
  • "token": "c8efd006-d8e1-4743-b91b-f163b9eae06a"
}

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "instance": "konnect:trace:8988732526256293040",
  • "detail": "The provided token is invalid",
  • "invalid_parameters": [
    ]
}

Verify Email

This endpoint allows a new developer to verify their email.

Request Body schema: application/json

The request schema for the verify email endpoint.

token
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "token": "c8efd006-d8e1-4743-b91b-f163b9eae06a"
}

Response samples

Content type
application/json
{
  • "email": "developer@example.com",
  • "token": "c8efd006-d8e1-4743-b91b-f163b9eae06a"
}

portal

The API for retrieving details about a single Konnect Portal.

Get portal context

Return the portal context object.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "portal_id": "18a9b697-7e68-411b-8e1d-102b261ab18e",
  • "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  • "featureset_id": "string",
  • "feature_set": "string",
  • "basic_auth_enabled": true,
  • "oidc_auth_enabled": true,
  • "is_public": true,
  • "rbac_enabled": true,
  • "dcr_provider_ids": [
    ],
  • "allowed_time_period": "string",
  • "name": "string",
  • "canonical_domain": "string"
}

Portal Appearance Details

Gets appearance configuration object for the portal. This object is set in Konnect.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "variables": {
    },
  • "stylesheets": {
    }
}

Portal Catalog Cover Banner

Gets cover banner for the developer portal. This object is set in Konnect.

Authorizations:
None

Responses

products

The API for Konnect Portal Products.

List Products

Returns a paginated list of published API Products.

Authorizations:
portalAccessTokenNone
query Parameters
page[size]
integer
Example: page[size]=10

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

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

filter[name][eq]
string
Example: filter[name][eq]=good service

Filter by direct equality comparison of the name property with a supplied value.

filter[name]
string
Example: filter[name]=good service

Filter by direct equality comparison (short-hand) of the name property with a supplied value.

filter[name][contains]
string
Example: filter[name][contains]=good service

Filter by contains comparison of the name property with a supplied substring

filter[description][eq]
string
Example: filter[description][eq]=portal

Filter by direct equality comparison of the description property with a supplied value.

filter[description]
string
Example: filter[description]=portal

Filter by direct equality comparison (short-hand) of the description property with a supplied value.

filter[description][contains]
string
Example: filter[description][contains]=portal

Filter by contains comparison of the description property with a supplied substring

filter[id][eq]
string
Example: filter[id][eq]=5be86298-147b-45ab-bfaf-a1bff97dce39

Filter by direct equality comparison of the id property with a supplied value.

filter[id]
string
Example: filter[id]=5be86298-147b-45ab-bfaf-a1bff97dce39

Filter by direct equality comparison (short-hand) of the id property with a supplied value.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Get a product

Gets the details for an existing published product.

Authorizations:
portalAccessTokenNone
path Parameters
productId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "name": "Billing",
  • "description": "API for billing functions",
  • "document_count": 3,
  • "version_count": 2,
  • "latest_version": {
    },
  • "public_labels": {
    }
}

Get Product Actions

Get a list of actions that the current developer is allowed to perform on an API product.

path Parameters
productId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

Content type
application/json
{
  • "actions": {
    }
}

versions

The API for Konnect Portal Product Versions.

Get page of product versions

Returns paginated list of versions of a given product.

Authorizations:
portalAccessTokenNone
path Parameters
productId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

query Parameters
page[size]
integer
Example: page[size]=10

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

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

filter[name][eq]
string
Example: filter[name][eq]=good service

Filter by direct equality comparison of the name property with a supplied value.

filter[name]
string
Example: filter[name]=good service

Filter by direct equality comparison (short-hand) of the name property with a supplied value.

filter[name][contains]
string
Example: filter[name][contains]=good service

Filter by contains comparison of the name property with a supplied substring

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Get product version

Gets the details for an existing product version.

Authorizations:
portalAccessTokenNone
path Parameters
productId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

productVersionId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "name": "v2.0.0",
  • "deprecated": true,
  • "registration_configs": [
    ]
}

Get applications by product version

Get applications that have a registration for a given product version. Any registration for the version will count, regardless of status (i.e. even if it is pending, rejected, or revoked). Use the unregistered query param to return the inverse, only including applicatons that do not have a registration (regardless of status).

Authorizations:
portalAccessToken
path Parameters
productId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

productVersionId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

query Parameters
page[size]
integer
Example: page[size]=10

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

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

filter[name][eq]
string
Example: filter[name][eq]=good service

Filter by direct equality comparison of the name property with a supplied value.

filter[name]
string
Example: filter[name]=good service

Filter by direct equality comparison (short-hand) of the name property with a supplied value.

filter[name][contains]
string
Example: filter[name][contains]=good service

Filter by contains comparison of the name property with a supplied substring

filter[status][eq]
string
Enum: "approved" "pending" "rejected" "revoked"
Example: filter[status][eq]=approved

Filter by direct equality comparison of the status property with a supplied value.

filter[status]
string
Enum: "approved" "pending" "rejected" "revoked"
Example: filter[status]=approved

Filter by direct equality comparison (short-hand) of the status property with a supplied value.

filter[auth_strategy_id][eq]
string
Example: filter[auth_strategy_id][eq]=5be86298-147b-45ab-bfaf-a1bff97dce39

Filter by the id of the auth strategy supported by the application.

filter[auth_strategy_id]
string
Example: filter[auth_strategy_id]=5be86298-147b-45ab-bfaf-a1bff97dce39

Filter by the id of the auth strategy supported by the application (short-hand).

unregistered
boolean

Return applications that do not have a registration for the product version (regardless of registration status).

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Get spec for product version

Returns the API specification document attached to given product version. Currently only OpenAPI is supported.

Authorizations:
portalAccessTokenNone
path Parameters
productId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

productVersionId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

Content type
application/json
{
  • "api_type": "openapi",
  • "content": "string"
}

Get operations in version spec

Returns list of operations used in the API specification document attached to given product version.

Authorizations:
portalAccessTokenNone
path Parameters
productId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

productVersionId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

Content type
application/json
{
  • "api_type": "openapi",
  • "operations": [
    ]
}

documentation

The API for Konnect Portal API Documentation.

List product documents

Returns a list of documents that are associated with a given product. The list is paginated, and is in either a list or tree format (based on the Accept header).

Authorizations:
portalAccessTokenNone
path Parameters
productId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

query Parameters
page[size]
integer
Example: page[size]=10

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

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

header Parameters
Accept
string (DocumentContentTypeEnum)
Default: application/json
Enum: "application/json" "application/vnd.konnect.document-tree+json"

Responses

Response samples

Content type
{
  • "meta": {
    },
  • "data": [
    ]
}

Get one product document

Returns the specified document from the product's document tree.

Authorizations:
portalAccessTokenNone
path Parameters
productId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

documentId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the document.

header Parameters
Accept
string (DocumentFormatContentTypeEnum)
Default: application/json
Enum: "text/markdown" "application/json" "application/vnd.konnect.document-nodes+json"

Responses

Response samples

Content type
{
  • "id": "string",
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "slug": "getting-started",
  • "content": "# My Kong api\n\nThis api is powered by Konnect\n",
  • "title": "Hello World"
}

registrations

The API for Konnect Portal application registrations. If the portal is public all of the described endpoints will return a 404 error

Get application registrations

Lists product registrations for an application.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

query Parameters
page[size]
integer
Example: page[size]=10

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

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

filter[id][eq]
string
Example: filter[id][eq]=5be86298-147b-45ab-bfaf-a1bff97dce39

Filter by direct equality comparison of the id property with a supplied value.

filter[id]
string
Example: filter[id]=5be86298-147b-45ab-bfaf-a1bff97dce39

Filter by direct equality comparison (short-hand) of the id property with a supplied value.

filter[status][eq]
string
Enum: "approved" "pending" "rejected" "revoked"
Example: filter[status][eq]=approved

Filter by direct equality comparison of the status property with a supplied value.

filter[status]
string
Enum: "approved" "pending" "rejected" "revoked"
Example: filter[status]=approved

Filter by direct equality comparison (short-hand) of the status property with a supplied value.

filter[product_name][eq]
string
Example: filter[product_name][eq]=good service

Filter by direct equality comparison of the product_name property with a supplied value.

filter[product_name]
string
Example: filter[product_name]=good service

Filter by direct equality comparison (short-hand) of the product_name property with a supplied value.

filter[product_version_name][eq]
string
Example: filter[product_version_name][eq]=good service

Filter by direct equality comparison of the product_version_name property with a supplied value.

filter[product_version_name]
string
Example: filter[product_version_name]=good service

Filter by direct equality comparison (short-hand) of the product_version_name property with a supplied value.

filter[product_version_name][contains]
string
Example: filter[product_version_name][contains]=good service

Filter by contains comparison of the product_version_name property with a supplied substring

filter[product_name][contains]
string
Example: filter[product_name][contains]=good service

Filter by contains comparison of the product_name property with a supplied substring

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Register an application for a product

Registers an application for a product.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

Request Body schema: application/json

Create an application registration.

product_version_id
required
string <uuid>

The product version id required for registration.

scopes
Array of strings

The requested scopes for the registration, requires developer_managed_scopes to be enabled.

Responses

Request samples

Content type
application/json
{
  • "product_version_id": "8bb4c6a0-a679-47fe-8af0-8454849ab62d",
  • "scopes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "status": "approved",
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "product_name": "string",
  • "product_version_id": "8bb4c6a0-a679-47fe-8af0-8454849ab62d",
  • "product_version_name": "string",
  • "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",
  • "granted_scopes": [
    ]
}

Get an application registration

Retrieves the specified product registration for an application.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

registrationId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "status": "approved",
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "product_name": "string",
  • "product_version_id": "8bb4c6a0-a679-47fe-8af0-8454849ab62d",
  • "product_version_name": "string",
  • "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",
  • "granted_scopes": [
    ]
}

Delete an application registration

Unregister an application for a product version.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

registrationId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

Content type
application/problem+json
Example
{
  • "status": 401,
  • "title": "Unauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "Unauthorized",
  • "invalid_parameters": [ ]
}

Get the granted scopes of an application registration

Retrieves the granted scopes of a specified product registration directly from the IDP for an application. Will return 409 if this feature is not supported by the application.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

registrationId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

Content type
application/json
{
  • "scopes": [
    ]
}

search

The API for Konnect Portal Search.

Search Portal Entities

Returns paginated search results from the specified entities with the given search parameters.

Authorizations:
portalAccessTokenNone
path Parameters
indices
required
string (SearchIndicesParameters)
Value: "product-catalog"

Determines which entity sets to search

query Parameters
q
string (SearchQueryParameters)

Determines how to filter search results

join
string (SearchJoinParameters)
Example: join=versions,versions.documents

Determines which sub-entities to include in search results

page[size]
integer
Example: page[size]=10

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

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}