Skip to content

Commit e05be1c

Browse files
jirkasemmlerclaude
andcommitted
docs: add Apiary documentation for batch delete workspace objects endpoint
Documents POST /v2/storage/workspaces/{workspace_id}/objects/batch-delete and the development branch variant for DMD-904. Refs: DMD-904 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent e73650a commit e05be1c

1 file changed

Lines changed: 108 additions & 0 deletions

File tree

apiary.apib

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6041,6 +6041,114 @@ Returns a list of objects (tables and views) present in the workspace schema in
60416041
Returned when the workspace backend is not supported.
60426042
60436043
6044+
## Batch Delete Workspace Objects [/v2/storage/workspaces/{workspace_id}/objects/batch-delete]
6045+
6046+
### Batch Delete Workspace Objects [POST]
6047+
6048+
Deletes multiple tables and views from a workspace in a single async operation. Returns a job. All objects are attempted even if some fail, but the job will be marked as failed if any deletion fails.
6049+
6050+
+ Parameters
6051+
+ workspace_id (required, number) - Workspace ID
6052+
6053+
+ Request (application/json)
6054+
+ Headers
6055+
6056+
X-StorageApi-Token: your_token
6057+
6058+
+ Body
6059+
6060+
{
6061+
"objects": ["MY_TABLE", "MY_VIEW"]
6062+
}
6063+
6064+
+ Response 202 (application/json)
6065+
6066+
+ Body
6067+
6068+
{
6069+
"id": 12345,
6070+
"status": "waiting",
6071+
"url": "https://connection.keboola.com/v2/storage/jobs/12345",
6072+
"operationName": "workspaceBatchDeleteObjects",
6073+
"operationParams": {
6074+
"params": {
6075+
"objects": ["MY_TABLE", "MY_VIEW"]
6076+
}
6077+
},
6078+
"createdTime": "2013-05-31T16:11:05+0200",
6079+
"startTime": null,
6080+
"endTime": null,
6081+
"runId": null,
6082+
"results": null,
6083+
"creatorToken": {
6084+
"id": "27978",
6085+
"description": "user@keboola.com"
6086+
}
6087+
}
6088+
6089+
+ Response 404 (application/json)
6090+
6091+
Returned when the workspace is not found.
6092+
6093+
+ Response 422 (application/json)
6094+
6095+
Returned when the request body is invalid (e.g. empty objects list).
6096+
6097+
## Batch Delete Development Branch Workspace Objects [/v2/storage/branch/{branch_id}/workspaces/{workspace_id}/objects/batch-delete]
6098+
6099+
### Batch Delete Development Branch Workspace Objects [POST]
6100+
6101+
Deletes multiple tables and views from a workspace in a [Development Branch](#reference/development-branches) in a single async operation. Returns a job. All objects are attempted even if some fail, but the job will be marked as failed if any deletion fails.
6102+
6103+
+ Parameters
6104+
+ branch_id (required) - Id of the development branch
6105+
+ workspace_id (required, number) - Workspace ID
6106+
6107+
+ Request (application/json)
6108+
+ Headers
6109+
6110+
X-StorageApi-Token: your_token
6111+
6112+
+ Body
6113+
6114+
{
6115+
"objects": ["MY_TABLE", "MY_VIEW"]
6116+
}
6117+
6118+
+ Response 202 (application/json)
6119+
6120+
+ Body
6121+
6122+
{
6123+
"id": 12345,
6124+
"status": "waiting",
6125+
"url": "https://connection.keboola.com/v2/storage/jobs/12345",
6126+
"operationName": "workspaceBatchDeleteObjects",
6127+
"operationParams": {
6128+
"params": {
6129+
"objects": ["MY_TABLE", "MY_VIEW"]
6130+
}
6131+
},
6132+
"createdTime": "2013-05-31T16:11:05+0200",
6133+
"startTime": null,
6134+
"endTime": null,
6135+
"runId": null,
6136+
"results": null,
6137+
"creatorToken": {
6138+
"id": "27978",
6139+
"description": "user@keboola.com"
6140+
}
6141+
}
6142+
6143+
+ Response 404 (application/json)
6144+
6145+
Returned when the workspace is not found.
6146+
6147+
+ Response 422 (application/json)
6148+
6149+
Returned when the request body is invalid (e.g. empty objects list).
6150+
6151+
60446152
## Data Structures
60456153
60466154
### Workspace

0 commit comments

Comments
 (0)