Skip to content

chore(gen): content review MTA-6277 #5288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
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
107 changes: 41 additions & 66 deletions pages/block-storage/api-cli/identifying-volume-snapshot-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Identifying the API managing Block Storage volumes and snapshots
description: Learn how to determine which API (Instance or Block Storage) manages your volumes and snapshots on Scaleway using CLI and API commands.
dates:
validation: 2025-01-13
validation: 2025-07-31
posted: 2025-01-13
---
import Requirements from '@macros/iam/requirements.mdx'
Expand Down Expand Up @@ -34,7 +34,10 @@ Open a terminal and run the following command to list your volumes managed by th
-H "X-Auth-Token: $SCW_SECRET_KEY" \
"https://api.scaleway.com/instance/v1/zones/{zone}/volumes"
```
Below is an example of the output that should display if you have created volumes in the `fr-par-1` Availability Zone using the Instance API. Note that the `volume_type` field is set to `b_ssd`, meaning the volumes were created via the Instance API.

Below is an example of the output that should display if you have created volumes in the `fr-par-1` Availability Zone using the Instance API.

The `volume_type` field is set to `b_ssd`, meaning the volumes were created via the Instance API.

```
{
Expand Down Expand Up @@ -74,24 +77,6 @@ Below is an example of the output that should display if you have created volume
"modification_date": "2024-01-30T13:11:15.554809+00:00",
"tags": [],
"zone": "fr-par-1"
},
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "System volume",
"volume_type": "b_ssd",
"export_uri": null,
"organization": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"project": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"server": {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "scw-optimistic-wilbur"
},
"size": 10000000000,
"state": "available",
"creation_date": "2023-11-14T12:59:42.932912+00:00",
"modification_date": "2023-11-14T12:59:42.932912+00:00",
"tags": [],
"zone": "fr-par-1"
}
]
}
Expand All @@ -107,7 +92,9 @@ Open a terminal and run the following command to list your volumes managed by th
"https://api.scaleway.com/block/v1alpha1/zones/{zone}/volumes"
```

Below is an example of the output that should display if you have created volumes in the `fr-par-1` Availability Zone using the Block Storage API. Note that the `volume_type` field is set to either `sbs_15k` or `sbs_5k`, meaning the volumes were created via the Block Storage API.
Below is an example of the output that should display if you have created volumes in the `fr-par-1` Availability Zone using the Block Storage API.

The `volume_type` field is set to either `sbs_15k` or `sbs_5k`, meaning the volumes were created via the Block Storage API.

```
{
Expand Down Expand Up @@ -135,21 +122,9 @@ Below is an example of the output that should display if you have created volume
"class": "sbs"
},
"zone": "fr-par-1"
},
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "volume-interesting-keller",
"type": "sbs_5k",
"size": 25000000000,
"status": "available",
"specs": {
"perf_iops": 5000,
"class": "sbs"
},
"zone": "fr-par-1"
}
],
"total_count": 3
"total_count": 2
}
```

Expand All @@ -164,7 +139,8 @@ Open a terminal and run the following command to list all snapshots created via
-H "X-Auth-Token: $SCW_SECRET_KEY" \
"https://api.scaleway.com/instance/v1/zones/{zone}/snapshots"
```
An output similar to the following should display:

An output similar to the following displays:

```
{
Expand Down Expand Up @@ -198,7 +174,7 @@ Open a terminal and run the following command to list all snapshots created via
"https://api.scaleway.com/block/v1alpha1/zones/{zone}/snapshots"
```

An output similar to the following should display:
An output similar to the following displays:

