Skip to main content
GET
/
v1
/
storage
/
objects
Get Object List from Storage
curl --request GET \
  --url https://api.example.com/v1/storage/objects \
  --header 'Authorization: Bearer <token>'
{
  "code": 200,
  "data": {
    "object_list": [
      "file1.txt",
      "pdf/file2.txt"
    ]
  },
  "exception": null,
  "success": true
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Include the token in the Authorization header as 'Bearer '

Query Parameters

​
path
string | null

Path(Key) of the objects to get. It ends with "/". e.g. "path/to/folder/"

​
extension
string | null

Extension of the objects to get. (e.g. "txt", "pdf", "parquet")

​
file_name
string | null

File name of the objects to get.

​
include_metadata
boolean | null

Include VSync processing metadata for each file. Default: false. When true, the response includes metadata field with processing status from vsync-light.

Response

Success to get object file list from storage.

​
code
integer<int32>
required

HTTP status code.

Required range: x >= 0
​
success
boolean
required

Whether the request was successful.

​
data
object
​
exception
object