2.0.0OAS 3.0

Konnect API for managing cloud-gateways infrastructure.

API Base URL
  • Server 1:https://global.api.konghq.com/v2

    Base URL for the global region

Security
konnectAccessToken (http)

The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.

personalAccessToken (http)

The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.
You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.
The PAT token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'

systemAccountAccessToken (http)

The system account access token is meant for automations and integrations that are not directly associated with a human identity.
You can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.
The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'

Additional Information
Contact Kong

Provider Accounts

Create Provider Account

Creates a new provider account for an organization.

post
https://global.api.konghq.com/v2/cloud-gateways/provider-accounts

Body

application/json

CreateProviderAccountRequest

Request schema for creating a provider account via automatic account vending.

* Additional properties are NOT allowed.
providerstringrequired

Name of cloud provider.

Allowed values:awsazuregcp

Example:aws

Response

application/json

Response format for creating a provider account.

Cloud Gateway Provider Account

Object containing mapping for organization and cloud provider to account ID.

idstring(uuid)required

Example:929b2449-c69f-44c4-b6ad-9ecec6f811ae

providerstringrequired

Name of cloud provider.

Allowed values:awsazuregcp

Example:aws

provider_account_idstringrequiredread-only

ID of the cloud provider account.

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of provider account creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of provider account update date.

Example:2022-11-04T20:10:06.927Z

post/cloud-gateways/provider-accounts

Body

{ "provider": "aws" }
 
application/json

Delete Provider Account

Deletes a provider account by ID.

delete
https://global.api.konghq.com/v2/cloud-gateways/provider-accounts/{providerAccountId}

Path Parameters

providerAccountIdstring(uuid)required

The ID of the provider account to operate on.

Example:929b2449-c69f-44c4-b6ad-9ecec6f811ae

Response

No Content

delete/cloud-gateways/provider-accounts/{providerAccountId}
 

Cloud Gateways Resource Quotas