Authorize Cloud Service

Links a cloud storage provider (Google Drive, S3, Backblaze B2, Dropbox, or gated Hugging Face Storage Buckets) to the authenticated user’s account using OAuth or credentials.

POST /api/v0/users/cloud/

Authorize Cloud Service

cURL

curl --request POST \
  --url https://console.vast.ai/api/v0/users/cloud/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "provider": "s3",
  "user_given_name": "<string>",
  "secret_access_key": "<string>",
  "access_key": "<string>",
  "namespace": "<string>",
  "application_key": "<string>",
  "key_id": "<string>",
  "state": "<string>"
}
'

import requests

url = "https://console.vast.ai/api/v0/users/cloud/"

payload = {
    "code": "<string>",
    "provider": "s3",
    "user_given_name": "<string>",
    "secret_access_key": "<string>",
    "access_key": "<string>",
    "namespace": "<string>",
    "application_key": "<string>",
    "key_id": "<string>",
    "state": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    code: '<string>',
    provider: 's3',
    user_given_name: '<string>',
    secret_access_key: '<string>',
    access_key: '<string>',
    namespace: '<string>',
    application_key: '<string>',
    key_id: '<string>',
    state: '<string>'
  })
};

fetch('https://console.vast.ai/api/v0/users/cloud/', 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://console.vast.ai/api/v0/users/cloud/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'code' => '<string>',
    'provider' => 's3',
    'user_given_name' => '<string>',
    'secret_access_key' => '<string>',
    'access_key' => '<string>',
    'namespace' => '<string>',
    'application_key' => '<string>',
    'key_id' => '<string>',
    'state' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://console.vast.ai/api/v0/users/cloud/"

	payload := strings.NewReader("{\n  \"code\": \"<string>\",\n  \"provider\": \"s3\",\n  \"user_given_name\": \"<string>\",\n  \"secret_access_key\": \"<string>\",\n  \"access_key\": \"<string>\",\n  \"namespace\": \"<string>\",\n  \"application_key\": \"<string>\",\n  \"key_id\": \"<string>\",\n  \"state\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://console.vast.ai/api/v0/users/cloud/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"<string>\",\n  \"provider\": \"s3\",\n  \"user_given_name\": \"<string>\",\n  \"secret_access_key\": \"<string>\",\n  \"access_key\": \"<string>\",\n  \"namespace\": \"<string>\",\n  \"application_key\": \"<string>\",\n  \"key_id\": \"<string>\",\n  \"state\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.vast.ai/api/v0/users/cloud/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"code\": \"<string>\",\n  \"provider\": \"s3\",\n  \"user_given_name\": \"<string>\",\n  \"secret_access_key\": \"<string>\",\n  \"access_key\": \"<string>\",\n  \"namespace\": \"<string>\",\n  \"application_key\": \"<string>\",\n  \"key_id\": \"<string>\",\n  \"state\": \"<string>\"\n}"

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

200

{
  "success": true,
  "msg": "<string>"
}

{
  "error": "<string>",
  "msg": "<string>"
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Body

application/json

code · string

OAuth authorization code (required for Google Drive and Dropbox providers).

provider · enum<string>

Cloud storage provider to connect.

Available options: drive, s3, b2, dropbox, hf

Example:

"s3"

user_given_name · string

User-supplied name for this connection (required for all providers except Dropbox, which uses the name from the OAuth flow).

secret_access_key · string

Secret Access Key (required for S3 and HF).

access_key · string

Access Key ID (required for S3 and HF; HF keys must begin with HFAK).

namespace · string

Hugging Face user or organization namespace as one safe URL path segment (required for HF).

application_key · string

Backblaze Application Key secret (required for B2 provider).

key_id · string

Backblaze Application Key ID (required for B2 provider).

state · string

OAuth state parameter returned from Dropbox redirect (required for Dropbox provider).

Response

200

application/json

Success (Dropbox): {"success": true, "msg": "Dropbox Authenticated"}

success · boolean

Always true

msg · string

Confirmation message (e.g. "Dropbox Authenticated")