Feature configuration for an organization

object
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

Example

AIManagerVirtualKey

object
consumerobjectrequired
Show Child Parameters
keystringrequired

The actual key value

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

Example

Workspace

object

Workspaces provide a way to segment Kong entities.

idstring

The unique UUID for this resource.

namestringrequired
commentstring
descriptionstring
managed_byobject
* Additional properties are allowed.
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

Example

CreateWorkspaceRequest

object

The request schema for the create a workspace request.

* Additional properties are NOT allowed.
namestringrequired

The name of the workspace.

Example:team-1

commentstring

The description of the workspace.

Example:A test workspace for team 1

descriptionstring

The description of the workspace.

Example:A test workspace for team 1

managed_byobject
* Additional properties are allowed.
Example

Error

object

standard error

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

typestringread-only

The error type.

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example