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
Authentication
Path Parameters
Query Parameters
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