Create a Workspace

post

Path Parameters

controlPlaneIdstring(uuid)required

ID of a control plane

Body

application/json

CreateWorkspaceRequest

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.

Response

application/json

A response to creating a workspace.

Workspace

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

post/control-planes/{controlPlaneId}/core-entities/workspaces

Body

{ "name": "Test Workspace", "comment": "A test workspace for team 1" }
 
application/json

Get a Workspace

Get a Workspace using ID or name.

get

Path Parameters

controlPlaneIdstring(uuid)required

ID of a control plane

workspaceIdOrNamestringrequired

ID or name of the workspace to retreive

Example:2747d1e5-8246-4f65-a939-b392f1ee17f8

Response

application/json

A response to retrieving a single workspace.

Workspace

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

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

Delete a Workspace

Delete an individual workspace.

delete

Path Parameters

controlPlaneIdstring(uuid)required

ID of a control plane

workspaceIdOrNamestringrequired

ID or name of the workspace to retreive

Example:2747d1e5-8246-4f65-a939-b392f1ee17f8

Response

No Content

delete/control-planes/{controlPlaneId}/core-entities/workspaces/{workspaceIdOrName}
 

Upsert a Workspace

Create or Update Workspace using ID or name.

put

Path Parameters

controlPlaneIdstring(uuid)required

ID of a control plane

workspaceIdOrNamestringrequired

ID or name of the workspace to retreive

Example:2747d1e5-8246-4f65-a939-b392f1ee17f8

Body

application/json

Description of the Workspace

Workspace

Workspaces provide a way to segment Kong entities.

idstring

The unique UUID for this resource.

namestringrequired
commentstring
descriptionstring
managed_byobject
* Additional properties are allowed.

Response

application/json

Successfully upserted Workspace

Workspace

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

put/control-planes/{controlPlaneId}/core-entities/workspaces/{workspaceIdOrName}

Body

{ "name": "name" }
 
application/json

GroupSettings

object
* 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

Example