Skip to main content
The GET /v1/objects endpoint returns a list of all objects stored in your Virtus Cloud Blob account. You can narrow results by filtering on a prefix and paginate through large collections using a continuation token. Responses from this endpoint are cached for 30 seconds, so very recent uploads may not appear immediately. Endpoint: GET https://blob.virtuscloud.app/v1/objects

Authentication

Include your API key in the Authorization header:
Authorization: <your-api-key>
See the Authentication page for details.

Query Parameters

prefix
string
Filter results to only objects whose name begins with this prefix. Must be 3–32 characters long and contain only letters (a–z, A–Z), digits (0–9), and underscores (_). If omitted, all objects in your account are returned.
continuationToken
string
A pagination token returned by a previous request when there are more results to fetch. Pass this value to retrieve the next page of results. Omit it to start from the beginning.

Example Request

curl -X GET "https://blob.virtuscloud.app/v1/objects?prefix=avatars" \
  -H "Authorization: <your-api-key>"

Response

status
string
Indicates whether the request succeeded. Returns "success" on success or "error" on failure.
response
object
Example Response (30s cache)
{
  "status": "success",
  "response": {
    "objects": [
      {
        "id": "ID/name1_ltq7b2sw-de6241.jpeg",
        "size": 78266,
        "created_at": "2024-03-13T19:31:28.776Z"
      },
      {
        "id": "ID/name_ltq7b2sw-de6243-ex1.jpeg",
        "size": 90466,
        "created_at": "2024-03-13T19:35:28.776Z",
        "expires_at": "2024-03-14T19:35:28.776Z"
      }
    ]
  }
}
This endpoint’s response is cached for 30 seconds. If you just uploaded a file and it does not appear, wait a moment and try again.

Troubleshooting

A 400 response means the prefix query parameter failed validation.
// The prefix contains disallowed characters or is outside 3–32 characters.
{
  "status": "error",
  "code": "INVALID_OBJECT_PREFIX"
}