Get a volume version - Baseten

GET

/

v1

/

volumes

/

{volume_namespace}

/

{volume_name}

/

versions

/

{volume_version}

cURL

curl --request GET \
--url https://api.baseten.co/v1/volumes/{volume_namespace}/{volume_name}/versions/{volume_version} \
--header "Authorization: Bearer $BASETEN_API_KEY"

import requests
import os
API_KEY = os.environ.get("BASETEN_API_KEY", "<YOUR_API_KEY>")
url = "https://api.baseten.co/v1/volumes/{volume_namespace}/{volume_name}/versions/{volume_version}"

headers = {"Authorization": f"Bearer {API_KEY}"}

response = requests.request(
    "GET",
    url,
    headers=headers,
    json={}
)

print(response.text)

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

fetch('https://api.baseten.co/v1/volumes/{volume_namespace}/{volume_name}/versions/{volume_version}', 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://api.baseten.co/v1/volumes/{volume_namespace}/{volume_name}/versions/{volume_version}",
  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: Bearer <token>"
  ],
]);

$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://api.baseten.co/v1/volumes/{volume_namespace}/{volume_name}/versions/{volume_version}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.baseten.co/v1/volumes/{volume_namespace}/{volume_name}/versions/{volume_version}")

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

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

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

{
  "namespace": "<string>",
  "volume": "<string>",
  "version_ref": "<string>",
  "digest": "<string>",
  "sequence": 123,
  "lifecycle": "<string>",
  "is_head": true,
  "tags": [
    "<string>"
  ],
  "total_size_bytes": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "tombstoned_at": "2023-11-07T05:31:56Z",
  "delete_after": "2023-11-07T05:31:56Z",
  "entry_count": 123,
  "volume_sequence": 123
}

Authorizations

Authorization

string

header

required

Send Authorization: Bearer <api_key>. The legacy Authorization: Api-Key <api_key> scheme is also accepted.

Path Parameters

volume_namespace

string

required

volume_name

string

required

volume_version

string

required

Response

200 - application/json

One version, with the fields only a single-version read reports.

namespace

string

required

Namespace the volume belongs to, in lowercase.

volume

string

required

Name of the volume, in lowercase.

version_ref

string

required

Full address of this version, as bdn:<namespace>/<volume>@<digest>. Paste this into the bdn.mounts section of a config.yaml to pin to it.

digest

string

required

Content digest of the version, as b3:<hex>.

sequence

integer | null

required

Revision the version was committed at. Null for versions committed before the volume service recorded it.

lifecycle

string

required

Lifecycle state of the version: ALIVE, or TOMBSTONED once it has been deleted or has expired.

is_head

boolean

required

Whether the reserved head tag points at this version.

tags

string[]

required

Tags pointing at this version that your API key can read.

total_size_bytes

integer | null

required

Total size of the version's files in bytes. Null when not recorded.

created_at

string<date-time>

required

When the version was committed, in ISO 8601 format.

expires_at

string<date-time> | null

required

When the version expires, in ISO 8601 format. At that instant it becomes TOMBSTONED with tombstoned_at set to this value, and every tag pointing at it drops. Null for a version that never expires, and null once the lifecycle is TOMBSTONED.

tombstoned_at

string<date-time> | null

required

When the version was deleted or expired, in ISO 8601 format. Null unless the lifecycle is TOMBSTONED.

delete_after

string<date-time> | null

required

When the version stops being restorable, in ISO 8601 format. Null unless the lifecycle is TOMBSTONED.

entry_count

integer | null

required

Number of files in the version. Null when not recorded.

volume_sequence

integer

required

Revision of the volume as a whole when this version was read. Pass it as expected_sequence on a later delete to make that delete conditional on the volume not having changed since.

⌘I

cURL

curl --request GET \
--url https://api.baseten.co/v1/volumes/{volume_namespace}/{volume_name}/versions/{volume_version} \
--header "Authorization: Bearer $BASETEN_API_KEY"

import requests
import os
API_KEY = os.environ.get("BASETEN_API_KEY", "<YOUR_API_KEY>")
url = "https://api.baseten.co/v1/volumes/{volume_namespace}/{volume_name}/versions/{volume_version}"

headers = {"Authorization": f"Bearer {API_KEY}"}

response = requests.request(
    "GET",
    url,
    headers=headers,
    json={}
)

print(response.text)

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

fetch('https://api.baseten.co/v1/volumes/{volume_namespace}/{volume_name}/versions/{volume_version}', 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://api.baseten.co/v1/volumes/{volume_namespace}/{volume_name}/versions/{volume_version}",
  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: Bearer <token>"
  ],
]);

$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://api.baseten.co/v1/volumes/{volume_namespace}/{volume_name}/versions/{volume_version}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.baseten.co/v1/volumes/{volume_namespace}/{volume_name}/versions/{volume_version}")

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

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

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

{
  "namespace": "<string>",
  "volume": "<string>",
  "version_ref": "<string>",
  "digest": "<string>",
  "sequence": 123,
  "lifecycle": "<string>",
  "is_head": true,
  "tags": [
    "<string>"
  ],
  "total_size_bytes": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "tombstoned_at": "2023-11-07T05:31:56Z",
  "delete_after": "2023-11-07T05:31:56Z",
  "entry_count": 123,
  "volume_sequence": 123
}