FileSystem

Download schema

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.

List all filesystems

GET

https://api.scaleway.com

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

Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the order_by field.

List all filesystems › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

List all filesystems › query Parameters

order_by

string · enum

Criteria to use when ordering the list.

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

Default: created_at_asc

project_id

string

Filter by project ID.

organization_id

string

Filter by organization ID.

page

integer · int32

Page number (starting at 1).

page_size

integer · uint32

Number of entries per page (default: 20, max: 100).

name

string

Filter the returned filesystems by their names.

filesystem_type

string

Type of the filesystem.

tags

string[]

Filter by tags. Only filesystems with one or more matching tags will be returned.

filesystem_ids

string[]

Filter by filesystem IDs. Only filesystems with one or more matching IDs will be returned.

List all filesystems › Responses

200

scaleway.file.v1alpha1.ListFileSystemsResponse

scaleway.file.v1alpha1.FileSystem[]

List of filesystems matching the request criteria.

total_count

integer · uint64

Total number of filesystems matching the criteria.

Create a new filesystem

POST

https://api.scaleway.com

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

To create a new filesystem, you must specify a name, a size, and a project ID.

Create a new filesystem › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

Create a new filesystem › Request Body

name

string · required

Name of the filesystem.

project_id

string · required

UUID of the project the filesystem belongs to. (UUID format)

size

integer · uint64 · required

Filesystem size in bytes, with a granularity of 100 GB (10^11 bytes). Must be compliant with the minimum (100 GB) and maximum (10 TB) allowed size.

type

string

Type of the filesystem.

tags

string[]

List of tags assigned to the filesystem.

Create a new filesystem › Responses

200

scaleway.file.v1alpha1.FileSystem

id

string

UUID of the filesystem. (UUID format)

name

string

Name of the filesystem.

size

integer · uint64

Filesystem size in bytes. (in bytes)

status

string · enum

Current status of the filesystem (e.g. creating, available, ...).

Enum values:

unknown_status

available

error

creating

updating

Default: unknown_status

project_id

string

UUID of the project to which the filesystem belongs. (UUID format)

organization_id

string

UUID of the organization to which the filesystem belongs. (UUID format)

tags

string[]

List of tags assigned to the filesystem.

number_of_attachments

integer · uint32

The current number of attachments (mounts) that the filesystem has.

region

string

Region where the filesystem is located.

created_at

string · date-time

Creation date of the filesystem. (RFC 3339 format)

updated_at

string · date-time

Last update date of the properties of the filesystem. (RFC 3339 format)

filesystem_type_id

string

UUID of the filesystem type. (UUID format)

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

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "size": 42
  }' \
  "https://api.scaleway.com/file/v1alpha1/regions/{region}/filesystems"

Example Request Body

{
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "size": 0,
  "type": "type",
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "size": 0,
  "status": "unknown_status",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "tags": [
    "string"
  ],
  "number_of_attachments": 0,
  "region": "region",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "filesystem_type_id": "6170692e-7363-616c-6577-61792e636f6d"
}

json

application/json

Get filesystem details

GET

https://api.scaleway.com

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

Retrieve all properties and current status of a specific filesystem identified by its ID.

Get filesystem details › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

filesystem_id

string · required

UUID of the filesystem. (UUID format)

Get filesystem details › Responses

200

scaleway.file.v1alpha1.FileSystem

id

string

UUID of the filesystem. (UUID format)

name

string

Name of the filesystem.

size

integer · uint64

Filesystem size in bytes. (in bytes)

status

string · enum

Current status of the filesystem (e.g. creating, available, ...).

Enum values:

unknown_status

available

error

creating

updating

Default: unknown_status

project_id

string

UUID of the project to which the filesystem belongs. (UUID format)

organization_id

string

UUID of the organization to which the filesystem belongs. (UUID format)

tags

string[]

List of tags assigned to the filesystem.

number_of_attachments

integer · uint32

The current number of attachments (mounts) that the filesystem has.

region

string

Region where the filesystem is located.

