List catalog objects in a workspace

GET

/v1/storage/objects

GET

/v1/storage/objects

1 import requests
2 
3 url = "https://api.bctrl.ai/v1/storage/objects"
4 
5 querystring = {"workspace":"project-alpha","runtimeId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","source":"user-upload","driver":"s3","target":"archive","pathPrefix":"images/2024/","limit":"50","offset":"0"}
6 
7 payload = {}
8 headers = {
9     "Authorization": "Bearer <token>",
10     "Content-Type": "application/json"
11 }
12 
13 response = requests.get(url, json=payload, headers=headers, params=querystring)
14 
15 print(response.json())

200Retrieved

1 {
2   "objects": [
3     {
4       "contentType": "image/png",
5       "createdAt": "2024-06-10T09:15:30Z",
6       "driver": "s3",
7       "expiresAt": "2025-06-10T09:15:30Z",
8       "filename": "logo.png",
9       "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
10       "logicalPath": "images/2024/logo.png",
11       "metadata": {
12         "uploadedBy": "[email protected]",
13         "description": "Company logo in PNG format"
14       },
15       "runtimeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
16       "sizeBytes": 204800,
17       "source": "user-upload",
18       "target": "archive",
19       "workspace": "project-alpha"
20     }
21   ]
22 }

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Query parameters

workspacestringRequired

runtimeIdstringOptionalformat: "uuid"

sourcestringOptional

driverstringOptional

targetstringOptional

pathPrefixstringOptional

limitinteger or stringOptional

offsetinteger or stringOptional

Response

Default Response

objectslist of objects