```
{
Expand All @@ -221,25 +197,6 @@ An output similar to the following should display:
"tags": [],
"class": "sbs",
"zone": "fr-par-1"
},
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "snap-busy-albattani",
"parent_volume": {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "volume-eloquent-grothendieck",
"type": "sbs_5k",
"status": "available"
},
"size": 25000000000,
"project_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"created_at": "2024-12-06T10:16:18.565939Z",
"updated_at": "2024-12-06T10:16:18.565939Z",
"references": [],
"status": "available",
"tags": [],
"class": "sbs",
"zone": "fr-par-1"
}
]
}
Expand All @@ -254,7 +211,9 @@ An output similar to the following should display:
```bash
scw instance volume list
```
An output similar to the following should display:

An output similar to the following displays:

```
ID STATE SERVER ID
b582c548-6dc0-4e77-bb93-9615b9baa380 available a4138186-f362-41b2-adc2-c46a2e1a46b7
Expand All @@ -265,12 +224,15 @@ An output similar to the following should display:
7c232b97-63da-46e3-a018-399e1690b14b available ea5b27d7-268f-40fe-aff7-6943fbcac379
1a506e55-0741-4afd-8fbc-bc086ace0265 available 8860802f-0337-4901-b58c-ba3975922349
```
2. Note the ID of the volume you want to check the type of.
3. Get more information about your volume, including its type. Make sure that you replace `<volume-id>` with the ID of the volume.

2. Copy the ID of the volume for witch you want to check the type.

3. Run the command below to get information about your volume, including its type. Make sure that you replace `<volume-id>` with the ID of the volume.

```bash
scw instance volume get <volume-id>
```
An output similar to the following should display:
An output similar to the following displays:
```
Volume.ID 7c232b97-63da-46e3-a018-399e1690b14b
Volume.Name System volume
Expand All @@ -285,16 +247,20 @@ An output similar to the following should display:
Volume.State available
Volume.Zone fr-par-1
```

4. Check the `Volume.VolumeType` field to learn if your volume is managed by the Instance API or the Block Storage API. Note that in our example, the `Volume.VolumeType` field displays `b_ssd`, meaning our volume is managed by the Instance API.

### Using the Scaleway Block Storage CLI

Open your terminal and run the following command to list all your volumes.

```bash
scw block volume list
```

An output similar to the following should display:
```

```bash
ID NAME TYPE SIZE
7a9f3816-7bb7-44ea-a103-832b9685cdc6 volume-nifty-allen sbs_15k 25 GB
cdab395b-c1b9-4a3b-a759-2add13eb2bcb volume-xenodochial-mccarthy sbs_15k 30 GB
Expand All @@ -315,18 +281,22 @@ An output similar to the following should display:
```bash
scw instance snapshot list
```
An output similar to the following should display:
An output similar to the following displays:
```
ID NAME ORGANIZATION
d4b45594-7398-481d-8299-46292e07e404 snap-magical-driscoll 0c514155-9e5e-41a2-a900-9fdf0195b563
```
2. Note the ID of the snapshot you want to check the type of.

3. Get more information about your snapshot, including its type. Make sure that you replace `<snapshot-id>` with the ID of the snapshot.

```bash
scw instance snapshot get <snapshot-id>
```

An output similar to the following displays:
```

```bash
Snapshot.ID d4b45594-7398-481d-8299-46292e07e404
Snapshot.Name snap-magical-driscoll
Snapshot.Organization 0c514155-9e5e-41a2-a900-9fdf0195b563
Expand All @@ -338,6 +308,7 @@ An output similar to the following should display:
Snapshot.ModificationDate 10 months ago
Snapshot.Zone fr-par-1
```

4. Check the `Snapshot.VolumeType` field to see the type of the snapshot. Note that in the example above, the `Snapshot.VolumeType` field displays `b_ssd`, meaning our volume is managed by the Instance API.

### Using the Scaleway Block Storage CLI
Expand All @@ -347,19 +318,23 @@ An output similar to the following should display:
```bash
scw block snapshot list
```
An output similar to the following should display.
An output similar to the following displays:

```
ID NAME SIZE PROJECT ID
7f6ab0bd-cd0d-466b-b1e3-bd309dddfcf8 snap-elated-thompson 30 GB 0c514155-9e5e-41a2-a900-9fdf0195b563
92fa0096-30cf-4e7e-a1fe-2fbe73f524b9 snap-busy-albattani 25 GB e53c4255-f982-4d9d-a003-5ea43cb33707
```
2. Note the ID of the snapshot you want to check the type of.
3. Get more information about your snapshot, including its type. Make sure that you replace `<snapshot-id>` with the ID of the snapshot.
2. Note the ID of the snapshot for witch you want to check the type.