created_at

string · date-time

Creation date of the filesystem. (RFC 3339 format)

updated_at

string · date-time

Last update date of the properties of the filesystem. (RFC 3339 format)

filesystem_type_id

string

UUID of the filesystem type. (UUID format)

Delete a detached filesystem

DELETE

https://api.scaleway.com

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

You must specify the filesystem_id of the filesystem you want to delete.

Delete a detached filesystem › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

filesystem_id

string · required

UUID of the filesystem. (UUID format)

Delete a detached filesystem › Responses

No data returned

Update filesystem properties

PATCH

https://api.scaleway.com

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

Update the technical details of a filesystem, such as its name, tags or its new size.

Update filesystem properties › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

filesystem_id

string · required

UUID of the filesystem. (UUID format)

Update filesystem properties › Request Body

name

string

When defined, is the new name of the filesystem.

size

integer · uint64

Optional field for increasing the size of the filesystem (must be larger than the current size). Size in bytes, with a granularity of 100 GB (10^11 bytes). Must be compliant with the minimum (100 GB) and maximum (10 TB) allowed size.

tags

string[]

List of tags assigned to the filesystem.

Update filesystem properties › Responses

200

scaleway.file.v1alpha1.FileSystem

id

string

UUID of the filesystem. (UUID format)

name

string

Name of the filesystem.

size

integer · uint64

Filesystem size in bytes. (in bytes)

status

string · enum

Current status of the filesystem (e.g. creating, available, ...).

Enum values:

unknown_status

available

error

creating

updating

Default: unknown_status

project_id

string

UUID of the project to which the filesystem belongs. (UUID format)

organization_id

string

UUID of the organization to which the filesystem belongs. (UUID format)

tags

string[]

List of tags assigned to the filesystem.

number_of_attachments

integer · uint32

The current number of attachments (mounts) that the filesystem has.

region

string

Region where the filesystem is located.

created_at

string · date-time

Creation date of the filesystem. (RFC 3339 format)

updated_at

string · date-time

Last update date of the properties of the filesystem. (RFC 3339 format)

filesystem_type_id

string

UUID of the filesystem type. (UUID format)

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

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/file/v1alpha1/regions/{region}/filesystems/{filesystem_id}"

Example Request Body

{
  "name": "name",
  "size": 0,
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "size": 0,
  "status": "unknown_status",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "tags": [
    "string"
  ],
  "number_of_attachments": 0,
  "region": "region",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "filesystem_type_id": "6170692e-7363-616c-6577-61792e636f6d"
}

json

application/json

Attachment

List all filesystems

GET

https://api.scaleway.com

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

Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the order_by field.

List all filesystems › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

List all filesystems › query Parameters

order_by

string · enum

Criteria to use when ordering the list.

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

Default: created_at_asc

project_id

string

Filter by project ID.

organization_id

string

Filter by organization ID.

page

integer · int32

Page number (starting at 1).

page_size

integer · uint32

Number of entries per page (default: 20, max: 100).

name

string

Filter the returned filesystems by their names.

filesystem_type

string

Type of the filesystem.

tags

string[]

Filter by tags. Only filesystems with one or more matching tags will be returned.

filesystem_ids

string[]

Filter by filesystem IDs. Only filesystems with one or more matching IDs will be returned.

List all filesystems › Responses

200

scaleway.file.v1alpha1.ListFileSystemsResponse

scaleway.file.v1alpha1.FileSystem[]

List of filesystems matching the request criteria.

total_count

integer · uint64

Total number of filesystems matching the criteria.

Create a new filesystem

POST

https://api.scaleway.com

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

To create a new filesystem, you must specify a name, a size, and a project ID.

Create a new filesystem › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

Create a new filesystem › Request Body

name

string · required

Name of the filesystem.

project_id

string · required

UUID of the project the filesystem belongs to. (UUID format)

size

integer · uint64 · required

Filesystem size in bytes, with a granularity of 100 GB (10^11 bytes). Must be compliant with the minimum (100 GB) and maximum (10 TB) allowed size.

