Konnect API Python SDK

Overview

The Konnect platform API

Synchronous Client

from kong_konnect_py import Client
from os import getenv

client = Client(
    konnect_access_token=getenv("API_TOKEN"),
    personal_access_token=getenv("API_TOKEN"),
    system_access_token=getenv("API_TOKEN"),
)

Asynchronous Client

from kong_konnect_py import AsyncClient
from os import getenv

client = AsyncClient(
    konnect_access_token=getenv("API_TOKEN"),
    personal_access_token=getenv("API_TOKEN"),
    system_access_token=getenv("API_TOKEN"),
)

Module Documentation and Snippets

authentication_settings

• list - Get Auth Settings
• patch - Update Auth Settings

cloud_gateways.availability_json

• list - Get Resource Availability JSON

cloud_gateways.configurations

• get - Get Configuration
• list - List Configurations
• update - Create Configuration

cloud_gateways.custom_domains

• create - Create Custom Domain
• delete - Delete Custom Domain
• get - Get Custom Domain
• list - List Custom Domains

cloud_gateways.custom_domains.online_status

• list - Get Custom Domain Online Status

cloud_gateways.default_resource_configurations

• list - List Default Resource Configurations

cloud_gateways.default_resource_quotas

• list - List Default Resource Quotas

cloud_gateways.networks

• create - Create Network
• delete - Delete Network
• get - Get Network
• list - List Networks
• patch - Update Network

cloud_gateways.networks.configuration_references

• list - Returns a paginated collection of configurations that reference a network.

cloud_gateways.networks.transit_gateways

• create - Create Transit Gateway
• delete - Delete Transit Gateway
• get - Get Transit Gateway
• list - List Transit Gateways

cloud_gateways.provider_accounts

• get - Get Provider Account
• list - List Provider Accounts

cloud_gateways.resource_configurations

• get - Get Resource Configuration
• list - List Resource Configurations

cloud_gateways.resource_quotas

• get - Get Resource Quota
• list - List Resource Quotas

control_planes

• create - Create Control Plane
• delete - Delete Control Plane
• get - Fetch Control Plane
• list - List Control Planes
• patch - Update Control Plane

control_planes.config_stores

• create - Create Config Store
• delete - Delete Config Store
• get - Fetch Config Store
• list - List all config stores for a control plane
• update - Update an individual Config Store

control_planes.config_stores.secrets

• create - Create Config Store Secret
• delete - Delete Config Store Secret
• get - Fetch Config Store Secret
• list - List Config Store Secrets
• update - Update Config Store Secret

control_planes.core_entities.acls

• get - Fetch an ACL
• list - List all ACLs

control_planes.core_entities.basic_auths

• get - Fetch a Basic-auth credential
• list - List all Basic-auth credentials

control_planes.core_entities.ca_certificates

• create - Create a new CA Certificate
• delete - Delete a CA Certificate
• get - Fetch a CA Certificate
• list - List all CA Certificates
• update - Upsert a CA Certificate

control_planes.core_entities.certificates

• create - Create a new Certificate
• delete - Delete a Certificate
• get - Fetch a Certificate
• list - List all Certificates
• update - Upsert a Certificate

control_planes.core_entities.certificates.snis

• create - Create a new SNI associated with a Certificate
• delete - Delete a an SNI associated with a Certificate
• get - Fetch an SNI associated with a Certificate
• list - List all SNIs associated with a Certificate
• update - Upsert an SNI associated with a Certificate

control_planes.core_entities.consumer_groups

• create - Create a new Consumer Group
• delete - Delete a Consumer Group
• get - Fetch a Consumer Group
• list - List all Consumer Groups
• update - Upsert a Consumer Group

control_planes.core_entities.consumer_groups.consumers

• create - Add consumer to consumer group
• delete - Remove consumers from consumer group
• delete_1 - Remove consumer from consumer group
• list - List all Consumers in a Consumer Group

control_planes.core_entities.consumer_groups.plugins

• create - Create a new Plugin associated with a Consumer Group
• delete - Delete a a Plugin associated with a Consumer Group
• get - Fetch a Plugin associated with a Consumer Group
• list - List all Plugins associated with a Consumer Group
• update - Upsert a Plugin associated with a Consumer Group

control_planes.core_entities.consumers

• create - Create a new Consumer
• delete - Delete a Consumer
• get - Fetch a Consumer
• list - List all Consumers
• update - Upsert a Consumer

control_planes.core_entities.consumers.acls

• create - Create a new ACL associated with a Consumer
• delete - Delete a an ACL associated with a Consumer
• get - Fetch an ACL associated with a Consumer
• list - List all ACLs associated with a Consumer
• update - Upsert an ACL associated with a Consumer

