API docs by Redocly

Portal Management V3 (3.0.10)

Download OpenAPI specification:Download

URL: https://konghq.com

The management API for Portals

Portals

APIs related to configuration of Konnect Developer Portals.

List Portals

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

Lists developer portals defined in this region for this organization. Each developer portal is available at a unique address and has isolated configuration, customization, developers, and applications.

Authorizations:
personalAccessTokensystemAccountAccessToken
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.

sort
string

Sorts a collection of portals. Supported sort attributes are:

  • name
  • description
  • authentication_enabled
  • rbac_enabled
  • auto_approve_applications
  • auto_approve_developers
  • default_domain
  • canonical_domain
  • created_at
  • updated_at
object (PortalFilterParameters)

Filter portals returned in the response.

Responses

Response samples

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

Create Portal

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

Creates a new developer portal scoped in this region for this organization.

Authorizations:
personalAccessTokensystemAccountAccessToken
Request Body schema: application/json

Create a portal.

name
required
string [ 1 .. 255 ] characters

The name of the portal, used to distinguish it from other portals. Name must be unique.

display_name
string [ 1 .. 255 ] characters

The display name of the portal. This value will be the portal's name in Portal API.

description
string or null <= 512 characters

A description of the portal.

authentication_enabled
boolean
Default: true

Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications.

rbac_enabled
boolean
Default: false

Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC.

default_api_visibility
string
Enum: "public" "private"

The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers.

default_page_visibility
string
Enum: "public" "private"

The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers.

default_application_auth_strategy_id
string or null <uuid>

The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication. DCR support for Auth Strategies is currently in development.

auto_approve_developers
boolean
Default: false

Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

auto_approve_applications
boolean
Default: false

Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin.

object or null (LabelsUpdate) <= 50 properties

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 "_".

Responses

Request samples

Content type
application/json
Example
{
  • "name": "MyDevPortal",
  • "authentication_enabled": true,
  • "rbac_enabled": true,
  • "auto_approve_applications": false,
  • "auto_approve_developers": false
}

Response samples

Content type
application/json
{
  • "id": "9f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-10-08T17:00:00.52Z",
  • "name": "Portal A",
  • "display_name": "Developer Portal A",
  • "description": "The Portal A",
  • "default_domain": "123455678abcd.us.portal.konghq.com",
  • "authentication_enabled": false,
  • "rbac_enabled": true,
  • "default_api_visibility": "private",
  • "default_page_visibility": "private",
  • "default_application_auth_strategy_id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "auto_approve_applications": false,
  • "auto_approve_developers": true,
  • "canonical_domain": "api.example.com"
}

Fetch Portal

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

Returns the configuration for a single developer portal, including the current visibility, access, and domain settings.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "id": "9f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-10-08T17:00:00.52Z",
  • "name": "Portal A",
  • "display_name": "Developer Portal A",
  • "description": "The Portal A",
  • "default_domain": "123455678abcd.us.portal.konghq.com",
  • "authentication_enabled": false,
  • "rbac_enabled": true,
  • "default_api_visibility": "private",
  • "default_page_visibility": "private",
  • "default_application_auth_strategy_id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "auto_approve_applications": false,
  • "auto_approve_developers": true,
  • "canonical_domain": "api.example.com"
}

Update Portal

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

Updates the configuration for a single portal including the visibility, access, and custom domain settings.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json

Update a portal's settings.

name
string [ 1 .. 255 ] characters

The name of the portal, used to distinguish it from other portals. Name must be unique.

display_name
string [ 1 .. 255 ] characters

The display name of the portal. This value will be the portal's name in Portal API.

description
string or null <= 512 characters

A description of the portal.

authentication_enabled
boolean
Default: true

Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications.

rbac_enabled
boolean
Default: false

Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC.

default_api_visibility
string
Enum: "public" "private"

The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers.

default_page_visibility
string
Enum: "public" "private"

The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers.

default_application_auth_strategy_id
string or null <uuid>

The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication. DCR support for Auth Strategies is currently in development.

auto_approve_developers
boolean
Default: false

Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

auto_approve_applications
boolean
Default: false

Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin.

object or null (LabelsUpdate) <= 50 properties

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 "_".

Responses

Request samples

Content type
application/json
Example
{
  • "authentication_enabled": false,
  • "rbac_enabled": false,
  • "auto_approve_applications": false,
  • "auto_approve_developers": false
}

Response samples

