Sign in
Volumes

Create a volume

Provisions a persistent volume synchronously. Volumes are backed by Brimble's globally distributed S3-compatible object storage; when the response returns the disk is allocated and ready to attach to a sandbox or project.

Names are unique per user. Region is permanently pinned at creation; volumes can only attach to sandboxes / projects in the same region.

type declares the surface this volume is intended for and drives where it shows up in attach pickers:

  • web, project disk (default)
  • sandbox, sandbox disk
post/volumes

Request body

namestring required

Lowercase letters, digits, hyphens; 1–40 chars. Unique per user.

sizeGBinteger required

Disk size in GB. Subject to plan caps.

regionstring required

Region id from GET /v1/regions. Cannot be changed after creation.

type'web' | 'sandbox'

Which surface a volume is intended for:

  • web, project disk (default)
  • sandbox, sandbox disk
teamIdstring

Create the volume under a team you're a member of. Copy the team ID from the team's settings page in the dashboard. Omit for a personal volume.

Response

Volume created

messagestring required

Example response

{
  "message": "Volume fetched",
  "data": {
    "region": {
      "id": "6a06df21cc6bef51342e199e",
      "name": "eu-west",
      "country": "France",
      "continent": "Europe"
    }
  }
}

Changes

Changed in 1 of the 5 revisions of this API.2

  • b236bf76f9a72See the full diff
    • ○

      added SandboxRegion to the data/region response property allOf list for the response status 201

      response-property-all-of-added

    • ○

      removed RegionSummary from the data/region response property allOf list for the response status 201

      response-property-all-of-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog