Upsert Control Plane Group Settings

Updates the settings of a control plane group. If the settings do not exist, they will be created.

put

Path Parameters

idstringrequired

ID of a control plane group

Body

application/json

GroupSettings

* Additional properties are NOT allowed.
workspaceableboolean

Whether the control plane group can be used to create workspaces.

Example:true

default_workspace_member_idstring

The default workspace member ID for the control plane group. This is used to determine the default workspace member for workspaces created in this control plane group.

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

Response

application/json

A response to retrieving the settings of a control plane group.

GroupSettings

* Additional properties are NOT allowed.
workspaceableboolean

Whether the control plane group can be used to create workspaces.

Example:true

default_workspace_member_idstring

The default workspace member ID for the control plane group. This is used to determine the default workspace member for workspaces created in this control plane group.

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

put/control-planes/{id}/group-settings

Body

{ "workspaceable": true, "default_workspace_member_id": "1beb9ad3-d21b-4090-b6e3-574784d1166d" }
 
application/json

Get Feature Configuration

Returns the feature configuration of an organization.

get

Path Parameters

featureNamestringrequiredread-only

The feature name for the configuration.

Allowed values:enterprise-ai-plugins

Response

application/json

A response for getting or updating a feature configuration for an organization.

Feature configuration for an organization

idstring(uuid)read-only

The unique identifier for the feature configuration.

namestringrequiredread-only

Allowed values:enterprise-ai-plugins

enabledbooleanrequired

Whether this feature is enabled for the organization.

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/control-planes/features/{featureName}
 
application/json

Upsert Feature Configuration

put

Path Parameters

featureNamestringrequiredread-only

The feature name for the configuration.

Allowed values:enterprise-ai-plugins

Body

application/json

UpsertOrganizationFeatureRequest

The request schema for the upsert organization feature request.

* Additional properties are NOT allowed.
enabledboolean

Whether this feature is enabled for the organization.

Example:true

Response

application/json

A response for getting or updating a feature configuration for an organization.

Feature configuration for an organization

idstring(uuid)read-only

The unique identifier for the feature configuration.

namestringrequiredread-only

Allowed values:enterprise-ai-plugins

enabledbooleanrequired

Whether this feature is enabled for the organization.

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

put/control-planes/features/{featureName}

Body

{}
 
application/json

Get Control Plane Virtual Keys

Returns the Virtual Keys defined on a control plane.

get

Query Parameters

filter[acl_group][eq]string

The ACL group name to filter

filter[consumer][contains]string

The consumer name to filter

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[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Path Parameters

controlPlaneIdstring(uuid)required

ID of a control plane

Response

application/json

AI Manager Virtual Keys

dataarray[object]required
Show Child Parameters
pageobject
Show Child Parameters
get/control-planes/{controlPlaneId}/ai-manager/virtual-keys
 
application/json

List all Workspaces

List all Workspaces

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

filter[name][contains]string

Filter by contains comparison of the name property with a supplied substring.

Example:test

filter[name][eq]string

Filter by direct equality comparison of the name property with a supplied value.

Example:test

Path Parameters

controlPlaneIdstring(uuid)required

ID of a control plane

Response

application/json

A paginated list response for a collection of workspaces.

ListWorkspacesResponse

* Additional properties are NOT allowed.
dataarray[object]required

Workspaces provide a way to segment Kong entities.

Show Child Parameters
nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/control-planes/{controlPlaneId}/core-entities/workspaces
 
application/json