Upsert Control Plane Group Settings
Updates the settings of a control plane group. If the settings do not exist, they will be created.
Path Parameters
ID of a control plane group
Body
application/json
Body
GroupSettings
Whether the control plane group can be used to create workspaces.
Example:true
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
Response
A response to retrieving the settings of a control plane group.
GroupSettings
Whether the control plane group can be used to create workspaces.
Example:true
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
Authentication
Path Parameters
Body
Get Feature Configuration
Returns the feature configuration of an organization.
Path Parameters
The feature name for the configuration.
Allowed values:enterprise-ai-plugins
Response
application/json
Response
A response for getting or updating a feature configuration for an organization.
Feature configuration for an organization
The unique identifier for the feature configuration.
Allowed values:enterprise-ai-plugins
Whether this feature is enabled for the organization.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Upsert Feature Configuration
Path Parameters
The feature name for the configuration.
Allowed values:enterprise-ai-plugins
Body
application/json
Body
UpsertOrganizationFeatureRequest
The request schema for the upsert organization feature request.
Whether this feature is enabled for the organization.
Example:true
Response
application/json
Response
A response for getting or updating a feature configuration for an organization.
Feature configuration for an organization
The unique identifier for the feature configuration.
Allowed values:enterprise-ai-plugins
Whether this feature is enabled for the organization.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Get Control Plane Virtual Keys
Returns the Virtual Keys defined on a control plane.
Query Parameters
The ACL group name to filter
The consumer name to filter
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Path Parameters
ID of a control plane
Response
application/json
Response
AI Manager Virtual Keys
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Query Parameters
List all Workspaces
List all Workspaces
Query Parameters
Number of resources to be returned.
Default:100
>= 1<= 1000
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 by contains comparison of the name property with a supplied substring.
Example:test
Filter by direct equality comparison of the name property with a supplied value.
Example:test
Path Parameters
ID of a control plane
Response
application/json
Response
A paginated list response for a collection of workspaces.
ListWorkspacesResponse
Workspaces provide a way to segment Kong entities.
Show Child Parameters
URI to the next page (may be null)
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page