control_planes.core_entities.consumers.basic_auth

• create - Create a new Basic-auth credential associated with a Consumer
• delete - Delete a a Basic-auth credential associated with a Consumer
• get - Fetch a Basic-auth credential associated with a Consumer
• list - List all Basic-auth credentials associated with a Consumer
• update - Upsert a Basic-auth credential associated with a Consumer

control_planes.core_entities.consumers.consumer_groups

• create - Add consumer to a specific consumer group
• delete - Remove consumer from consumer group
• delete_1 - Remove consumer from consumer group
• list - List all Consumer Groups a Consumer belongs to

control_planes.core_entities.consumers.hmac_auth

• create - Create a new HMAC-auth credential associated with a Consumer
• delete - Delete a a HMAC-auth credential associated with a Consumer
• get - Fetch a HMAC-auth credential associated with a Consumer
• list - List all HMAC-auth credentials associated with a Consumer
• update - Upsert a HMAC-auth credential associated with a Consumer

control_planes.core_entities.consumers.jwt

• create - Create a new JWT associated with a Consumer
• delete - Delete a a JWT associated with a Consumer
• get - Fetch a JWT associated with a Consumer
• list - List all JWTs associated with a Consumer
• update - Upsert a JWT associated with a Consumer

control_planes.core_entities.consumers.key_auth

• create - Create a new API-key associated with a Consumer
• delete - Delete a an API-key associated with a Consumer
• get - Fetch an API-key associated with a Consumer
• list - List all API-keys associated with a Consumer
• update - Upsert an API-key associated with a Consumer

control_planes.core_entities.consumers.mtls_auth

• create - Create a new MTLS-auth credential associated with a Consumer
• delete - Delete a a MTLS-auth credential associated with a Consumer
• get - Fetch a MTLS-auth credential associated with a Consumer
• list - List all MTLS-auth credentials associated with a Consumer
• update - Upsert a MTLS-auth credential associated with a Consumer

control_planes.core_entities.consumers.plugins

• create - Create a new Plugin associated with a Consumer
• delete - Delete a a Plugin associated with a Consumer
• get - Fetch a Plugin associated with a Consumer
• list - List all Plugins associated with a Consumer
• update - Upsert a Plugin associated with a Consumer

control_planes.core_entities.hmac_auths

• get - Fetch a HMAC-auth credential
• list - List all HMAC-auth credentials

control_planes.core_entities.jwts

• get - Fetch a JWT
• list - List all JWTs

control_planes.core_entities.key_auths

• get - Fetch an API-key
• list - List all API-keys

control_planes.core_entities.key_sets

• create - Create a new KeySet
• delete - Delete a KeySet
• get - Fetch a KeySet
• list - List all KeySets
• update - Upsert a KeySet

control_planes.core_entities.key_sets.keys

• create - Create a new Key associated with a KeySet
• delete - Delete a a Key associated with a KeySet
• get - Fetch a Key associated with a KeySet
• list - List all Keys associated with a KeySet
• update - Upsert a Key associated with a KeySet

control_planes.core_entities.keys

• create - Create a new Key
• delete - Delete a Key
• get - Fetch a Key
• list - List all Keys
• update - Upsert a Key

control_planes.core_entities.mtls_auths

• get - Fetch a MTLS-auth credential
• list - List all MTLS-auth credentials

control_planes.core_entities.plugin_schemas

• create - Upload custom plugin schema
• delete - Delete custom plugin schema
• get - Fetch custom plugin schema
• list - List custom plugin schemas associated with a control plane
• update - Create or update a custom plugin schema

control_planes.core_entities.plugins

• create - Create a new Plugin
• delete - Delete a Plugin
• get - Fetch a Plugin
• list - List all Plugins
• update - Upsert a Plugin

control_planes.core_entities.routes

• create - Create a new Route
• delete - Delete a Route
• get - Fetch a Route
• list - List all Routes
• update - Upsert a Route

control_planes.core_entities.routes.plugins

• create - Create a new Plugin associated with a Route
• delete - Delete a a Plugin associated with a Route
• get - Fetch a Plugin associated with a Route
• list - List all Plugins associated with a Route
• update - Upsert a Plugin associated with a Route

control_planes.core_entities.schemas.plugins

• get - Fetch plugin schema

control_planes.core_entities.services

• create - Create a new Service
• delete - Delete a Service
• get - Fetch a Service
• list - List all Services
• update - Upsert a Service

control_planes.core_entities.services.plugins