Content type
application/json
{
  • "id": "9f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-10-08T17:00:00.52Z",
  • "name": "Portal A",
  • "display_name": "Developer Portal A",
  • "description": "The Portal A",
  • "default_domain": "123455678abcd.us.portal.konghq.com",
  • "authentication_enabled": false,
  • "rbac_enabled": true,
  • "default_api_visibility": "private",
  • "default_page_visibility": "private",
  • "default_application_auth_strategy_id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "auto_approve_applications": false,
  • "auto_approve_developers": true,
  • "canonical_domain": "api.example.com"
}

Delete Portal

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

Deletes a single portal, along with all related entities.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

query Parameters
force
string
Default: "false"
Enum: "true" "false"

If true, the portal will be deleted, automatically deleting all API publications. If the force param is not set, the deletion will only succeed if there are no APIs currently published.

Responses

Response samples

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

Portal Custom Domains

APIs related to configuration of Konnect Developer Portals custom domains.

Get Custom Domain

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

Get the custom domain associated to the portal.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "hostname": "string",
  • "enabled": true,
  • "ssl": {
    },
  • "cname_status": "verified",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Create Custom Domain

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

Creates the custom domain associated with the portal. Only one custom domain can be associated with a portal at a time.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json

Create a portal custom domain.

hostname
required
string
enabled
required
boolean
required
object (CreatePortalCustomDomainSSL)

Responses

Request samples

Content type
application/json
{
  • "hostname": "string",
  • "enabled": true,
  • "ssl": {
    }
}

Response samples

Content type
application/json
{
  • "hostname": "string",
  • "enabled": true,
  • "ssl": {
    },
  • "cname_status": "verified",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Enable or Disable Domain

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

Updates the portal domain associated with the portal.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json

Create a portal custom domain.

enabled
boolean
custom_certificate
string

Custom certificate to be used for the SSL termination.

custom_private_key
string

Custom certificate private key to be used for the SSL termination.

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "custom_certificate": "string",
  • "custom_private_key": "string"
}

Response samples

Content type
application/json
{
  • "hostname": "string",
  • "enabled": true,
  • "ssl": {
    },
  • "cname_status": "verified",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Remove Domain

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

Deletes the custom domain associated with the portal.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "title": "Not Found",
  • "instance": "kong:trace:6816496025408232265",
  • "detail": "Not Found"
}

Portal Customization

APIs related to customization of Konnect Developer Portals.

Get Customization

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

Returns the portal customization options.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "theme": {
    },
  • "layout": "string",
  • "css": "string",
  • "js": {
    },
  • "menu": {
    },
  • "spec_renderer": {
    },
  • "robots": "string"
}

Replace Customization

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

Replace the portal customization options.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json
object
layout
string
css
string or null
object
object
object
robots
string or null

Responses

Request samples

Content type
application/json
{
  • "theme": {
    },
  • "layout": "string",
  • "css": "string",
  • "js": {
    },
  • "menu": {
    },
  • "spec_renderer": {
    },
  • "robots": "string"
}

Response samples

Content type
application/json
{
  • "theme": {
    },
  • "layout": "string",
  • "css": "string",
  • "js": {
    },
  • "menu": {
    },
  • "spec_renderer": {
    },
  • "robots": "string"
}

Update Customization

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

Update the portal customization options, merging properties.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json
object
layout
string
css
string or null
object
object
object
robots
string or null

Responses

Request samples

Content type
application/json
{
  • "theme": {
    },
  • "layout": "string",
  • "css": "string",
  • "js": {
    },
  • "menu": {
    },
  • "spec_renderer": {
    },
  • "robots": "string"
}

Response samples

Content type
application/json
{
  • "theme": {
    },
  • "layout": "string",
  • "css": "string",
  • "js": {
    },
  • "menu": {
    },
  • "spec_renderer": {
    },
  • "robots": "string"
}

Portal Auth Settings

APIs related to configuration of Konnect Developer Portal auth settings.

Get Auth Settings

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

Returns the developer authentication configuration for a portal, which determines how developers can log in and how they are assigned to teams.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "basic_auth_enabled": true,
  • "oidc_auth_enabled": true,
  • "saml_auth_enabled": true,
  • "oidc_team_mapping_enabled": true,
  • "konnect_mapping_enabled": true,
  • "idp_mapping_enabled": true,
  • "oidc_config": {
    }
}

Update Auth Settings

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

Updates the developer authentication configuration for a portal. Developers can be allowed to login using basic auth (email & password) or use Single-Sign-On (SSO) through an OIDC Identity Provider (IdP). Developers can be automatically assigned to teams by mapping claims from thier IdP account.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json

Update a portal's developer authentication settings.

basic_auth_enabled
boolean

The organization has basic auth enabled.

oidc_auth_enabled
boolean

