API docs by Redocly

Konnect Cloud Gateways (2.0.0)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

Konnect API for managing cloud-gateways infrastructure.

Provider Accounts

Create Provider Account

Creates a new provider account for an organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
Request Body schema: application/json
provider
required
string (Provider Name)
Enum: "aws" "azure"

Name of cloud provider.

Responses

Request samples

Content type
application/json
{
  • "provider": "aws"
}

Response samples

Content type
application/json
{
  • "id": "929b2449-c69f-44c4-b6ad-9ecec6f811ae",
  • "provider": "aws",
  • "provider_account_id": "string",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete Provider Account

Deletes a provider account by ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
providerAccountId
required
string <uuid> (ProviderAccountId)
Example: 929b2449-c69f-44c4-b6ad-9ecec6f811ae

The ID of the provider account to operate on.

Responses

Response samples

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

Cloud Gateways Resource Quotas

Create Resource Quota

Creates a new resource quota, scoped to a given resource, for an organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
Request Body schema: application/json
resource
required
string (ResourceQuotaQualifier)
Enum: "count/provider-accounts.per-provider" "count/networks.not-offline" "count/data-planes-estimate" "count/serverless-data-planes-estimate"

Enumeration of resources available for quota enforcement.

value
required
integer (ResourceQuotaValue) >= 0

The aggregate non-negative integer count of this resource that's allowed for the organization.

Responses

Request samples

Content type
application/json
{
  • "resource": "count/provider-accounts.per-provider",
  • "value": 2
}

Response samples

Content type
application/json
{
  • "id": "9678f205-49a1-47bb-82d9-d01cafa42a0d",
  • "resource": "count/provider-accounts.per-provider",
  • "name": "Active Networks",
  • "description": "Across the organization, the aggregate number of active networks cannot exceed this value.",
  • "value": 2,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Update Resource Quota

Updates a resource quota by ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
resourceQuotaId
required
string <uuid> (ResourceQuotaId)
Example: 9678f205-49a1-47bb-82d9-d01cafa42a0d

The ID of the resource quota to operate on.

Request Body schema: application/json
value
required
integer (ResourceQuotaValue) >= 0

The aggregate non-negative integer count of this resource that's allowed for the organization.

Responses

Request samples

Content type
application/json
{
  • "value": 2
}

Response samples

Content type
application/json
{
  • "id": "9678f205-49a1-47bb-82d9-d01cafa42a0d",
  • "resource": "count/provider-accounts.per-provider",
  • "name": "Active Networks",
  • "description": "Across the organization, the aggregate number of active networks cannot exceed this value.",
  • "value": 2,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Resource Configurations

Create Resource Configuration

Creates a new resource configuration for an organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
Request Body schema: application/json
qualifier
required
string (ResourceConfigurationQualifier)
Value: "data-plane-group-idle-timeout-minutes"

Enumeration of configuration qualifiers available for organization-wide configuration.

value
required
integer (ResourceConfigurationValue)

The value of this resource configuration.

Responses

Request samples

Content type
application/json
{
  • "qualifier": "data-plane-group-idle-timeout-minutes",
  • "value": 45
}

Response samples

Content type
application/json
{
  • "id": "9678f205-49a1-47bb-82d9-d01cafa42a0d",
  • "qualifier": "data-plane-group-idle-timeout-minutes",
  • "value": 45
}

Update Resource Configuration

Updates a resource configuration by ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
path Parameters
resourceConfigurationId
required
string <uuid> (ResourceConfigurationId)
Example: 9678f205-49a1-47bb-82d9-d01cafa42a0d

The ID of the resource configuration to operate on.

Request Body schema: application/json
qualifier
required
string (ResourceConfigurationQualifier)
Value: "data-plane-group-idle-timeout-minutes"

Enumeration of configuration qualifiers available for organization-wide configuration.

value
required
integer (ResourceConfigurationValue)

The value of this resource configuration.

Responses

Request samples

Content type
application/json
{
  • "qualifier": "data-plane-group-idle-timeout-minutes",
  • "value": 45
}

Response samples

Content type
application/json
{
  • "id": "9678f205-49a1-47bb-82d9-d01cafa42a0d",
  • "qualifier": "data-plane-group-idle-timeout-minutes",
  • "value": 45
}