• create - Create a new Plugin associated with a Service
• delete - Delete a a Plugin associated with a Service
• get - Fetch a Plugin associated with a Service
• list - List all Plugins associated with a Service
• update - Upsert a Plugin associated with a Service

control_planes.core_entities.services.routes

• create - Create a new Route associated with a Service
• delete - Delete a a Route associated with a Service
• get - Fetch a Route associated with a Service
• list - List all Routes associated with a Service
• update - Upsert a Route associated with a Service

control_planes.core_entities.snis

• create - Create a new SNI
• delete - Delete an SNI
• get - Fetch an SNI
• list - List all SNIs
• update - Upsert a SNI

control_planes.core_entities.upstreams

• create - Create a new Upstream
• delete - Delete an Upstream
• get - Fetch an Upstream
• list - List all Upstreams
• update - Upsert a Upstream

control_planes.core_entities.upstreams.targets

• create - Create a new Target associated with an Upstream
• delete - Delete a a Target associated with an Upstream
• get - Fetch a Target associated with an Upstream
• list - List all Targets associated with an Upstream
• update - Upsert a Target associated with an Upstream

control_planes.core_entities.vaults

• create - Create a new Vault
• delete - Delete a Vault
• get - Fetch a Vault
• list - List all Vaults
• update - Upsert a Vault

control_planes.dp_client_certificates

• create - Pin New DP Client Certificate
• delete - Delete DP Client Certificate
• get - Fetch DP Client Certificate
• list - List DP Client Certificates

control_planes.expected_config_hash

• list - Fetch Expected Config Hash

control_planes.group_member_status

• list - Control Plane Group Member Status

control_planes.group_memberships

• list - List Control Plane Group Memberships
• update - Upsert Control Plane Group Members

control_planes.group_memberships.add

• create - Add Control Plane Group Members

control_planes.group_memberships.remove

• create - Remove Control Plane Group Members

control_planes.group_status

• list - Get Control Plane Group Status

control_planes.nodes

• delete - Delete Data Plane Node Record
• get - Fetch Data Plane Node Record
• list - List Data Plane Node Records

control_planes.nodes.eol

• list - List End-of-Life Data Plane Node Records

identity_provider

• list - Fetch IdP Configuration
• patch - Update IdP Configuration

identity_provider.team_group_mappings

• list - Fetch Team Group Mappings
• patch - Patch Mappings by Team ID

identity_provider.team_mappings

• list - Fetch Team Mapping
• update - Update Team Mappings

identity_providers

• create - Create Identity Provider
• delete - Delete Identity Provider
• get - Get Identity Provider
• list - Retrieve Identity Providers
• patch - Update Identity Provider

invites

• create - Invite User

notifications.configurations

• list - List available user configurations.

notifications.configurations.subscriptions

• create - Create a new subscription for an event.
• delete - Delete subscription associated with event.
• get - Get subscription for an event.
• list - List event subscriptions.
• patch - Update subscription for an event.

notifications.inbox

• delete - Delete notification.
• get - Get notification details.
• list - List available notifications.
• patch - Update notification.

notifications.inbox.bulk

• create - Mark a list of notifications to a status.

organizations.impersonation

• list - Get Impersonation Settings
• patch - Update Impersonation Settings

organizations.me

• list - Retrieve My Organization

roles

• list - Get Predefined Roles

system_accounts

• create - Create System Account
• delete - Delete System Account
• get - Fetch System Account
• list - List System Accounts
• patch - Update System Account

system_accounts.access_tokens

• create - Create System Account Access Token
• delete - Delete System Account Access Token
• get - Fetch System Account Access Token
• list - List System Account Access Tokens
• patch - Update System Account Access Token

system_accounts.assigned_roles

• create - Create Assigned Role for System Account
• delete - Delete Assigned Role from System Account
• list - Fetch Assigned Roles for System Account

system_accounts.teams

• list - List Teams for a System Account

teams

• create - Create Team
• delete - Delete Team
• get - Fetch Team
• list - List Teams
• patch - Update Team

teams.assigned_roles

• create - Assign Team Role
• delete - Remove Team Role
• list - List Team Roles

teams.system_accounts

• create - Add System Account to a Team
• delete - Remove System Account From Team
• list - List System Accounts on a Team

teams.users

• create - Add User
• delete - Remove User
• list - List Team Users

users

• delete - Delete User
• get - Fetch User
• list - List Users
• patch - Update User

users.assigned_roles

• create - Assign Role
• delete - Remove Role
• list - List User Roles

users.me

• list - Retrieve My User Account

users.teams

• list - List User Teams