The organization has OIDC disabled.

saml_auth_enabled
boolean

The portal has SAML enabled or disabled.

oidc_team_mapping_enabled
boolean

Whether IdP groups determine the Konnect Portal teams a developer has.

konnect_mapping_enabled
boolean

Whether a Konnect Identity Admin assigns teams to a developer.

idp_mapping_enabled
boolean

Whether IdP groups determine the Konnect Portal teams a developer has. This will soon replace oidc_team_mapping_enabled.

oidc_issuer
string
oidc_client_id
string
oidc_client_secret
string
oidc_scopes
Array of strings
Default: ["email","openid","profile"]
object (PortalClaimMappings) [ 0 .. 3 ] properties

Mappings from a portal developer atribute to an Identity Provider claim.

Responses

Request samples

Content type
application/json
Example
{
  • "basic_auth_enabled": true,
  • "oidc_auth_enabled": true,
  • "saml_auth_enabled": true,
  • "oidc_team_mapping_enabled": true,
  • "konnect_mapping_enabled": false,
  • "idp_mapping_enabled": true,
  • "oidc_issuer": "https://identity.example.com/v2",
  • "oidc_client_id": "x7id0o42lklas0blidl2",
  • "oidc_scopes": [
    ],
  • "oidc_claim_mappings": {
    }
}

Response samples

Content type
application/json
{
  • "basic_auth_enabled": true,
  • "oidc_auth_enabled": true,
  • "saml_auth_enabled": true,
  • "oidc_team_mapping_enabled": true,
  • "konnect_mapping_enabled": true,
  • "idp_mapping_enabled": true,
  • "oidc_config": {
    }
}

List Team Group Mappings

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

Lists mappings between Konnect portal teams and Identity Provider (IdP) groups. Returns a 400 error if an IdP has not yet been configured.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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": [
    ]
}

Update Team Group Mappings

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

Allows partial updates to the mappings between Konnect portal teams and Identity Provider (IdP) groups. The request body must be keyed on team ID. For a given team ID, the given group list is a complete replacement. To remove all mappings for a given team, provide an empty group list. Returns a 400 error if an IdP has not yet been configured, or if a team ID in the request body is not found or is not a UUID.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json
Array of objects

The IdP groups to map to the given team.

Responses

Request samples

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

Response samples

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

Retrieve Identity Providers

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

Retrieves the identity providers available within the portal. This operation provides information about various identity providers for SAML or OIDC authentication integrations.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

query Parameters
object

Filter identity providers returned in the response.

Responses

Response samples

Content type
application/json
[
  • {},
  • {
    }
]

Create Identity Provider

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

Creates a new identity provider. This operation allows the creation of a new identity provider for authentication purposes.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json

An object representing the configuration for creating a new identity provider. This configuration may pertain to either an OIDC or a SAML identity provider.

type
string (IdentityProviderType)
Enum: "oidc" "saml"

Specifies the type of identity provider.

OIDC Identity Provider Config (object) or SAML Identity Provider Config (object)

Responses

Request samples

Content type
application/json
Example
{
  • "type": "oidc",
  • "config": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "66da2d42-469d-48cd-9ff3-0db135dd82d8",
  • "type": "oidc",
  • "enabled": false,
  • "config": {
    },
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-02-07T17:46:57.52Z"
}

Get Identity Provider

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

Retrieves the configuration of a single identity provider. This operation returns information about a specific identity provider's settings and authentication integration details.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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

ID of the identity provider.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "66da2d42-469d-48cd-9ff3-0db135dd82d8",
  • "type": "oidc",
  • "enabled": false,
  • "config": {
    },
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-02-07T17:46:57.52Z"
}

Update Identity Provider

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

Updates the configuration of an existing identity provider. This operation allows modifications to be made to an existing identity provider's configuration.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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

ID of the identity provider.

Request Body schema: application/json

An object representing the configuration for updating an identity provider. This configuration may pertain to either an OIDC or a SAML identity provider.

enabled
boolean (Identity Provider Enabled Property)
Default: false

Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC.

OIDC Identity Provider Config (object) or SAML Identity Provider Config (object)

Responses

Request samples

Content type
application/json
Example
{
  • "enabled": true,
  • "config": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "66da2d42-469d-48cd-9ff3-0db135dd82d8",
  • "type": "oidc",
  • "enabled": false,
  • "config": {
    },
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-02-07T17:46:57.52Z"
}

Delete Identity Provider

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

Deletes an existing identity provider configuration. This operation removes a specific identity provider from the portal.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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

ID of the identity provider.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Portal Developers

APIs related to Konnect Developer Portal developers.

