Workspaces - Go SDK
Workspaces - Go SDK
The Go SDK and docs are currently in beta. Report issues on GitHub.
Overview
Workspaces endpoints
Available Operations
- List - List workspaces
- Create - Create a workspace
- Delete - Delete a workspace
- Get - Get a workspace
- Update - Update a workspace
- ListBudgets - List workspace budgets
- DeleteBudget - Delete a workspace budget
- SetBudget - Create or update a workspace budget
- BulkAddMembers - Bulk add members to a workspace
- BulkRemoveMembers - Bulk remove members from a workspace
List
List all workspaces for the authenticated user. Management key required.
Example Usage
Parameters
Response
*operations.ListWorkspacesResponse, error
Errors
Create
Create a new workspace for the authenticated user. Management key required.
Example Usage
Parameters
Response
*components.CreateWorkspaceResponse, error
Errors
Delete
Delete an existing workspace. The default workspace cannot be deleted. Workspaces with active API keys cannot be deleted. Management key required.
Example Usage
Parameters
Response
*components.DeleteWorkspaceResponse, error
Errors
Get
Get a single workspace by ID or slug. Management key required.
Example Usage
Parameters
Response
*components.GetWorkspaceResponse, error
Errors
Update
Update an existing workspace by ID or slug. Management key required.
Example Usage
Parameters
Response
*components.UpdateWorkspaceResponse, error
Errors
ListBudgets
List all budgets configured for a workspace. Management key required.
Example Usage
Parameters
Response
*components.ListWorkspaceBudgetsResponse, error
Errors
DeleteBudget
Remove the budget for a given interval. Management key required.
Example Usage
Parameters
Response
*components.DeleteWorkspaceBudgetResponse, error
Errors
SetBudget
Create or update the budget for a given interval. Budget limits must strictly decrease as the interval narrows (lifetime > monthly > weekly > daily). Management key required.
Example Usage
Parameters
Response
*components.UpsertWorkspaceBudgetResponse, error
Errors
BulkAddMembers
Add multiple organization members to a workspace. Members are assigned the same role they hold in the organization. Management key required.
Example Usage
Parameters
Response
*components.BulkAddWorkspaceMembersResponse, error
Errors
BulkRemoveMembers
Remove multiple members from a workspace. Members with active API keys in the workspace cannot be removed. Management key required.
Example Usage
Parameters
Response
*components.BulkRemoveWorkspaceMembersResponse, error