Konnect Runtime Groups (2.0.0)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

The API for Kong Konnect Runtime Groups.

Runtime Groups

List Runtime Groups

Returns an array of runtime groups objects containing information about the Konnect Runtime Groups.

Authorizations:

personalAccessTokensystemAccountAccessToken

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.
filter[name][eq]	string Example: filter[name][eq]=test Filter by direct equality comparison of the name property with a supplied value.
filter[name]	string Example: filter[name]=test Filter by direct equality comparison (short-hand) of the name property with a supplied value.
filter[name][contains]	string Example: filter[name][contains]=test Filter by contains comparison of the name property with a supplied substring.
filter[name][neq]	string Example: filter[name][neq]=test Filter by non-equality comparison of the name property with a supplied value.
filter[id][eq]	string Example: filter[id][eq]=7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 Filter by direct equality comparison of the id property with a supplied value.
filter[id]	string Example: filter[id]=7f9fd312-a987-4628-b4c5-bb4f4fddd5f7 Filter by direct equality comparison (short-hand) of the id property with a supplied value.
filter[id][oeq]	string Example: filter[id][oeq]=some-value,some-other-value Filter by direct equality comparison of id property with multiple supplied values.
filter[cluster_type][eq]	string Example: filter[cluster_type][eq]=CLUSTER_TYPE_HYBRID Filter by direct equality comparison of the cluster_type property with a supplied value.
filter[cluster_type]	string Example: filter[cluster_type]=CLUSTER_TYPE_HYBRID Filter by direct equality comparison (short-hand) of the cluster_type property with a supplied value.
filter[cluster_type][neq]	string Example: filter[cluster_type][neq]=test Filter by non-equality comparison of the cluster_type property with a supplied value.
labels	string Example: labels=key:value,existCheck Filter runtime groups in the response by associated labels.
sort	string (SortQuery) Example: sort=name,created_at desc Sorts a collection of runtime-groups. Supported sort attributes are: created_at

Responses

Response samples

200
400
401
403
503

Content type

application/json

No sample

Create Runtime Group

Create a runtime group in the Konnect Organization.

Authorizations:

personalAccessTokensystemAccountAccessToken

Request Body schema: application/json

name required	string The name of the runtime group.
description	string The description of the runtime group in Konnect.
cluster_type	string Enum: "CLUSTER_TYPE_HYBRID" "CLUSTER_TYPE_K8S_INGRESS_CONTROLLER" "CLUSTER_TYPE_COMPOSITE" "CLUSTER_TYPE_SERVERLESS" The ClusterType value of the cluster associated with the Runtime Group.
auth_type	string Enum: "pinned_client_certs" "pki_client_certs" The auth type value of the cluster associated with the Runtime Group.
cloud_gateway	boolean Whether this runtime group can be used for cloud-gateways.
	Array of objects (ProxyURLs) Array of proxy URLs associated with reaching the data-planes connected to a runtime group.
	object (Labels) Labels to facilitate tagged search on runtime groups. Keys must be of length 1-63 characters, and cannot start with 'kong', 'konnect', 'mesh', 'kic', or '_'.

Responses

Request samples

Payload

Content type

application/json

{"name": "Test Runtime Group",
"description": "A test runtime group for exploration.",
"cluster_type": "CLUSTER_TYPE_K8S_INGRESS_CONTROLLER",
"cloud_gateway": false,
"proxy_urls": [{"host": "example.com",
"port": 443,
"protocol": "https"
}
],
"labels": {"test": "true"
}
}

Response samples

Content type

application/json

{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "Test Runtime Group",
"description": "A test runtime group for exploration.",
"labels": {"test": "true"
},
"config": {"control_plane_endpoint": "https://acfe5f253f.cp0.konghq.com",
"telemetry_endpoint": "https://acfe5f253f.tp0.konghq.com",
"cluster_type": "CLUSTER_TYPE_HYBRID",
"auth_type": "pinned_client_certs",
"cloud_gateway": false,
"proxy_urls": [{"host": "example.com",
"port": 443,
"protocol": "https"
}
]
}
}

Fetch Runtime Group

Returns information about a team from a given team ID.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The runtime group ID

Responses

Response samples

Content type

application/json

{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "Test Runtime Group",
"description": "A test runtime group for exploration.",
"labels": {"test": "true"
},
"config": {"control_plane_endpoint": "https://acfe5f253f.cp0.konghq.com",
"telemetry_endpoint": "https://acfe5f253f.tp0.konghq.com",
"cluster_type": "CLUSTER_TYPE_HYBRID",
"auth_type": "pinned_client_certs",
"cloud_gateway": false,
"proxy_urls": [{"host": "example.com",
"port": 443,
"protocol": "https"
}
]
}
}

Update Runtime Group

Update an individual runtime group.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The runtime group ID

