File Storage API

v1alpha1

Introduction

Scaleway File Storage provides network-attached storage that can be attached to cloud products such as Instances. File Storage can be accessed simultaneously by multiple Instances in the same region.

Important

This API documentation is for File Storage Service. File Storage can only be accessed through Private Networks.

Quickstart

Configure environment:

export SCW_SECRET_KEY="<API secret key>" 
export SCW_DEFAULT_REGION="<Scaleway Region>"
export SCW_PROJECT_ID="<Scaleway Project ID>"

Create a Scaleway File Storage:

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  https://api.scaleway.com/file/v1alpha1/regions/$SCW_DEFAULT_REGION/filesystems \
  -d '{
    "project_id": "'"$SCW_PROJECT_ID"'",
    "name": "my-fs",
    "size": 30000000000,
  }'

Attach a Scaleway File Storage:

curl -X POST 'https://api.scaleway.com/instance/v1/zones/$SCW_DEFAULT_REGION/servers/<instance-id>/attach-filesystem' \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"filesystem_id": "<my-fs-id>"}'

Delete a Scaleway File Storage:

curl -X DELETE 'https://api.scaleway.com/file/v1alpha1/regions/$SCW_DEFAULT_REGION/filesystems/<filesystem-id>' \
-H "x-Auth-Token: $SCW_SECRET_KEY"

Update a Scaleway File Storage:

curl --request PATCH https://api.scaleway.com/file/v1alpha1/regions/$SCW_DEFAULT_REGION/filesystems/<filesystem-id>' \
--header 'Content-Type: application/json' \
--header "x-Auth-Token: $SCW_SECRET_KEY" \
--data '{
  "name": "my-new-fs-name",
  "size": 200000000000,
  "tags": [] 
  }'

You have a Scaleway account
You have created an API key and that the API key has sufficient IAM permissions to perform the actions described on this page
You have installed curl </Message>

FileSystem

A filesystem is a network-attached shared storage system that can be connected to multiple Instances simultaneously. Filesystems are accessible in read/write modes, and can be created with different sizes.

GET/file/v1alpha1/regions/{region}/filesystems

POST/file/v1alpha1/regions/{region}/filesystems

GET/file/v1alpha1/regions/{region}/filesystems/{filesystem_id}

PATCH/file/v1alpha1/regions/{region}/filesystems/{filesystem_id}

DELETE/file/v1alpha1/regions/{region}/filesystems/{filesystem_id}

Attachment

An attachment links a filesystem and a Scaleway resource (such as an Instance). An attachment is created when a filesystem is mounted to a resource, and is deleted when a filesystem is unmounted from a resource.

GET/file/v1alpha1/regions/{region}/attachments