List Developers

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

Lists the developers that have registered for this portal. Each developer can be registered to one portal and must be approved to login unless using the developer auto-approve setting.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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.

sort
string

Sorts a collection of developers. Supported sort attributes are:

  • created_at
  • updated_at
  • email
  • name
  • status
object

Filter developers returned in the response.

Responses

Response samples

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

Fetch Developer

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

Returns information about a single developer in this portal. Each developer manages a set applications, providing them credentials to access registered APIs. Developer registration access can be limited to specific APIs using RBAC.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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

ID of the developer.

Responses

Response samples

Content type
application/json
{
  • "id": "7cd9feff-b4da-4a9f-ba49-cbe83c75ff22",
  • "email": "developer@example.com",
  • "full_name": "Jane Dev",
  • "status": "approved",
  • "application_count": 3,
  • "created_at": "2022-11-15T20:37:41.457Z",
  • "updated_at": "2022-11-15T20:37:47.456Z"
}

Update Developer

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

Updates the status of a particular developer. Approved developers have access to login to the portal. Revoked, rejected, or pending are not allowed to login. Even if a developer's status is no longer approved, they will still be able to using any existing credentials generated while they were approved, until each application registration is revoked or deleted.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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

ID of the developer.

Request Body schema: application/json

Update a developer.

status
string (DeveloperStatus)
Enum: "approved" "pending" "revoked" "rejected"

The status of a developer in a portal. Approved developers can log in, create applications, and view and register for products they have access to. Pending, revoked, and rejected developers cannot login or view any non-public portal information, or create or modify applications or registrations.

Responses

Request samples

Content type
application/json
Example
{
  • "status": "approved"
}

Response samples

Content type
application/json
{
  • "id": "7cd9feff-b4da-4a9f-ba49-cbe83c75ff22",
  • "email": "developer@example.com",
  • "full_name": "Jane Dev",
  • "status": "approved",
  • "application_count": 3,
  • "created_at": "2022-11-15T20:37:41.457Z",
  • "updated_at": "2022-11-15T20:37:47.456Z"
}

Delete Developer

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

Deletes a developer, which will discontinue their ability to login, view any non-public resources, and delete all applications owned by them. All credentials issued to the developer will no longer provide access to any APIs. A deleted developer's unique email must be re-registered and approved to gain access again.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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

ID of the developer.

Responses

Response samples

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

Portal Teams

APIs related to configuration of Konnect Developer Portal developer teams.

List Teams

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

Lists the developer teams in a portal. Each team can contain any developer and developers can be part of multiple teams.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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.

object

Filter teams returned in the response.

Responses

Response samples

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

Create Team

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

Creates a developer team in a portal. Developers can be added to teams to provide RBAC access to API products. Teams can be assigned roles that grant permissions to perform an action on a resource.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json

Create a team in a portal.

name
required
string^[\w \W]+$
description
string <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "name": "IDM - Developers",
  • "description": "The Identity Management (IDM) API team."
}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "Gold Tier",
  • "description": "Team with access to APIs in the Gold tier",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-09-25T13:00:00.00Z"
}

Get Team

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

Get an individual team.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
teamId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the team.

portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "Gold Tier",
  • "description": "Team with access to APIs in the Gold tier",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-09-25T13:00:00.00Z"
}

Update Team

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

Updates an individual developer team for a portal.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
teamId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the team.

portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json

Update a team in a portal.

name
string^[\w \W]+$
description
string <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "name": "IDM - Developers",
  • "description": "The Identity Management (IDM) API team."
}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "Gold Tier",
  • "description": "Team with access to APIs in the Gold tier",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-09-25T13:00:00.00Z"
}

Delete Team

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

Deletes a developer team from a portal. Deleting a team also deletes its assigned roles. Members of the team are not deleted, but they will lose any access provided through the team.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
teamId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the team.

portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

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

Portal Team Membership

APIs related to Konnect Developer Portal developer team membership.

List Team Developers

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

List a team's developers.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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

ID of the team.

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.

object

Filter developers returned in the response.

Responses

Response samples

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

Add Developer to Team

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

Adds a developer to a team. This associates them with all of the roles that have been assigned to the team, providing specific permissions to perform actions on resources.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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

ID of the team.

Request Body schema: application/json

Add a developer to a team.

id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "df120cb4-f60b-47bc-a2f8-6a28e6a3c63b"
}

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Invalid Request",
  • "instance": "kong:trace:1433447772874964729",
  • "detail": "Invalid Parameters",
  • "invalid_parameters": [
    ]
}

Remove Developer from Team

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