3. Run the command below to get information about your snapshot, including its type. Make sure that you replace `<snapshot-id>` with the ID of the snapshot.

```bash
scw block snapshot get <snapshot-id>
```
An output similar to the following should display:

An output similar to the following displays:

```
ID 92fa0096-30cf-4e7e-a1fe-2fbe73f524b9
Name snap-busy-albattani
Expand Down
6 changes: 4 additions & 2 deletions pages/object-storage/api-cli/bucket-operations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Understanding Object Storage bucket operations
description: Perform various operations on buckets in Scaleway Object Storage using the CLI.
tags: object storage object-storage bucket
dates:
validation: 2025-01-15
validation: 2025-07-31
posted: 2018-09-14
---

Expand Down Expand Up @@ -34,7 +34,9 @@ aws s3 mb s3://bucketname
This operation allows you to delete the bucket mentioned in the command.

<Message type="important">
Deleting a bucket will also delete all of its objects. For safety measures, the effective deletion of the bucket will start 24 hours after the deletion request. The bucket name will then be available for other customers to use.<br /><br />The billing of your resources stops as soon as you request the deletion of your resources.<br /><br />Once you do so, the bucket and its objects and versions will no longer be displayed in the console or available via the API. For this reason, we recommend you delete all objects and versions in the bucket before requesting the deletion, if you wish the bucket deletion to be effective immediately.
- Deleting a bucket will also delete all of its objects. For safety measures, the effective deletion of the bucket will start 24 hours after the deletion request. The bucket name will then be available for other customers to use.

- The billing of your resources stops as soon as you request the deletion of your resources. Once you do so, the bucket and its objects and versions will no longer be displayed in the console or available via the API. For this reason, we recommend you delete all objects and versions in the bucket before requesting the deletion, if you wish the bucket deletion to be effective immediately.
</Message>

<Message type="note">
Expand Down
4 changes: 2 additions & 2 deletions pages/object-storage/api-cli/bucket-policy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Bucket policies overview
description: Implement and manage bucket policies in Scaleway Object Storage.
tags: object-storage bucket bucket-policy s3
dates:
validation: 2024-12-24
validation: 2025-07-30
posted: 2021-02-17
---
import StorageBucketPolicy from '@macros/storage/bucket-policy.mdx'
Expand Down Expand Up @@ -439,7 +439,7 @@ Bucket policies use a JSON-based access policy language, and are composed of str
- `s3:GetObjectVersionTagging`
- `s3:ListMultipartUploadParts`
- `s3:PutObject`
- `s3:PutObjectACL`
- `s3:PutObjectAcl`
- `s3:PutObjectLegalHold`
- `s3:PutObjectRetention`
- `s3:PutObjectTagging`
Expand Down
8 changes: 3 additions & 5 deletions pages/object-storage/api-cli/bucket-website-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,13 @@ title: Setting up static websites on a bucket with the API
description: Configure bucket websites using the API in Scaleway Object Storage.
tags: object storage object-storage bucket static-website api
dates:
validation: 2025-01-15
validation: 2025-07-31
posted: 2021-02-17
---
import Requirements from '@macros/iam/requirements.mdx'


The bucket website feature allows you to host static websites using Scaleway [Object Storage](https://www.scaleway.com/en/object-storage/).

It is possible to enable and configure the bucket website feature via the [AWS-CLI](/object-storage/api-cli/object-storage-aws-cli/).
The bucket website feature allows you to host static websites using Scaleway [Object Storage](https://www.scaleway.com/en/object-storage/) via the [AWS CLI](/object-storage/api-cli/object-storage-aws-cli/).

To enable and configure the bucket website using the Scaleway console, refer to our [dedicated documentation](/object-storage/how-to/use-bucket-website/).

Expand All @@ -26,7 +24,7 @@ To enable and configure the bucket website using the Scaleway console, refer to

To use the bucket website feature, you need to enable it on the bucket or buckets you wish to host your website on.

You can use an API call or the AWS-CLI to enable it using `put-bucket-website`.
You can use an API call or the AWS CLI to enable it using `put-bucket-website`.

### Website JSON grammar

Expand Down
2 changes: 1 addition & 1 deletion pages/object-storage/api-cli/common-operations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Understanding common Object Storage operations
description: Perform common operations efficiently using Scaleway Object Storage CLI.
tags: object storage object-storage api api-operation getservice
dates:
validation: 2025-01-15
validation: 2025-07-31
posted: 2018-09-13
---

Expand Down
16 changes: 5 additions & 11 deletions pages/object-storage/api-cli/generate-aws4-auth-signature.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,21 @@ title: Generating an AWSv4 authentication signature
description: Generate AWS Signature Version 4 for authentication in Scaleway Object Storage.
tags: object-storage object storage awsv4 aws authentication
dates:
validation: 2025-01-15
validation: 2025-07-31
posted: 2018-07-16
---
import Requirements from '@macros/iam/requirements.mdx'

Requests sent to the Object Storage API require an HTTP Authorization header. Scaleway Object Storage supports [AWS v4 signature](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) protocol to add an authentication signature to API requests.

Requests sent to the Object Storage API require an HTTP Authorization header.
When using third-party tools such as [aws-cli](https://aws.amazon.com/cli/), [s3cmd](https://s3tools.org/s3cmd), [s3fs](https://github.com/s3fs-fuse/s3fs-fuse), or [MinIO Client](https://github.com/minio/mc), signatures are automatically generated for you.

<Requirements />

- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- A valid [API key](/iam/how-to/create-api-keys/)

<Message type="note">
Currently, the [AWS v4 signature type](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) is supported.
</Message>

When using a client library such as [aws-cli](https://aws.amazon.com/cli/), [s3cmd](https://s3tools.org/s3cmd) or [s3fs](https://github.com/s3fs-fuse/s3fs-fuse), signatures are automatically generated by the library for you.

To generate the signature, you need to have an access key and secret key generated in the [Credentials section](https://console.scaleway.com/project/credentials) of your management console.

A v4 signature consists of different parts:
An AWSv4 authentication signature consists of different parts:

AWS4-HMAC-SHA256
: Indicates AWS Signature Version 4 (AWS4) and the signing algorithm (HMAC-SHA256).
Expand Down
2 changes: 1 addition & 1 deletion pages/object-storage/api-cli/installing-minio-client.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Installing and setting up MinIO Client
description: Install and configure the MinIO client for Scaleway Object Storage.
tags: object-storage object storage minio mc minio-client
dates:
validation: 2025-01-15
validation: 2025-07-31
posted: 2021-08-25
---
import Requirements from '@macros/iam/requirements.mdx'
Expand Down
4 changes: 2 additions & 2 deletions pages/object-storage/api-cli/lifecycle-rules-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Managing the lifecycle of objects
description: Use the API to manage lifecycle rules in Scaleway Object Storage.
tags: object storage object-storage lifecycle
dates:
validation: 2024-12-24
validation: 2025-07-31
posted: 2019-05-14
---
import Requirements from '@macros/iam/requirements.mdx'
Expand Down Expand Up @@ -206,7 +206,7 @@ When using the `awscli` to perform a [multipart upload](/object-storage/api-cli/

You can automate the removal of incomplete multipart uploads by adding or uploading a lifecycle configuration to your bucket. The setup can be done via an API call or an [AWS-CLI](/object-storage/api-cli/object-storage-aws-cli/) command.

Send a [putbucketlifecycleconfiguration](/object-storage/api-cli/bucket-operations/#putbucketlifecycleconfiguration) request with the following XML payload:
Send a [PutBucketLifecycleConfiguration](/object-storage/api-cli/bucket-operations/#putbucketlifecycleconfiguration) request with the following XML payload:

```xml no-copy
<?xml version="1.0" encoding="UTF-8"?>
Expand Down
Loading
Loading