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>"
}
'

200

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

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