Removes a developer from a team. This removes the association of the team's roles from the developer.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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

ID of the developer.

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

ID of the team.

Responses

Response samples

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

List Developer Teams

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

Lists the teams to which a developer belongs. Each team a developer is a member of grants them various roles that provide permissions to perform actions on certain resources.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
developerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the developer.

portalId
required
string <uuid>

ID of the portal.

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": [
    ]
}

Portal Team Roles

APIs related to Konnect Developer Portal developer team roles.

List Team Roles

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

Lists the roles belonging to a developer team. Each role provides permissions to perform actions on a specified resource or collection.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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

ID of the team.

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": [
    ]
}

Assign Role

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

Assign a role to a developer team. This associates the set of permissions in a role with the team, so that they will be applied to any developer who is a member of the team.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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

ID of the team.

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.

Request Body schema: application/json

Assign a role to a team.

role_name
string
entity_id
string <uuid>
entity_type_name
string
entity_region
string
Enum: "us" "eu" "au" "me" "in" "*"

Region of the entity.

Responses

Request samples

Content type
application/json
Example
{
  • "role_name": "API Viewer",
  • "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
  • "entity_type_name": "Services",
  • "entity_region": "us"
}

Response samples

Content type
application/json
Example
{
  • "id": "1a3c2169-27f8-4594-926b-41df3432d5dc",
  • "role_name": "API Viewer",
  • "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
  • "entity_type_name": "Services",
  • "entity_region": "us"
}

Remove Role

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

Removes an assigned role from a developer team. This deletes the association of the role with team and each of its members.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
roleId
required
string <uuid>
Example: 8350205f-a305-4e39-abe9-bc082a80091a
portalId
required
string <uuid>

ID of the portal.

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

ID of the team.

Responses

Response samples

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

List Portal Roles

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

List roles that can be assigned to teams in a portal. Each role provides a set of permissions to perform an action on a resource.

Authorizations:
personalAccessTokensystemAccountAccessToken

Responses

Response samples

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

Assets

APIs for managing static assets for Konnect Developer Portals.

Get Favicon

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

Returns the favicon of the portal.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

Content type
data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=

Replace Favicon

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

Replaces the favicon of the portal. The favicon is used in the browser tab of the portal.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json

Update an image asset for the portal.

data
required
string <uri> (PortalImageDataUri) ^data:image/(png|jpeg|svg\+xml|x-icon|ico|ico...

must be a data URL with base64 image data, e.g., data:image/jpeg;base64,

filename
string <= 512 characters

Responses

Request samples

Content type
application/json
{
  • "data": "data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=",
  • "filename": "logo.png"
}

Response samples

Content type
data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=

Pages

APIs related to Konnect Developer Portal Custom Pages.

List Pages

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

Returns the paginated list of custom pages that have been created for this portal.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

query Parameters
sort
string

Sorts a collection of portal pages. Supported sort attributes are:

  • created_at
  • updated_at
  • slug
  • title
  • visibility
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.

object (PortalPagesFilterParameters)

Filter pages returned in the response.

Responses

Response samples

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

Create Page

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

Creates a new custom page for this portal. Custom pages can be used to display static content, documentation, or other information to developers.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json

Create a page in a portal.

slug
required
string (PageSlug) <= 512 characters

The slug of a page in a portal. Is used to compute the full path /slug1/slug2/slug3.

title
required
string (PageTitle) <= 512 characters

The title of a page in a portal.

content
required
string (PageContent) <= 1000000 characters

The renderable markdown content of a page in a portal.

visibility
string (PageVisibilityStatusWithDefault)
Default: "private"

Whether a page is publicly accessible to non-authenticated users.

status
string (PublishedStatus)
Enum: "published" "unpublished"

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

description
string (ResourceDescription) <= 160 characters
parent_page_id
string or null <uuid> (ParentPageId)

Pages may be rendered as a tree of files.

Specify the id of another page as the parent_page_id to add some hierarchy to your pages.

Responses

Request samples

Content type
application/json
{
  • "title": "Getting Started",
  • "slug": "/getting-started",
  • "content": "Welcome to the Getting Started page. This is where you can learn how to use our APIs.",
  • "visibility": "public",
  • "status": "published"
}

Response samples

Content type
application/json
{
  • "id": "8f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "slug": "/",
  • "title": "Home",
  • "content": "Welcome to the home page of the portal. This is where you can find information about the portal and its APIs.",
  • "visibility": "public",
  • "status": "published",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-10-08T17:00:00.52Z",
  • "parent_page_id": null
}

Fetch Page

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

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

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

pageId
required
string <uuid>
Example: ebbac5b0-ac89-45c3-9d2e-c4542c657e79

ID of the page.

Responses

Response samples

Content type
application/json
{
  • "id": "8f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "slug": "/",
  • "title": "Home",
  • "content": "Welcome to the home page of the portal. This is where you can find information about the portal and its APIs.",
  • "visibility": "public",
  • "status": "published",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-10-08T17:00:00.52Z",
  • "parent_page_id": null
}

Update Page

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

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

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

pageId
required
string <uuid>
Example: ebbac5b0-ac89-45c3-9d2e-c4542c657e79

ID of the page.

Request Body schema: application/json

Update a page in a portal.

slug
string (PageSlug) <= 512 characters

The slug of a page in a portal. Is used to compute the full path /slug1/slug2/slug3.

title
string (PageTitle) <= 512 characters

The title of a page in a portal.

content
string (PageContent) <= 1000000 characters

The renderable markdown content of a page in a portal.

visibility
string (VisibilityStatus)
Enum: "public" "private"

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

status
string (PublishedStatus)
Enum: "published" "unpublished"

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

description
string (ResourceDescription) <= 160 characters
parent_page_id
string or null <uuid> (ParentPageId)

Pages may be rendered as a tree of files.

Specify the id of another page as the parent_page_id to add some hierarchy to your pages.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "8f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "slug": "/",
  • "title": "Home",
  • "content": "Welcome to the home page of the portal. This is where you can find information about the portal and its APIs.",
  • "visibility": "public",
  • "status": "published",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-10-08T17:00:00.52Z",
  • "parent_page_id": null
}

