Konnect Cloud Gateways

v2.0.0OAS 3.0

Konnect API for managing cloud-gateways infrastructure.

API Base URL
  • Server 1:https://global.api.konghq.com/v2[Konnect Cloud Gateways]

    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

List Configurations

Returns a paginated collection of configurations across control-planes for an organization (restricted by
permitted control-plane reads).

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

Query 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

filterobject

Filters supported for configurations.

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

A paginated list for a collection of configurations.

ListConfigurationsResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Object containing information about a control-plane’s cloud-gateways configuration.

Show Child Parameters
get/cloud-gateways/configurations
 
application/json