type

string

Type of the filesystem.

tags

string[]

List of tags assigned to the filesystem.

Create a new filesystem › Responses

200

scaleway.file.v1alpha1.FileSystem

id

string

UUID of the filesystem. (UUID format)

name

string

Name of the filesystem.

size

integer · uint64

Filesystem size in bytes. (in bytes)

status

string · enum

Current status of the filesystem (e.g. creating, available, ...).

Enum values:

unknown_status

available

error

creating

updating

Default: unknown_status

project_id

string

UUID of the project to which the filesystem belongs. (UUID format)

organization_id

string

UUID of the organization to which the filesystem belongs. (UUID format)

tags

string[]

List of tags assigned to the filesystem.

number_of_attachments

integer · uint32

The current number of attachments (mounts) that the filesystem has.

region

string

Region where the filesystem is located.

created_at

string · date-time

Creation date of the filesystem. (RFC 3339 format)

updated_at

string · date-time

Last update date of the properties of the filesystem. (RFC 3339 format)

filesystem_type_id

string

UUID of the filesystem type. (UUID format)

Get filesystem details

GET

https://api.scaleway.com

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

Retrieve all properties and current status of a specific filesystem identified by its ID.

Get filesystem details › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

filesystem_id

string · required

UUID of the filesystem. (UUID format)

Get filesystem details › Responses

200

scaleway.file.v1alpha1.FileSystem

id

string

UUID of the filesystem. (UUID format)

name

string

Name of the filesystem.

size

integer · uint64

Filesystem size in bytes. (in bytes)

status

string · enum

Current status of the filesystem (e.g. creating, available, ...).

Enum values:

unknown_status

available

error

creating

updating

Default: unknown_status

project_id

string

UUID of the project to which the filesystem belongs. (UUID format)

organization_id

string

UUID of the organization to which the filesystem belongs. (UUID format)

tags

string[]

List of tags assigned to the filesystem.

number_of_attachments

integer · uint32

The current number of attachments (mounts) that the filesystem has.

region

string

Region where the filesystem is located.

created_at

string · date-time

Creation date of the filesystem. (RFC 3339 format)

updated_at

string · date-time

Last update date of the properties of the filesystem. (RFC 3339 format)

filesystem_type_id

string

UUID of the filesystem type. (UUID format)

Delete a detached filesystem

DELETE

https://api.scaleway.com

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

You must specify the filesystem_id of the filesystem you want to delete.

Delete a detached filesystem › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

filesystem_id

string · required

UUID of the filesystem. (UUID format)

Delete a detached filesystem › Responses

No data returned

Update filesystem properties

PATCH

https://api.scaleway.com

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

Update the technical details of a filesystem, such as its name, tags or its new size.

Update filesystem properties › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

filesystem_id

string · required

UUID of the filesystem. (UUID format)

Update filesystem properties › Request Body

name

string

When defined, is the new name of the filesystem.

size

integer · uint64

tags

string[]

List of tags assigned to the filesystem.

Update filesystem properties › Responses

200

scaleway.file.v1alpha1.FileSystem

id

string

UUID of the filesystem. (UUID format)

name

string

Name of the filesystem.

size

integer · uint64

Filesystem size in bytes. (in bytes)

status

string · enum

Current status of the filesystem (e.g. creating, available, ...).

Enum values:

unknown_status

available

error

creating

updating

Default: unknown_status

project_id

string

UUID of the project to which the filesystem belongs. (UUID format)

organization_id

string

UUID of the organization to which the filesystem belongs. (UUID format)

tags

string[]

List of tags assigned to the filesystem.

number_of_attachments

integer · uint32

The current number of attachments (mounts) that the filesystem has.

region

string

Region where the filesystem is located.

created_at

string · date-time

Creation date of the filesystem. (RFC 3339 format)

updated_at

string · date-time

Last update date of the properties of the filesystem. (RFC 3339 format)

filesystem_type_id

string

UUID of the filesystem type. (UUID format)