Delete Page

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

Deletes a single custom page for this portal.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

pageId
required
string <uuid>
Example: ebbac5b0-ac89-45c3-9d2e-c4542c657e79

ID of the page.

Responses

Response samples

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

Move Page

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

This api allows the user to move a page within the page tree using the parameters parent_page_id and index. If parent_page_id is not provided, the page will be placed at the top level of the page tree. index represents a zero-indexed page order relative to its siblings under the same parent. For example, if we want to put the page at top level in first position we would send parent_page_id: null and index: 0. This api also supports using a negative index to count backwards from the end of the page list, which means you can put the page in last position by using index: -1.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

pageId
required
string <uuid>
Example: ebbac5b0-ac89-45c3-9d2e-c4542c657e79

ID of the page.

Request Body schema: application/json

move page

parent_page_id
string <uuid>

parent page id

index
integer

index of the document in the parent document's children

Responses

Request samples

Content type
application/json
{
  • "parent_page_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "index": 1
}

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Creates Default Pages

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

Creates the default pages for a portal if they do not already exists.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

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

Snippets

APIs related to Konnect Developer Portal Custom Snippets.

List Snippets

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

Returns the paginated list of custom snippets that have been created for this portal.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

query Parameters
sort
string

Sorts a collection of portal snippets. Supported sort attributes are:

  • created_at
  • updated_at
  • name
  • title
  • visibility
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.

object (PortalSnippetsFilterParameters)

Filter snippets returned in the response.

Responses

Response samples

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

Create Snippet

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

Creates a new custom snippet for this portal. Custom snippets can be used to display static content, documentation, or other information to developers.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json

Create a snippet in a portal.

name
required
string (SnippetName) <= 512 characters

The unique name of a snippet in a portal.

title
required
string (SnippetTitle) <= 512 characters

The display title of a snippet in a portal.

content
required
string (SnippetContent) <= 1000000 characters

The renderable markdown content of a page in a portal.

visibility
string (PageVisibilityStatusWithDefault)
Default: "private"

Whether a page is publicly accessible to non-authenticated users.

status
string (PublishedStatus)
Enum: "published" "unpublished"

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

description
string (ResourceDescription) <= 160 characters

Responses

Request samples

Content type
application/json
{
  • "title": "Getting Started",
  • "name": "getting-started",
  • "content": "Welcome to the Getting Started page. This is where you can learn how to use our APIs.",
  • "visibility": "public",
  • "status": "published"
}

Response samples

Content type
application/json
{
  • "id": "8f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "snip1",
  • "title": "Home",
  • "content": "Welcome to the first snippet of the portal.",
  • "visibility": "public",
  • "status": "published",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-10-08T17:00:00.52Z"
}

Fetch Snippet

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

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.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

snippetId
required
string <uuid>
Example: ebbac5b0-ac89-45c3-9d2e-c4542c657e79

ID of the snippet.

Responses

Response samples

