Blob Object List - Square Cloud

GET

objects

Blob Object List

curl --request GET \
  --url https://blob.squarecloud.app/v1/objects \
  --header 'Authorization: <authorization>'

import requests

url = "https://blob.squarecloud.app/v1/objects"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://blob.squarecloud.app/v1/objects', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://blob.squarecloud.app/v1/objects",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://blob.squarecloud.app/v1/objects"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://blob.squarecloud.app/v1/objects")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://blob.squarecloud.app/v1/objects")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "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"
      }
    ],
    "continuationToken": null
  }
}

Authorization

string

required

The API key for your account. You can find this in your account settings.

Object List enumerates the files stored under your account, optionally scoped to a name prefix, and paginates through large buckets with a continuation token instead of returning everything at once. Use it to build a file browser, confirm an upload landed, or reconcile your own records against what Square Cloud actually holds. Each page is cached per account, prefix, and token for 30 minutes, so repeated calls with the same parameters are served from cache rather than hitting storage again. Calls beyond 10 requests per 30 seconds are blocked for 5 minutes. Objects uploaded with an expiration carry an expires_at field; permanent objects omit it. To remove an object once you’ve found its ID, see Object Delete; to upload new files, see Object Post.

prefix

string

A string representing the prefix for the file.
Must adhere to the a to z, A to Z, 0 to 9, and _ pattern. (3 to 32 characters)

continuationToken

string

A string representing the continuation token for the file list. (1000 objects per page)

Response

status

string

Indicates whether the call was successful. “success” if successful, “error” if not.

response

object

Show Toggle object

objects

array

Show Toggle object

string

The id of the object.

size

integer

The size of the object in bytes.

created_at

ISO 8601

The date and time the object was created.

expires_at

ISO 8601

The date and time the object will expire.

continuationToken

string

Token to fetch the next page; pass it back as the continuationToken query parameter. null or absent when there are no more objects.

{
  "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"
      }
    ],
    "continuationToken": null
  }
}

Troubleshooting

400 Status Code
401 Status Code
429 Status Code

// The provided object prefix is invalid.
// Must adhere to the a to z, A to Z, 0 to 9, and _ pattern.
{
    "status": "error",
    "code": "INVALID_OBJECT_PREFIX"
}

// The provided continuation token is invalid (must be a string up to 2048 characters).
{
    "status": "error",
    "code": "INVALID_CONTINUATION_TOKEN"
}

// The request to list the objects failed. Please try again.
{
    "status": "error",
    "code": "LIST_FAILED"
}

Unauthorized

// The API key is missing or invalid. Set a valid key in the Authorization header.
{
    "status": "error",
    "code": "ACCESS_DENIED"
}

Rate limited

// List rate limit reached (10 requests per 30s window).
{
    "status": "error",
    "code": "RATE_LIMITED"
}

Object PostThis documentation provides a comprehensive overview of the POST /v1/objects endpoint of the SquareCloud Blob API.

Blob Object List

curl --request GET \
  --url https://blob.squarecloud.app/v1/objects \
  --header 'Authorization: <authorization>'

import requests

url = "https://blob.squarecloud.app/v1/objects"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://blob.squarecloud.app/v1/objects', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://blob.squarecloud.app/v1/objects",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://blob.squarecloud.app/v1/objects"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://blob.squarecloud.app/v1/objects")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://blob.squarecloud.app/v1/objects")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "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"
      }
    ],
    "continuationToken": null
  }
}

​Response

​Troubleshooting

​Object-Related

​Unauthorized

​Rate limited

Response

Troubleshooting

Object-Related

Unauthorized

Rate limited