API docs by Redocly

Portal Management (2.2.0)

Download OpenAPI specification:Download

URL: https://konghq.com

The management API for Portals

Portals

APIs related to Configuration of Konnect Developer Portals.

List Portals

Lists developer portals defined in this region for this organization. Each developer portal is available at a unique address and has isolated appearance, configuration, 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
  • is_public
  • rbac_enabled
  • auto_approve_applications
  • auto_approve_developers
  • default_domain
  • custom_domain
  • custom_client_domain
  • created_at
  • updated_at
object

Filter portals returned in the response.

Responses

Response samples

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

Create Portal

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 (PortalName) [ 1 .. 255 ] characters

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

display_name
string (PortalDisplayName) [ 1 .. 255 ] characters

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

description
string or null (PortalDescription) <= 512 characters

The description of the portal.

is_public
boolean

Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.

rbac_enabled
boolean

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

auto_approve_applications
boolean

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

auto_approve_developers
boolean

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

custom_domain
string or null <hostname> <= 1024 characters

The custom domain to access the developer portal. A CNAME for the portal's default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal's web client and API.

custom_client_domain
string or null <hostname> <= 1024 characters

The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal will no longer be available. custom_domain must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.

default_application_auth_strategy_id
string or null <uuid> (DefaultApplicationAuthStratID)

Default strategy ID applied on applications for the portal

object (Labels) <= 50 properties

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

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",
  • "is_public": false,
  • "rbac_enabled": true,
  • "auto_approve_applications": false,
  • "auto_approve_developers": false,
  • "custom_domain": "api.example.com",
  • "custom_client_domain": "portal.example.com"
}

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",
  • "is_public": false,
  • "rbac_enabled": true,
  • "auto_approve_applications": false,
  • "auto_approve_developers": true,
  • "custom_domain": "api.example.com",
  • "custom_client_domain": "portal.example.com",
  • "application_count": 0,
  • "developer_count": 0,
  • "published_product_count": 0
}

Get Portal

Returns the configuration for a single developer portal. This allows you to understand 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",
  • "is_public": false,
  • "rbac_enabled": true,
  • "auto_approve_applications": false,
  • "auto_approve_developers": true,
  • "custom_domain": "api.example.com",
  • "custom_client_domain": "portal.example.com",
  • "application_count": 0,
  • "developer_count": 0,
  • "published_product_count": 0
}

Update Portal

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 (PortalName) [ 1 .. 255 ] characters

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

display_name
string (PortalDisplayName) [ 1 .. 255 ] characters

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

description
string or null (PortalDescription) <= 512 characters

The description of the portal.

is_public
boolean

Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.

rbac_enabled
boolean

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

auto_approve_applications
boolean

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

auto_approve_developers
boolean

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

custom_domain
string or null <hostname> <= 1024 characters

The custom domain to access the developer portal. A CNAME for the portal's default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal's web client and API.

custom_client_domain
string or null <hostname> <= 1024 characters

The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal will no longer be available. custom_domain must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.

default_application_auth_strategy_id
string or null <uuid> (DefaultApplicationAuthStratID)

Default strategy ID applied on applications for the portal

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
{
  • "is_public": false,
  • "rbac_enabled": true,
  • "auto_approve_applications": false,
  • "auto_approve_developers": false,
  • "custom_domain": "api.example.com",
  • "custom_client_domain": "portal.example.com"
}

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",
  • "is_public": false,
  • "rbac_enabled": true,
  • "auto_approve_applications": false,
  • "auto_approve_developers": true,
  • "custom_domain": "api.example.com",
  • "custom_client_domain": "portal.example.com",
  • "application_count": 0,
  • "developer_count": 0,
  • "published_product_count": 0
}

Delete Portal

Deletes a single portal, along with all related entities. Will not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled, unless force=true query param is included in the request.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

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

If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled.

Responses

Response samples

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

Get a portal configuration

Get the configuration of the portal

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

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

Replace a portal configuration

Update the configuration of the portal

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json
required
object