Content type
application/json
{
  • "id": "8f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "snip1",
  • "title": "Home",
  • "content": "Welcome to the first snippet of the portal.",
  • "visibility": "public",
  • "status": "published",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-10-08T17:00:00.52Z"
}

Update Snippet

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

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

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

snippetId
required
string <uuid>
Example: ebbac5b0-ac89-45c3-9d2e-c4542c657e79

ID of the snippet.

Request Body schema: application/json

Update a snippet in a portal.

name
string (SnippetName) <= 512 characters

The unique name of a snippet in a portal.

title
string (SnippetTitle) <= 512 characters

The display title of a snippet in a portal.

content
string (SnippetContent) <= 1000000 characters

The renderable markdown content of a page in a portal.

visibility
string (VisibilityStatus)
Enum: "public" "private"

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

status
string (PublishedStatus)
Enum: "published" "unpublished"

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

description
string (ResourceDescription) <= 160 characters

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "8f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "snip1",
  • "title": "Home",
  • "content": "Welcome to the first snippet of the portal.",
  • "visibility": "public",
  • "status": "published",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-10-08T17:00:00.52Z"
}

Delete Snippet

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

Deletes a single custom snippet for this portal.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

snippetId
required
string <uuid>
Example: ebbac5b0-ac89-45c3-9d2e-c4542c657e79

ID of the snippet.

Responses

Response samples

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

Applications

APIs related to Konnect Developer Portal Applications.

List Applications

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

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.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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.

sort
string

Sorts a collection of applications. Supported sort attributes are:

  • created_at
  • developer_id
  • name
object

Filter applications returned in the response.

Responses

Response samples

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

Fetch Application by Portal

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

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.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

applicationId
required
string <uuid>

ID of the application.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "b15e2460-ba40-431d-9df0-4957fcffacda",
  • "labels": {
    },
  • "name": "App 1",
  • "description": "An easy to manage app in a Konnect developer portal",
  • "registration_count": 4,
  • "portal": {
    },
  • "auth_strategy": {
    },
  • "developers": [
    ],
  • "created_at": "2022-12-22T19:09:30.712Z",
  • "updated_at": "2022-12-22T19:09:30.712Z"
}

Delete Application by Portal

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

Delete a single application in this portal, along with its registrations and credentials.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

applicationId
required
string <uuid>

ID of the application.

Responses

Response samples

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

List Developers by Application

Lists each developer that can access the given application for this portal.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

applicationId
required
string <uuid>

ID of the 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.

sort
string

Sorts a set of developers for an application. Supported sort attributes are:

  • id
object

Filter application developers returned in the response.

Responses

Response samples

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

Fetch Application

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

Returns the configuration of a single application in any 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.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
applicationId
required
string <uuid>

ID of the application.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "b15e2460-ba40-431d-9df0-4957fcffacda",
  • "labels": {
    },
  • "name": "App 1",
  • "description": "An easy to manage app in a Konnect developer portal",
  • "registration_count": 4,
  • "portal": {
    },
  • "auth_strategy": {
    },
  • "developers": [
    ],
  • "created_at": "2022-12-22T19:09:30.712Z",
  • "updated_at": "2022-12-22T19:09:30.712Z"
}

Application Registrations

APIs related to Konnect Developer Portal Application Registrations.

List Registrations by Portal

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

Lists all of the application registrations and their current status (e.g., approved or pending) for this portal. Each registration is associated with a single API. Access is provided through the credentials issued to the application that contains each registration.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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.

sort
string

Sorts a collection of application registrations. Supported sort attributes are:

  • created_at
  • updated_at
  • developer_id
  • status
object

Filter application registrations returned in the response.

Responses

Response samples

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

List Registrations by Application

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

Lists each API that this application is registered for and their current status (e.g., pending, approved, rejected, revoked).

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

applicationId
required
string <uuid>

ID of the 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.

sort
string

Sorts a set of registrations for an application. Supported sort attributes are:

  • created_at
  • updated_at
  • status
object

Filter application registrations returned in the response.

Responses

Response samples

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

Fetch Registration

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

Returns information about an application's registration status for a particular API.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

applicationId
required
string <uuid>

ID of the application.

registrationId
required
string <uuid>

ID of the application registration.

Responses

Response samples

Content type
application/json
{
  • "id": "c300cc33-2d33-4754-b086-a98e0fcd36fb",
  • "status": "approved",
  • "application": {
    },
  • "api": {
    },
  • "created_at": "2022-12-22T20:13:07.305Z",
  • "updated_at": "2022-12-22T20:13:36.710Z"
}

Update Registration

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

Updates the status of a particular application registration to an API. Approved application registrations will allow API traffic to the corresponding API. Revoked, rejected, or pending will not allow API traffic.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

