Attach a drive to a local path

Mounts an agent drive using the blfs binary to a local path, optionally mounting a subpath within the drive. Supports optional UID/GID mapping to remap file ownership between the local sandbox and the filer (always mapped to filer UID/GID 0). Mapping values can be set per-request via uidMap/gidMap fields, or globally via BLFS_UID_MAP/BLFS_GID_MAP environment variables (request values take precedence).

POST /drives/mount

Attach a drive to a local path

cURL

curl --request POST \
  --url https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/drives/mount \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "driveName": "<string>",
  "mountPath": "<string>",
  "drivePath": "<string>",
  "gidMap": "<string>",
  "readOnly": true,
  "uidMap": "<string>"
}
'

import requests

url = "https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/drives/mount"

payload = {
    "driveName": "<string>",
    "mountPath": "<string>",
    "drivePath": "<string>",
    "gidMap": "<string>",
    "readOnly": True,
    "uidMap": "<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({
    driveName: '<string>',
    mountPath: '<string>',
    drivePath: '<string>',
    gidMap: '<string>',
    readOnly: true,
    uidMap: '<string>'
  })
};

fetch('https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/drives/mount', 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://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/drives/mount",
  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([
    'driveName' => '<string>',
    'mountPath' => '<string>',
    'drivePath' => '<string>',
    'gidMap' => '<string>',
    'readOnly' => true,
    'uidMap' => '<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://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/drives/mount"

	payload := strings.NewReader("{\n  \"driveName\": \"<string>\",\n  \"mountPath\": \"<string>\",\n  \"drivePath\": \"<string>\",\n  \"gidMap\": \"<string>\",\n  \"readOnly\": true,\n  \"uidMap\": \"<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://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/drives/mount")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"driveName\": \"<string>\",\n  \"mountPath\": \"<string>\",\n  \"drivePath\": \"<string>\",\n  \"gidMap\": \"<string>\",\n  \"readOnly\": true,\n  \"uidMap\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/drives/mount")

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  \"driveName\": \"<string>\",\n  \"mountPath\": \"<string>\",\n  \"drivePath\": \"<string>\",\n  \"gidMap\": \"<string>\",\n  \"readOnly\": true,\n  \"uidMap\": \"<string>\"\n}"

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

200

{
  "driveName": "<string>",
  "drivePath": "<string>",
  "gidMap": "<string>",
  "message": "<string>",
  "mountPath": "<string>",
  "readOnly": true,
  "success": true,
  "uidMap": "<string>"
}

{
  "error": "Error message"
}

{
  "error": "Error message"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Drive attachment parameters

driveName · string · required

mountPath · string · required

drivePath · string

Optional, defaults to "/"

gidMap · string

Optional, local GID to map (filer GID is always 0)

readOnly · boolean

Optional, defaults to false

uidMap · string

Optional, local UID to map (filer UID is always 0)

Response

200

application/json

OK

driveName · string

drivePath · string

gidMap · string

The local GID used for this mount

message · string

mountPath · string

readOnly · boolean

success · boolean

uidMap · string

The local UID used for this mount