Responses

Request samples

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

Response samples

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

Update a portal configuration

Update the configuration of the portal

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json

Request schema to replace the portal configuration.

required
object

Responses

Request samples

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

Response samples

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

Verify Custom Domains

Verifies the current status of the custom hosted domain for this portal, indicating whether the appropriate CNAME properties have propagated and if a corresponding SSL certificate has been generated.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "is_cname_verified": true,
  • "is_ssl_issued": false
}

Portal Developers

APIs related to Konnect Developer Portal Developers.

Get Developer

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

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

developerId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The developer ID

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

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> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The developer ID

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

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 API Products. 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> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The developer ID

Responses

Response samples

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

List Developers

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

Portal Teams

APIs related to Konnect Developer Portal Developer Teams.

List Teams

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

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

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

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

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 Developer Membership in Konnect Developer Portal Developer Teams.

List Team Developers

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.

Responses

Response samples

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

Add Developer to Team

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

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

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 Team Roles in Konnect Developer Portal.

List Team Roles

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

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

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

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

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

Portal Applications

APIs related to Konnect Developer Portal Applications.

List Applications

Lists applications created by developers in this portal. Each application can be registered for various API Products (by version), issuing credentials for API request access. If using DCR, an application will be linked to an Identity Provider's application by its reference_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": [
    ]
}

Get Application by Portal

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

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

applicationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application ID

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",
  • "reference_id": "df66b180-97df-4ddb-8b45-8b7d5eac56da",
  • "registration_count": 4,
  • "portal": {
    },
  • "dcr_provider": null,
  • "granted_scopes": null,
  • "developer": {
    },
  • "created_at": "2022-12-22T19:09:30.712Z",
  • "updated_at": "2022-12-22T19:09:30.712Z"
}

Delete Application by Portal

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> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application ID

Responses

Response samples

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

Get Application

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

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
applicationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application ID

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",
  • "reference_id": "df66b180-97df-4ddb-8b45-8b7d5eac56da",
  • "registration_count": 4,
  • "portal": {
    },
  • "dcr_provider": null,
  • "granted_scopes": null,
  • "developer": {
    },
  • "created_at": "2022-12-22T19:09:30.712Z",
  • "updated_at": "2022-12-22T19:09:30.712Z"
}

Portal Application Registrations

APIs related to Konnect Developer Portal Application Registrations.

List Application Registrations by Portal

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 product version. 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

Lists each API product version 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> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application ID

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

Get Application Registration

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

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

applicationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application ID

registrationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application registration ID

Responses

Response samples

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

Update Application Registration

Updates the status of a particular application registration to an API Product Version. 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> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application ID

registrationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application registration ID

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 version of a product, and application credentials will not grant access to the product version until the registration is approved. Pending, revoked, and rejected registrations will not provide access to the product version.

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": {
    },
  • "product": {
    },
  • "product_version": {
    },
  • "developer": {
    },
  • "granted_scopes": [
    ],
  • "created_at": "2022-12-22T20:13:07.305Z",
  • "updated_at": "2022-12-22T20:13:36.710Z"
}

Delete Application Registration

Deletes an application registration, which if currently approved will immediately block API traffic to the API product version. Note: Developers can request a new application registration for the given API product version 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> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application ID

registrationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application registration ID

Responses

Response samples

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

List Granted Scopes

Lists the granted scopes for this application registration. This is the list of scopes that will be sent to the API when making requests.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

applicationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application ID

registrationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application registration ID

Responses

Response samples

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

Portal Products

APIs related to API Products Published to Konnect Developer Portals.

List Portal Products

Lists the API products that are published to this developer portal. An API product packages together multiple versions of each API, displaying each version with its set of operations and documentation. Developers can browse API Products to learn about and register for them. API Products access can be limited to certain developers using RBAC and developer 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.

sort
string

Sorts a collection of Portal Products. Supported sort attributes are:

  • created_at
  • name
  • description
object (PortalProductFilters)

Filters a collection of Portal Products.

Responses

Response samples

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

