Konnect Control Planes (2.0.0)

Download OpenAPI specification:Download

The API for Kong Konnect Control Planes.

Control Plane Resource Quotas

List default resource quotas with organisational override

Returns a paginated collection of default resource quotas for control planes, along with organizationally-defined overrides for those resource quotas.

Authorizations:

personalAccessTokensystemAccountAccessToken

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/default-resource-quotas

Europe Production region

https://eu.api.konghq.com/v2/control-planes/default-resource-quotas

Australia Production region

https://au.api.konghq.com/v2/control-planes/default-resource-quotas

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/default-resource-quotas

India Production region

https://in.api.konghq.com/v2/control-planes/default-resource-quotas

Response samples

Content type

application/json

{"data": [{"id": "cc504063-f3bb-4e09-8e32-bbcdbc5cd618",
"name": "consumer",
"description": "Default value of the consumer resource",
"resource": "count/control-plane.consumer",
"value": 10000,
"overrides": [{"id": "7cdad5ef-1738-4781-8d71-9c5bbc99b187",
"name": "consumer override",
"description": "Increase for consumer resource quota",
"resource": "count/control-plane.consumer",
"value": 50000,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
},
{"id": "1beb9ad3-f3bb-4e09-8e32-bbcdbc5cd618",
"name": "certificate",
"description": "Default value of the route resource",
"resource": "count/control-plane.route",
"value": 500
}
]
}

List all control plane resource quota overrides

Returns a list of control plane quota override values created by the user.

Authorizations:

personalAccessTokensystemAccountAccessToken

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/resource-quotas

Europe Production region

https://eu.api.konghq.com/v2/control-planes/resource-quotas

Australia Production region

https://au.api.konghq.com/v2/control-planes/resource-quotas

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/resource-quotas

India Production region

https://in.api.konghq.com/v2/control-planes/resource-quotas

Response samples

Content type

application/json

{"data": [{"id": "7cdad5ef-1738-4781-8d71-9c5bbc99b187",
"name": "consumer override",
"description": "Increase for consumer resource quota",
"resource": "count/control-plane.consumer",
"value": 50000,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
},
{"id": "cbef8c44-0fb1-4cb6-979c-5b82d2334b5f",
"name": "route override",
"description": "Override for resource route",
"resource": "count/control-plane.route",
"value": 1000,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}

Create a control plane resource quota

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

Authorizations:

personalAccessTokensystemAccountAccessToken

Request Body schema: application/json

Request body for creating the control plane override resource quota value.

name	string (ControlPlaneResourceQuotaName) The human-readable name of this resource quota.
description	string (ControlPlaneResourceQuotaDescription) A more verbose description of what this resource quota enforces.
resource required	string (ControlPlaneResourceQuotaResourceName) Identifier value of resources available for quota enforcement.
value required	integer (ControlPlaneResourceQuotaValue) >= 1 The aggregate non-negative integer count of this resource that's allowed for the organization.

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/resource-quotas

Europe Production region

https://eu.api.konghq.com/v2/control-planes/resource-quotas

Australia Production region

https://au.api.konghq.com/v2/control-planes/resource-quotas

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/resource-quotas

India Production region

https://in.api.konghq.com/v2/control-planes/resource-quotas

Request samples

Payload

Content type

application/json

{"name": "consumer override",
"description": "Increase for consumer resource quota",
"resource": "count/control-plane.consumer",
"value": 40000
}

Response samples

Content type

application/json

{"id": "7cdad5ef-1738-4781-8d71-9c5bbc99b187",
"name": "consumer override",
"description": "Increase for consumer resource quota",
"resource": "count/control-plane.consumer",
"value": 50000,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Get a control plane resource quota value corresponding to the ID

Returns the control plane resource quota for the ID.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

resourceQuotaId

required

string <uuid>

Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The UUID for the control plane resource quota.

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Europe Production region

https://eu.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Australia Production region

https://au.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

India Production region

https://in.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Response samples

Content type

application/json

{"id": "7cdad5ef-1738-4781-8d71-9c5bbc99b187",
"name": "consumer override",
"description": "Increase for consumer resource quota",
"resource": "count/control-plane.consumer",
"value": 50000,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Update the control plane resource quota for the corresponding ID

Update the control plane resource quota for the corresponding ID.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

resourceQuotaId

required

string <uuid>

Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The UUID for the control plane resource quota.

Request Body schema: application/json

Request body for updating the control plane override resource quota value.

value

required

integer (ControlPlaneResourceQuotaValue) >= 1

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

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Europe Production region

https://eu.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Australia Production region

https://au.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

India Production region

https://in.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Request samples

Payload

Content type

application/json

{"value": 50000
}

Response samples

Content type

application/json

{"id": "7cdad5ef-1738-4781-8d71-9c5bbc99b187",
"name": "consumer override",
"description": "Increase for consumer resource quota",
"resource": "count/control-plane.consumer",
"value": 50000,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Delete the control plane resource quota

Deletes the created control plane resource quota which matches the ID provided.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

resourceQuotaId

required

string <uuid>

Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The UUID for the control plane resource quota.

Responses

United-States Production region

https://us.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Europe Production region

https://eu.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Australia Production region

https://au.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Middle-East Production region

https://me.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

India Production region

https://in.api.konghq.com/v2/control-planes/resource-quotas/{resourceQuotaId}

Response samples

Content type

application/problem+json

{"status": 0,
"title": "string",
"type": "string",
"instance": "string",
"detail": "string",
"invalid_parameters": [{"field": "name",
"rule": "required",
"source": "body",
"reason": "is a required field"
}
]
}