Delete Add-On

Deletes an add-on by ID. The request will be rejected if the managed cache partial is still in use by some plugins.

delete
https://global.api.konghq.com/v2/cloud-gateways/add-ons/{addOnId}

Path Parameters

addOnIdstring(uuid)requiredread-only

ID of the add-on to operate on.

Example:550e8400-e29b-41d4-a716-446655440000

Response

No Content

delete/cloud-gateways/add-ons/{addOnId}
 

Provider Accounts

List Provider Accounts

Returns a a paginated collection of provider accounts for an organization.

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

Query Parameters

filterobject

Filters supported for provider accounts.

* Additional properties are NOT allowed.
Show Child Parameters
page[size]integer

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

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Response

application/json

A paginated list for a collection of provider accounts.

ListCloudGatewayProviderAccountsResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

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

Show Child Parameters
get/cloud-gateways/provider-accounts
 
application/json

Get Provider Account

Retrieves a provider account by ID.

get
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

application/json

Response format for retrieving 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

get/cloud-gateways/provider-accounts/{providerAccountId}
 
application/json

Custom Domains