Portal Auth Settings

APIs related to Konnect Developer Portal Authentication Settings.

Get Auth Settings

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,
  • "oidc_team_mapping_enabled": true,
  • "konnect_mapping_enabled": true,
  • "oidc_config": {
    }
}

Update Auth Settings

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.

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.

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,
  • "oidc_team_mapping_enabled": true,
  • "konnect_mapping_enabled": false,
  • "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,
  • "oidc_team_mapping_enabled": true,
  • "konnect_mapping_enabled": true,
  • "oidc_config": {
    }
}

List Team Group Mappings

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

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

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
Example
{
  • "id": "66da2d42-469d-48cd-9ff3-0db135dd82d8",
  • "type": "oidc",
  • "enabled": false,
  • "login_path": "the-oidc-konnect-org",
  • "config": {
    },
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-02-07T17:46:57.52Z"
}

Create Identity Provider

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.

login_path
string (Identity Provider Login Path Property)

The path used for initiating login requests with the identity provider.

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

Responses

Request samples

Content type
application/json
Example
{
  • "type": "oidc",
  • "login_path": "the-oidc-konnect-org",
  • "config": {
    }
}

Response samples

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

Get Identity Provider

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,
  • "login_path": "the-oidc-konnect-org",
  • "config": {
    },
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-02-07T17:46:57.52Z"
}

Update Identity Provider

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.

login_path
string (Identity Provider Login Path Property)

The path used for initiating login requests with the identity provider.

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

Responses

Request samples

Content type
application/json
Example
{
  • "enabled": true,
  • "login_path": "the-oidc-konnect-org",
  • "config": {
    }
}

Response samples

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

Delete Identity Provider

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 Appearance

APIs related to Konnect Developer Portal Appearance Settings.

Get Default Appearance Configurations

Returns the built-in portal appearance configurations including pre-defined themes, colors, and font settings.

Authorizations:
personalAccessTokensystemAccountAccessToken

Responses

Response samples

Content type
application/json
{
  • "themes": {
    },
  • "fonts": {
    },
  • "text": {
    }
}

Get Appearance Configuration

Returns the current portal appearance configuration including any custom theme, colors, fonts, and image settings. Portals using the fully-customizable portal client may override or ignore these settings by disregarding them in the code.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "theme_name": "custom",
  • "use_custom_fonts": true,
  • "custom_theme": {
    },
  • "custom_fonts": {
    },
  • "text": {
    },
  • "images": {
    }
}

Update Appearance Configuration

Updates the current appearance configuration for this portal including setting pre-defined or custom themes, fonts, colors, and images. Note that portals using the fully-customizable portal client may override or ignore these settings by disregarding them in the code.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json

Update a portal's appearance settings

theme_name
string (PortalTheme)
Enum: "mint_rocket" "dark_mode" "custom"

Select a pre-existing default theme or specify 'custom' to use custom_theme variables.

object or null (AppearanceThemeVariables)

Groups of variables for configuring visual details of the portal user interface. Set theme_name to 'custom' to use custom values for theme variables.

object or null (NullableAppearanceFonts)

Font selections to render text in the portal user interface. Must set use_custom_fonts to true to enable using custom font values.

use_custom_fonts
boolean

If true, fonts in custom_fonts will be used over the theme's default fonts

object or null (NullableAppearanceTextVariables)

Values to display for customizable text in the portal user interface

object or null (AppearanceImages)

A collection of binary image data to customize images in the portal

Responses

Request samples

Content type
application/json
Example
{
  • "theme_name": "custom",
  • "use_custom_fonts": true,
  • "custom_theme": {
    },
  • "custom_fonts": {
    },
  • "text": {
    },
  • "images": {
    }
}

Response samples

Content type
application/json
{
  • "theme_name": "custom",
  • "use_custom_fonts": true,
  • "custom_theme": {
    },
  • "custom_fonts": {
    },
  • "text": {
    },
  • "images": {
    }
}

Get Portal Catalog Cover

