Create a Workspace
Path Parameters
ID of a control plane
Body
application/json
Body
CreateWorkspaceRequest
The request schema for the create a workspace request.
The name of the workspace.
Example:team-1
The description of the workspace.
Example:A test workspace for team 1
The description of the workspace.
Example:A test workspace for team 1
Response
application/json
Response
A response to creating a workspace.
Workspace
Workspaces provide a way to segment Kong entities.
The unique UUID for this resource.
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 a Workspace
Get a Workspace using ID or name.
Path Parameters
ID of a control plane
ID or name of the workspace to retreive
Example:2747d1e5-8246-4f65-a939-b392f1ee17f8
Response
application/json
Response
A response to retrieving a single workspace.
Workspace
Workspaces provide a way to segment Kong entities.
The unique UUID for this resource.
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
Delete a Workspace
Delete an individual workspace.
Path Parameters
ID of a control plane
ID or name of the workspace to retreive
Example:2747d1e5-8246-4f65-a939-b392f1ee17f8
Response
Response
No Content
Authentication
Path Parameters
Upsert a Workspace
Create or Update Workspace using ID or name.
Path Parameters
ID of a control plane
ID or name of the workspace to retreive
Example:2747d1e5-8246-4f65-a939-b392f1ee17f8
Body
application/json
Body
Description of the Workspace
Workspace
Workspaces provide a way to segment Kong entities.
The unique UUID for this resource.
Response
application/json
Response
Successfully upserted Workspace
Workspace
Workspaces provide a way to segment Kong entities.
The unique UUID for this resource.
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
GroupSettings
objectWhether 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