Request Body schema: application/json

name	string The name of the runtime group.
description	string The description of the runtime group in Konnect.
auth_type	string Enum: "pinned_client_certs" "pki_client_certs" The auth type value of the cluster associated with the Runtime Group.
	Array of objects (ProxyURLs) Array of proxy URLs associated with reaching the data-planes connected to a runtime group.
	object (Labels) Labels to facilitate tagged search on runtime groups. Keys must be of length 1-63 characters, and cannot start with 'kong', 'konnect', 'mesh', 'kic', or '_'.

Responses

Request samples

Payload

Content type

application/json

{"name": "Test Runtime Group",
"description": "A test runtime group for exploration.",
"labels": {"otherTest": "true"
}
}

Response samples

Content type

application/json

{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "Test Runtime Group",
"description": "A test runtime group for exploration.",
"labels": {"test": "true"
},
"config": {"control_plane_endpoint": "https://acfe5f253f.cp0.konghq.com",
"telemetry_endpoint": "https://acfe5f253f.tp0.konghq.com",
"cluster_type": "CLUSTER_TYPE_HYBRID",
"auth_type": "pinned_client_certs",
"cloud_gateway": false,
"proxy_urls": [{"host": "example.com",
"port": 443,
"protocol": "https"
}
]
}
}

Delete Runtime Group

Delete an individual runtime group.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string <uuid>

Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The runtime group ID

Responses

Response samples

Content type

application/problem+json

Example

Request Format Invalid

{"status": 400,
"title": "Bad Request",
"instance": "konnect:trace:3674017986744198214",
"invalid_parameters": [{"field": "body",
"reason": "request format is invalid"
}
]
}

Composite Runtime Groups

List Composite RG Memberships

Returns an array of runtime groups that are a member of this composite runtime group.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string

ID of a composite runtime group

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.

Responses

United-States Production region

https://us.api.konghq.com/v2/runtime-groups/{id}/composite-memberships

Europe Production region

https://eu.api.konghq.com/v2/runtime-groups/{id}/composite-memberships

Australia Production region

https://au.api.konghq.com/v2/runtime-groups/{id}/composite-memberships

Middle-East Production region

https://me.api.konghq.com/v2/runtime-groups/{id}/composite-memberships

India Production region

https://in.api.konghq.com/v2/runtime-groups/{id}/composite-memberships

Response samples

Content type

application/json

{"meta": {"page": {"total": 2,
"size": 100,
"number": 1
}
},
"data": [{"id": "774f2a35-509d-4b94-97e9-1ed49563bcb1",
"name": "Composite Member 1",
"description": "Child RG",
"labels": {"env": "prod"
},
"config": {"control_plane_endpoint": "https://9e0353434a.us.cp0.konghq.com",
"telemetry_endpoint": "https://9e0353434a.us.tp0.konghq.com",
"cluster_type": "CLUSTER_TYPE_HYBRID",
"auth_type": "pinned_client_certs",
"cloud_gateway": false,
"proxy_urls": [{"host": "example.com",
"port": 443,
"protocol": "https"
}
]
},
"created_at": "2023-03-20T22:23:45.873Z",
"updated_at": "2023-03-30T16:17:55.073Z"
},
{"id": "e4a1917c-bb26-4aa1-9a3e-50ee366f13db",
"name": "Composite Member 2",
"description": "Child RG",
"labels": {"env": "prod",
"foo": "bar"
},
"config": {"control_plane_endpoint": "https://05459046af.us.cp0.konghq.com",
"telemetry_endpoint": "https://05459046af.us.tp0.konghq.com",
"cluster_type": "CLUSTER_TYPE_HYBRID",
"auth_type": "pinned_client_certs",
"cloud_gateway": false,
"proxy_urls": [{"host": "example.com",
"port": 443,
"protocol": "https"
}
]
},
"created_at": "2023-03-23T22:25:30.907Z",
"updated_at": "2023-03-30T16:18:12.067Z"
}
]
}

Upsert Composite RG Members

Upserts runtime groups as a member of a composite runtime group.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string

ID of a composite runtime group

Request Body schema: application/json

Request body for upserting a list of child runtime groups to a composite runtime group membership.

Array of objects

Responses

United-States Production region

https://us.api.konghq.com/v2/runtime-groups/{id}/composite-memberships

Europe Production region

https://eu.api.konghq.com/v2/runtime-groups/{id}/composite-memberships

Australia Production region

https://au.api.konghq.com/v2/runtime-groups/{id}/composite-memberships

Middle-East Production region

https://me.api.konghq.com/v2/runtime-groups/{id}/composite-memberships

India Production region

https://in.api.konghq.com/v2/runtime-groups/{id}/composite-memberships

Request samples

Payload

Content type

application/json