Returns the portal catalog cover or returns the default

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

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

Portal Customization

APIs related to Konnect Developer Portal Customization.

Get Customization

Returns the portal customization options.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

Content type
application/json
{ }

Replace Customization

Replace the portal customization options.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Update Portal Customization

Update the portal customization options, merging properties.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Portal Pages

APIs related to Konnect Developer Portal Custom Pages.

List Portal Pages

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
  • path
  • title
  • public
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 (PortalPagesFilters)

Filter pages returned in the response.

Responses

Response samples

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

Create Portal Page

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.

path
required
string (PagePath) <= 512 characters

The path of a page in a portal with a leading slash.

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.

public
boolean (PagePublicStatusWithDefault)
Default: false

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

published
boolean (PagePublishStatus)

Whether a page is visible on a given portal. Defaults to false.

description
string (PageDescription) <= 160 characters

Responses

Request samples

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

Response samples

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

Get Portal Page

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",
  • "path": "/",
  • "title": "Home",
  • "content": "Welcome to the home page of the portal. This is where you can find information about the portal and its products.",
  • "public": true,
  • "published": true,
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-10-08T17:00:00.52Z"
}

Update Portal Page

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.

path
string (PagePath) <= 512 characters

The path of a page in a portal with a leading slash.

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.

public
boolean (PagePublicStatus)

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

published
boolean (PagePublishStatus)

Whether a page is visible on a given portal. Defaults to false.

description
string (PageDescription) <= 160 characters

Responses

Request samples

Content type
application/json
{
  • "title": "About Us",
  • "path": "/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",
  • "path": "/",
  • "title": "Home",
  • "content": "Welcome to the home page of the portal. This is where you can find information about the portal and its products.",
  • "public": true,
  • "published": true,
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-10-08T17:00:00.52Z"
}

Delete Portal Page

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

Portal Product Versions

Portal Product Versions hold metadata that describes how a Product Version is configured for a specific portal.

They contain:

  • Lifecyle and deprecation statuses
  • Application registration settings like auto approve or whether application registration is enabled
  • The authentication strategy that is enabled for Application Registration

List portal product versions

