Skip to content

Commit 58bd94d

Browse files
docs(fls): add CLI / API docs (#5734)
* docs(fls): add links to k8s doc * docs(fls): add links to k8s doc * docs(fls): add links to k8s doc * docs(fls): update * Update pages/file-storage/how-to/attach-file-system.mdx Co-authored-by: Néda <[email protected]> * Update pages/file-storage/quickstart.mdx Co-authored-by: Néda <[email protected]> * Update pages/file-storage/how-to/attach-file-system.mdx Co-authored-by: Néda <[email protected]> --------- Co-authored-by: Néda <[email protected]>
1 parent e27bf28 commit 58bd94d

File tree

3 files changed

+44
-4
lines changed

3 files changed

+44
-4
lines changed

pages/file-storage/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: File Storage FAQ
33
description: Explore Scaleway File Storage with our comprehensive FAQ covering performance, persistence, and more.
44
dates:
5-
created: 2025-07-23
5+
created: 2025-10-30
66
validation: 2025-07-23
77
category: storage
88
productIcon: FileProductIcon

pages/file-storage/how-to/attach-file-system.mdx

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ categories:
66
- storage
77
- file-storage
88
dates:
9-
validation: 2025-07-23
9+
validation: 2025-10-30
1010
posted: 2025-07-23
1111
---
1212

@@ -21,7 +21,7 @@ import Requirements from '@macros/iam/requirements.mdx'
2121
- [Created a file system](/file-storage/how-to/create-file-system/)
2222
- [Created at least one POP2 Instance](/instances/how-to/create-an-instance/)
2323

24-
## How to attach a file system to an Instance
24+
## How to attach a file system using the Scaleway console
2525

2626
1. Click **File Storage** in the **Storage** section of the side menu. A list of your file systems displays.
2727

@@ -39,3 +39,41 @@ import Requirements from '@macros/iam/requirements.mdx'
3939

4040
Your file system is now attached to the selected Instance(s) and can now be [mounted](/file-storage/how-to/mount-file-system/) to a Scaleway Instance.
4141

42+
## How to attach a file system using the API
43+
44+
The Scaleway API allows you to create and manage all your resources programmatically.
45+
46+
<Message type="note">
47+
To attach a file system to an Instance, you must use the [Instance API](https://www.scaleway.com/en/developers/api/instances/#path-instances-attach-a-filesystem-volume-to-an-instance).
48+
</Message>
49+
50+
1. Make sure you have [authenticated and performed your first request](https://www.scaleway.com/en/developers/api/#quickstart-first-request) with the Scaleway API.
51+
52+
2. Run the cURL request below to attach your file system to the desired Instance. Remember to replace the placeholders with the appropriate values.
53+
54+
```bash
55+
curl -X POST 'https://api.scaleway.com/instance/v1/zones/<region>/servers/<instance-id>/attach-filesystem' \
56+
-H "X-Auth-Token: $SCW_SECRET_KEY" \
57+
-H "Content-Type: application/json" \
58+
-d '{"filesystem_id": "<my-fs-id>"}'
59+
```
60+
61+
Refer to the [Scaleway API documentation](https://www.scaleway.com/en/developers/api/instances/#path-instances-attach-a-filesystem-volume-to-an-instance) for more information on the different parameters.
62+
63+
## How to attach a file system using the CLI
64+
65+
Scaleway CLI is a tool to help you pilot your Scaleway infrastructure directly from your terminal.
66+
67+
<Message type="note">
68+
To attach a file system to an Instance, you must use the [Instance CLI](https://cli.scaleway.com/instance/#attach-a-filesystem-volume-to-an-instance).
69+
</Message>
70+
71+
1. Make sure you have [installed and configured the Scaleway CLI](/scaleway-cli/quickstart/).
72+
73+
2. Run the command below to attach your file system to the desired Instance. Remember to replace the placeholders with the appropriate values.
74+
75+
```bash
76+
scw instance server attach-filesystem server-id=<instance_id> filesystem-id=<filesystem_id> zone=<availability_zone>
77+
```
78+
79+
Refer to the [Scaleway CLI documentation](https://cli.scaleway.com/instance/#attach-a-filesystem-volume-to-an-instance) for more information on the different parameters.

pages/file-storage/quickstart.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,9 @@ To attach a file system to an Instance, you must have [created at least one POP2
7474
File systems can only be attached to POP2 Instances within the same [region](/file-storage/concepts/#region).
7575
</Message>
7676

77-
Your file system is now attached to the selected Instance(s) and can now be [mounted](/file-storage/how-to/mount-file-system/) to a Scaleway Instance.
77+
Your file system is now attached to the selected Instance(s) and can be [mounted](/file-storage/how-to/mount-file-system/) to a Scaleway Instance.
78+
79+
To attach a file system using the CLI or API, refer to the [dedicated documentation](/file-storage/how-to/attach-file-system/).
7880

7981
## How to mount a file system to a Scaleway Instance
8082

0 commit comments

Comments
 (0)