Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pages/file-storage/api-cli/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: File Storage - API/CLI documentation
description: File Storage - API/CLI documentation
---
85 changes: 85 additions & 0 deletions pages/file-storage/api-cli/use-file-storage-cli.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: Using File Storage with the Scaleway CLI
description: This page lists basic commands to use Scaleway File Storage using the Scaleway Command Line Interface (CLI)
tags: cli command line interface terminal file storage system
dates:
validation: 2026-01-29
posted: 2026-01-29
---
import Requirements from '@macros/iam/requirements.mdx'

This page contains basic commands to manage your file systems using the Scaleway CLI.

<Requirements />

- A Scaleway account logged into the [console](https://console.scaleway.com)
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- [Installed and configured](/scaleway-cli/quickstart/) the Scaleway CLI

## Creating a file system

The following command allows you to create a file system:

```bash
scw file filesystem create name=<NAME> size=<SIZE_IN_BYTES>
```

## Listing your file systems

The following command allows you to list file systems present in your Organization:

```bash
scw file filesystem list
```

## Getting details on a file system

The following command allows you to get information about a given file system:

```bash
scw file filesystem get <FILE_SYSTEM_ID>
```

## Updating a file system

The following command allows you to modify the settings of a file system:

```bash
scw file filesystem update <FILE_SYSTEM_ID>
```

## Attaching a file system to an Instance

<Message type="note">
Attaching a file system to an Instance must be done using the Instances CLI. Refer to the [dedicated documentation](https://cli.scaleway.com/instance/#attach-a-filesystem-volume-to-an-instance) for more information.
</Message>

The following command allows you to attach a file system to an Instance:

```bash
scw instance server attach-filesystem server-id=<INSTANCE_ID> filesystem-id=<FILESYSTEM_ID>
```

Once your file system is attached to the desired Instance, you must mount it from within the Instance to use it. Refer to the [dedicated documentation](/file-storage/how-to/mount-file-system/) for more information.

## Detaching a file system from an Instance

<Message type="note">
Detaching a file system from an Instance must be done using the Instances CLI. Refer to the [dedicated documentation](https://cli.scaleway.com/instance/#detach-a-filesystem-volume-from-an-instance) for more information.
</Message>

The following command allows you to detach a file system from an Instance:

```bash
scw instance server detach-filesystem server-id=<INSTANCE_ID> filesystem-id=<FILESYSTEM_ID>
```

## Deleting a file system

The following command allows you to delete a given file system:

```bash
scw file filesystem delete <FILE_SYSTEM_ID>
```

For comprehensive information on the different CLI commands to interact with Scaleway File Storage (including the different arguments for each command), refer to the [dedicated Scaleway CLI documentation](https://cli.scaleway.com/file/).
10 changes: 10 additions & 0 deletions pages/file-storage/menu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@ export const fileStorageMenu = {
label: 'How to',
slug: 'how-to',
},
{
items: [
{
label:'Using File Storage with the Scaleway CLI',
slug:'use-file-storage-cli'
},
],
label:'API/CLI',
slug:'api-cli'
},
{
items: [
{
Expand Down
4 changes: 3 additions & 1 deletion pages/scaleway-cli/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ dates:
import Requirements from '@macros/iam/requirements.mdx'


The Scaleway command line interface (CLI) is a tool that allows you to pilot your Scaleway infrastructure and resources directly from your terminal. This page explains how to install and configure the CLI on your local machine.
The Scaleway Command Line Interface (CLI) is a tool that allows you to pilot your Scaleway infrastructure and resources directly from your terminal. It is built upon the Scaleway API, and provides a readable and user-friendly interface to interact with Scaleway products programmatically.

This page explains how to install and configure the CLI on your local machine.

<Message type="note">
Refer to the [Scaleway CLI repository](https://github.com/scaleway/scaleway-cli?tab=readme-ov-file#reference-documentation) for more information on the different commands.
Expand Down