List portal product versions

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid> (schemas-UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

portal identifier

query Parameters
sort
string

Sorts a collection of Portal Product Versions. Supported sort attributes are:

  • created_at
  • updated_at
  • publish_status
  • product_version_id
  • auth_strategy_ids
  • application_registration_enabled
  • auto_approve_registration
  • deprecated
object (PortalProductVersionFilters)

Filters a collection of Portal Product Versions.

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

Create a portal product version

Create a portal product version

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid> (schemas-UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

portal identifier

Request Body schema: application/json
publish_status
required
string (PortalProductVersionPublishStatus)
Enum: "published" "unpublished"

Publication status of the API product version on the portal

product_version_id
required
string <uuid> (UUID_RW)

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

auth_strategy_ids
required
Array of strings <uuid> (AuthStrategyIDs) [ 0 .. 1 ] items

A list of authentication strategy IDs

application_registration_enabled
required
boolean (ApplicationRegistrationEnabled)

Whether the application registration on this portal for the api product version is enabled

auto_approve_registration
required
boolean (AutoApproveRegistration)

Whether the application registration auto approval on this portal for the api product version is enabled

deprecated
required
boolean (PortalProductVersionDeprecated)

Whether the api product version on the portal is deprecated

Responses

Request samples

Content type
application/json
{
  • "product_version_id": "33f8380e-7798-4566-99e3-2edf2b57d289",
  • "auth_strategy_ids": [
    ],
  • "publish_status": "published",
  • "application_registration_enabled": true,
  • "auto_approve_registration": true,
  • "deprecated": false
}

Response samples

Content type
application/json
{
  • "id": "22f8380e-7798-4566-99e3-2edf2b57d289",
  • "publish_status": "published",
  • "product_version_id": "33f8380e-7798-4566-99e3-2edf2b57d289",
  • "auth_strategies": [
    ],
  • "application_registration_enabled": true,
  • "auto_approve_registration": true,
  • "deprecated": false,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Get a portal product version

Get a portal product version

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
productVersionId
required
string <uuid> (schemas-UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

API product version identifier

portalId
required
string <uuid> (schemas-UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

portal identifier

Responses

Response samples

Content type
application/json
{
  • "id": "22f8380e-7798-4566-99e3-2edf2b57d289",
  • "publish_status": "published",
  • "product_version_id": "33f8380e-7798-4566-99e3-2edf2b57d289",
  • "auth_strategies": [
    ],
  • "application_registration_enabled": true,
  • "auto_approve_registration": true,
  • "deprecated": false,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Update a portal product version

Update a portal product version

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
productVersionId
required
string <uuid> (schemas-UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

API product version identifier

portalId
required
string <uuid> (schemas-UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

portal identifier

Request Body schema: application/json
publish_status
string (PortalProductVersionPublishStatus)
Enum: "published" "unpublished"

Publication status of the API product version on the portal

auth_strategy_ids
Array of strings <uuid> (AuthStrategyIDs) [ 0 .. 1 ] items

A list of authentication strategy IDs

application_registration_enabled
boolean (ApplicationRegistrationEnabled)

Whether the application registration on this portal for the api product version is enabled

auto_approve_registration
boolean (AutoApproveRegistration)

Whether the application registration auto approval on this portal for the api product version is enabled

deprecated
boolean (PortalProductVersionDeprecated)

Whether the api product version on the portal is deprecated

notify_developers
boolean (NotifyDevelopers)

Whether to notify developers who are affected by this change

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "22f8380e-7798-4566-99e3-2edf2b57d289",
  • "publish_status": "published",
  • "product_version_id": "33f8380e-7798-4566-99e3-2edf2b57d289",
  • "auth_strategies": [
    ],
  • "application_registration_enabled": true,
  • "auto_approve_registration": true,
  • "deprecated": false,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Replace a portal product version

Replace a portal product version

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
productVersionId
required
string <uuid> (schemas-UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

API product version identifier

portalId
required
string <uuid> (schemas-UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

portal identifier

Request Body schema: application/json
publish_status
required
string (PortalProductVersionPublishStatus)
Enum: "published" "unpublished"

Publication status of the API product version on the portal

auth_strategy_ids
required
Array of strings <uuid> (AuthStrategyIDs) [ 0 .. 1 ] items

A list of authentication strategy IDs

application_registration_enabled
required
boolean (ApplicationRegistrationEnabled)

Whether the application registration on this portal for the api product version is enabled

auto_approve_registration
required
boolean (AutoApproveRegistration)

Whether the application registration auto approval on this portal for the api product version is enabled

deprecated
required
boolean (PortalProductVersionDeprecated)

Whether the api product version on the portal is deprecated

notify_developers
boolean (NotifyDevelopers)

Whether to notify developers who are affected by this change

Responses

Request samples

Content type
application/json
{
  • "auth_strategy_ids": [
    ],
  • "publish_status": "published",
  • "application_registration_enabled": true,
  • "auto_approve_registration": true,
  • "deprecated": false
}

Response samples

Content type
application/json
{
  • "id": "22f8380e-7798-4566-99e3-2edf2b57d289",
  • "publish_status": "published",
  • "product_version_id": "33f8380e-7798-4566-99e3-2edf2b57d289",
  • "auth_strategies": [
    ],
  • "application_registration_enabled": true,
  • "auto_approve_registration": true,
  • "deprecated": false,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Delete a portal product version

Delete a portal product version

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
productVersionId
required
string <uuid> (schemas-UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

API product version identifier

portalId
required
string <uuid> (schemas-UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

portal identifier

Responses

Response samples

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

API Products

Publish Multiples Products

Publish or Unpublish multiple API Products to this developer portal.

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json
required
object

Responses

Request samples

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

Response samples

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

Portal Audit Logs

Update Portal Audit Log Replay Job

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

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

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

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

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