{"members": [{"id": "1beb9ad3-d21b-4090-b6e3-574784d1166d"
},
{"id": "778a0474-687d-41af-8e51-a0488d790586"
},
{"id": "fa85f8e8-2e5a-496e-b6d0-4e534eaab459"
}
]
}

Response samples

400
401
403
404
503

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"
}
]
}

Add Composite RG Members

Adds one or more runtime groups as a member of a composite runtime group.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string

ID of a composite runtime group

Request Body schema: application/json

Request body for adding a list of child runtime groups to a composite runtime group membership.

Array of objects

Responses

United-States Production region

https://us.api.konghq.com/v2/runtime-groups/{id}/composite-memberships/add

Europe Production region

https://eu.api.konghq.com/v2/runtime-groups/{id}/composite-memberships/add

Australia Production region

https://au.api.konghq.com/v2/runtime-groups/{id}/composite-memberships/add

Middle-East Production region

https://me.api.konghq.com/v2/runtime-groups/{id}/composite-memberships/add

India Production region

https://in.api.konghq.com/v2/runtime-groups/{id}/composite-memberships/add

Request samples

Payload

Content type

application/json

{"members": [{"id": "1beb9ad3-d21b-4090-b6e3-574784d1166d"
},
{"id": "778a0474-687d-41af-8e51-a0488d790586"
},
{"id": "fa85f8e8-2e5a-496e-b6d0-4e534eaab459"
}
]
}

Response samples

400
401
403
404
503

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"
}
]
}

Remove Composite RG Members

Removes one or more runtime groups from the members of a composite runtime group.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string

ID of a composite runtime group

Request Body schema: application/json

Request body for removing a list of child runtime groups from a composite runtime group membership.

Array of objects

Responses

United-States Production region

https://us.api.konghq.com/v2/runtime-groups/{id}/composite-memberships/remove

Europe Production region

https://eu.api.konghq.com/v2/runtime-groups/{id}/composite-memberships/remove

Australia Production region

https://au.api.konghq.com/v2/runtime-groups/{id}/composite-memberships/remove

Middle-East Production region

https://me.api.konghq.com/v2/runtime-groups/{id}/composite-memberships/remove

India Production region

https://in.api.konghq.com/v2/runtime-groups/{id}/composite-memberships/remove

Request samples

Payload

Content type

application/json

{"members": [{"id": "1beb9ad3-d21b-4090-b6e3-574784d1166d"
},
{"id": "778a0474-687d-41af-8e51-a0488d790586"
},
{"id": "fa85f8e8-2e5a-496e-b6d0-4e534eaab459"
}
]
}

Response samples

400
401
403
404
503

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"
}
]
}

Composite Membership Status

Determines the composite membership status of a runtime group.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string

ID of a runtime group

Responses

United-States Production region

https://us.api.konghq.com/v2/runtime-groups/{id}/composite-member-status

Europe Production region

https://eu.api.konghq.com/v2/runtime-groups/{id}/composite-member-status

Australia Production region

https://au.api.konghq.com/v2/runtime-groups/{id}/composite-member-status

Middle-East Production region

https://me.api.konghq.com/v2/runtime-groups/{id}/composite-member-status

India Production region

https://in.api.konghq.com/v2/runtime-groups/{id}/composite-member-status

Response samples

Content type

application/json

{"is_member": true
}

Get Composite RG Status

Returns the status of a composite runtime group, including existing conflicts.

Authorizations:

personalAccessTokensystemAccountAccessToken

path Parameters

id

required

string

ID of a composite runtime group

Responses

United-States Production region

https://us.api.konghq.com/v2/runtime-groups/{id}/composite-status

Europe Production region

https://eu.api.konghq.com/v2/runtime-groups/{id}/composite-status

Australia Production region

https://au.api.konghq.com/v2/runtime-groups/{id}/composite-status

Middle-East Production region

https://me.api.konghq.com/v2/runtime-groups/{id}/composite-status

India Production region

https://in.api.konghq.com/v2/runtime-groups/{id}/composite-status

Response samples

Content type

application/json

Example

Composite Conflict Status Example

{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"conflicts": [{"cluster_id": "57fdf779-7935-476f-ab2b-7fa1323b70e6",
"description": "conflicting entity found: ID=df43b088-cace-4119-9e2a-d83e5fbb0c48, Name=svc1",
"resource": {"id": "df43b088-cace-4119-9e2a-d83e5fbb0c48",
"type": "service"
}
},
{"cluster_id": "38ceea96-fe39-11ed-be56-0242ac120002",
"description": "conflicting entity found: ID=15f3ab7d-7202-498a-95b4-334f783dbcdd, Name=svc1",
"resource": {"id": "15f3ab7d-7202-498a-95b4-334f783dbcdd",
"type": "service"
}
}
],
"state": "COMPOSITE_STATE_CONFLICT",
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}