Displaying all buckets owned by a user

post /v1/user/list_buckets

Retrieves a list of buckets owned by VSP One Object users, filtered by user ID and bucket name. You can also apply filters to return a subset of results.

Request headers

X-XSRF-TOKEN String required

XSRF token header for CSRF security. Can be obtained as the value of a cookie by performing a GET on /csrf.

Example: xXSRFTOKEN_example

Cookie String required

XSRF token header for CSRF security. Can be obtained as the value of a cookie by performing a GET on /csrf.

Example: cookie_example

CLIENT REQUEST

          curl -X 'POST'

        -H
        'Accept: application/json'
      
          -H
          'X-XSRF-TOKEN: xXSRFTOKEN_example'
          -H
          'Cookie: cookie_example'
      
      'http://localhost/v1/user/list_buckets'
    
      -d
      '{
  "count" : 602,
  "id" : 0,
  "pageToken" : "pageToken"
}'

import http.client

conn = http.client.HTTPConnection("undefinedundefined")

headers = {
    'X-XSRF-TOKEN': "SOME_STRING_VALUE",
    'Cookie': "SOME_STRING_VALUE"
    }

conn.request("POST", "/v1/user/list_buckets", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'

url = URI("http://undefinedundefined/v1/user/list_buckets")

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

request = Net::HTTP::Post.new(url)
request["X-XSRF-TOKEN"] = 'SOME_STRING_VALUE'
request["Cookie"] = 'SOME_STRING_VALUE'

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

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "http://undefinedundefined/v1/user/list_buckets");
xhr.setRequestHeader("X-XSRF-TOKEN", "SOME_STRING_VALUE");
xhr.setRequestHeader("Cookie", "SOME_STRING_VALUE");

xhr.send(data);

HttpResponse<String> response = Unirest.post("http://undefinedundefined/v1/user/list_buckets")
  .header("X-XSRF-TOKEN", "SOME_STRING_VALUE")
  .header("Cookie", "SOME_STRING_VALUE")
  .asString();

import Foundation

let headers = [
  "X-XSRF-TOKEN": "SOME_STRING_VALUE",
  "Cookie": "SOME_STRING_VALUE"
]

let request = NSMutableURLRequest(url: NSURL(string: "http://undefinedundefined/v1/user/list_buckets")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://undefinedundefined/v1/user/list_buckets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Cookie: SOME_STRING_VALUE",
    "X-XSRF-TOKEN: SOME_STRING_VALUE"
  ],
]);

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

curl_close($curl);

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

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "http://undefinedundefined/v1/user/list_buckets");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "X-XSRF-TOKEN: SOME_STRING_VALUE");
headers = curl_slist_append(headers, "Cookie: SOME_STRING_VALUE");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("http://undefinedundefined/v1/user/list_buckets");
var request = new RestRequest(Method.POST);
request.AddHeader("X-XSRF-TOKEN", "SOME_STRING_VALUE");
request.AddHeader("Cookie", "SOME_STRING_VALUE");
IRestResponse response = client.Execute(request);

Body parameters

required

*/*

idintegerrequired

ID of the user

countinteger

Number of buckets to return

pageTokenstring

Page token from previous request, to start listing from. Leave blank to start from the beginning of the list.

REQUEST
[*/* content]

Responses

The buckets owned by the given user are listed in the response.

Body

application/json

bucketsarray

Buckets returned from the listing.

[

bucketIdinteger

ID of the bucket

bucketNamestring

Bucket name

]

pageTokenstring

Page token that can be used in future requests to continue listing from last result.

RESPONSE
{
  "buckets": [
    {
      "bucketId": 0,
      "bucketName": "example"
    }
  ],
  "pageToken": "example"
}

The request was missing a user id or parameters are invalid.

Body

application/json

codestring

Error code

messagestring

Error message

detailsstring

Error details

RESPONSE
{
  "code": "example",
  "message": "example",
  "details": "example"
}

Access was denied due to invalid credentials.

The user id could not be found.

Body

application/json

codestring

Error code

messagestring

Error message

detailsstring

Error details

RESPONSE
{
  "code": "example",
  "message": "example",
  "details": "example"
}

The specified HTTP method is not allowed. Please resend the request using the POST method.