applicationId
required
string <uuid>

ID of the application.

registrationId
required
string <uuid>

ID of the application registration.

Request Body schema: application/json

Update an application registration.

status
string (ApplicationRegistrationStatus)
Enum: "approved" "pending" "revoked" "rejected"

The status of an application registration request. Each registration is linked to a single API, and application credentials will not grant access to the API until the registration is approved. Pending, revoked, and rejected registrations will not provide access to the API.

Responses

Request samples

Content type
application/json
Example
{
  • "status": "approved"
}

Response samples

Content type
application/json
{
  • "id": "c300cc33-2d33-4754-b086-a98e0fcd36fb",
  • "status": "approved",
  • "application": {
    },
  • "api": {
    },
  • "created_at": "2022-12-22T20:13:07.305Z",
  • "updated_at": "2022-12-22T20:13:36.710Z"
}

Delete Registration

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

Deletes an application registration, which if currently approved will immediately block API traffic to the API. Note: Developers can request a new application registration for the given API as long as they have RBAC access to consume.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

applicationId
required
string <uuid>

ID of the application.

registrationId
required
string <uuid>

ID of the application registration.

Responses

Response samples

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

Application Developers

APIs related to Konnect Developer Portal Application Registrations.

V3 Portal Emails

APIs related to Konnect Developer Portal Emails.

List email domains

List email domains

Authorizations:
personalAccessTokensystemAccountAccessToken
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.

sort
string

Sorts a collection of email domains. Supported sort attributes are:

  • domain
  • created_at
  • updated_at
object (EmailDomainFilterParameters)

Filter email domains returned in the response.

Responses

Response samples

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

Create an email domain

Create an email domain

Authorizations:
personalAccessTokensystemAccountAccessToken
Request Body schema: application/json
domain
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "domain": "string",
  • "verification": {
    },
  • "dns_validation_records": [
    ],
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Get an email domain

Get an email domain

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
emailDomain
required
string

Email domain for custom portal email sender

Responses

Response samples

Content type
application/json
{
  • "domain": "string",
  • "verification": {
    },
  • "dns_validation_records": [
    ],
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete an email domain

Delete an email domain

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
emailDomain
required
string

Email domain for custom portal email sender

Responses

Response samples

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

Retrieve the email delivery for the portal

Retrieve the email delivery for the portal

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "from_email": "user@example.com",
  • "reply_to_email": "user@example.com",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Setup the email delivery for a portal

Setup the email delivery for a portal

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json
enabled
boolean
from_email
string or null <email>
reply_to_email
string or null <email>

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "from_email": "user@example.com",
  • "reply_to_email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "from_email": "user@example.com",
  • "reply_to_email": "user@example.com",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete email delivery

Delete email delivery

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

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

Portal Audit Logs

Update Portal Audit Log Replay Job

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

Updates a job to re-send audit logs to an portal's webhook.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json

The request schema to replace a portal audit log replay job.

start_at
required
string <date-time>

The start of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z. Must be within the last 7 days.

end_at
required
string <date-time>

The end of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z. Must be within the last 7 days.

Responses

Request samples

Content type
application/json
{
  • "start_at": "2019-08-24T14:15:22Z",
  • "end_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "start_at": "2017-07-21T17:32:28Z",
  • "end_at": "2017-07-21T17:32:28Z",
  • "status": "unconfigured",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get Portal Audit Log Replay Job

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

Returns the audit log replay job's configuration and status.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "start_at": "2017-07-21T17:32:28Z",
  • "end_at": "2017-07-21T17:32:28Z",
  • "status": "unconfigured",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Portal Audit Log Webhook

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

Updates the configuration for a webhook to receive audit logs.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json

The request schema to modify an portal audit log webhook.

enabled
boolean
Default: false

Indicates if the data should be sent to the configured destination.

audit_log_destination_id
string <uuid>

ID of the audit log destination.

Responses

Request samples

Content type
application/json
Example
{
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "audit_log_destination_id": "9cb77dc2-ff99-4d47-84ab-7c5c1b3ef939"
}

Get Portal Audit Log Webhook

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

Returns configuration for the audit log webhook.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "audit_log_destination_id": "9cb77dc2-ff99-4d47-84ab-7c5c1b3ef939"
}

Get Portal Audit Log Webhook Status

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

Returns status of the audit log webhook.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "webhook_enabled": true,
  • "webhook_status": "inactive",
  • "last_attempt_at": "2023-03-21T09:29:14.52Z",
  • "last_response_code": 401,
  • "last_response_message": "Unauthorized"
}