Scaleway Python SDK

https://scaleway.github.io/scaleway-sdk-python/
Admin
Scaleway Python SDK is a comprehensive library for interacting with Scaleway's cloud infrastructure...
Tokens:3,768,914
Snippets:22,198
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Server Install

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Retrieves the installation status for a specific baremetal server.

```APIDOC
## Get Server Install

### Description
Get a specific server installation status. Get the server installation status associated with the given server ID.

### Parameters
#### Path Parameters
- **server_id** (int) - Required - Server ID of the server to install.
- **zone** (str) - Optional - Zone to target. If none is passed will use default zone from the config.

### Returns
- `ServerInstall`

### Usage Example
```python
result = api.get_server_install(
    server_id=1,
)
```
```

--------------------------------

### Install Server

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.baremetal.v1.html

Installs or reinstalls an operating system on a baremetal server.

```APIDOC
## POST /servers/{server_id}/install

### Description
Installs or reinstalls an operating system on a baremetal server.

### Method
POST

### Endpoint
/servers/{server_id}/install

### Parameters
#### Path Parameters
- **server_id** (string) - Required - The ID of the server to install.
- **zone** (string) - Required - The zone where the server is located.

### Request Body
- **hostname** (string) - Optional - Hostname for the installed OS.
- **os_id** (string) - Required - ID of the operating system to install.
- **partitioning_schema** (string) - Optional - Partitioning schema to use.
- **password** (string) - Optional - Password for the root user.
- **ssh_key_ids** (array of strings) - Optional - IDs of SSH keys to authorize.
- **user** (string) - Optional - Username for the default user.
- **service_user** (string) - Optional - Username for the service user.
- **service_password** (string) - Optional - Password for the service user.
```

--------------------------------

### Start Server

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Starts a specified server.

```APIDOC
## Start Server

### Description
Starts a specified server.

### Method
POST

### Endpoint
/dedibox/v1/servers/{server_id}/start

### Parameters
#### Path Parameters
- **server_id** (int) - Required - Server ID to start.

#### Query Parameters
- **zone** (ScwZone) - Optional - Zone to target. If none is passed will use default zone from the config.

### Request Example
```json
{
  "server_id": 12345
}
```

### Response
#### Success Response (200)
- **status** (str) - Status of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Install Server

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.baremetal.v1.html

Installs an operating system on a specified baremetal server with provided configuration details.

```APIDOC
## InstallServerRequest

### Description
Represents a request to install an operating system on a baremetal server.

### Fields
- **server_id** (str) - Required - The ID of the server to install.
- **os_id** (str) - Required - The ID of the operating system to install.
- **hostname** (str) - Required - The desired hostname for the server.
- **ssh_key_ids** (List[str]) - Required - A list of SSH key IDs to authorize on the server.
- **zone** (Optional[ScwZone]) - Optional - The zone to target. Defaults to the configured default zone.
- **user** (Optional[str]) - Optional - The username for the installation.
- **password** (Optional[str]) - Optional - The password for the installation.
- **service_user** (Optional[str]) - Optional - The username for the service installation.
- **service_password** (Optional[str]) - Optional - The password for the service installation.
- **partitioning_schema** (Optional[Schema]) - Optional - The partitioning schema to use for the installation.
```

--------------------------------

### Start Server

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Starts a baremetal server associated with the given ID.

```APIDOC
## start_server

### Description
Start a baremetal server. Start the server associated with the given ID.

### Method
POST

### Endpoint
/servers/{server_id}/start

### Parameters
#### Path Parameters
- **server_id** (int) - Required - Server ID to start.

#### Query Parameters
- **zone** (str) - Optional - Zone to target. If none is passed will use default zone from the config.

### Response
#### Success Response (200)
- **None** - Indicates the server start operation was successful.

### Request Example
```python
result = api.start_server(
    server_id=1,
)
```
```

--------------------------------

### BaremetalV1API - Install Server

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.baremetal.html

Initiates the installation process for a baremetal server. This is typically used after a server has been provisioned but before an OS is installed.

```APIDOC
## POST /servers/{server_id}/install

### Description
Initiates the installation process for a baremetal server.

### Method
POST

### Endpoint
/servers/{server_id}/install

### Parameters
#### Path Parameters
- **server_id** (string) - Required - The ID of the server to install.

#### Query Parameters
- **zone** (string) - Required - The availability zone of the server.

#### Request Body
- **os_id** (string) - Required - The ID of the operating system to install.
- **ssh_key_ids** (array of strings) - Optional - A list of SSH key IDs to associate with the server.
- **partitioning_schema** (string) - Optional - A custom partitioning schema for the server.
- **boot_type** (string) - Optional - The boot type for the server (e.g., 'local_install', 'rescue', 'ipxe').
- **password** (string) - Optional - The root password for the server (if not using SSH keys).
```

--------------------------------

### GetServerInstallRequest

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway_async.dedibox.html

Represents a request to get server installation details.

```APIDOC
## GetServerInstallRequest

### Description
Represents a request to get server installation details.

### Fields
- **server_id** (string) - The ID of the server.
- **zone** (string) - The zone where the server is located.
```

--------------------------------

### Start Server Request

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.baremetal.v1.html

Request object for starting a bare metal server.

```APIDOC
## StartServerRequest

### Description
Represents the parameters required to start a bare metal server.

### Fields
- **server_id** (str) - Required - The ID of the server to start.
- **zone** (Optional[ScwZone]) - Optional - The zone to target. If none is passed, the default zone from the config will be used.
- **boot_type** (Optional[ServerBootType]) - Optional - The type of boot. Defaults to 'unknown_boot_type'.
- **ssh_key_ids** (Optional[List[str]]) - Optional - Additional SSH public key IDs to configure on the rescue image.
```

--------------------------------

### Start Server Request

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Request object to start a server.

```APIDOC
## StartServerRequest Object

### Description
Request object to start a server.

### Fields
- **server_id** (int) - Required - Server ID to start.
- **zone** (Optional[ScwZone]) - Optional - Zone to target. If none is passed will use default zone from the config.
```

--------------------------------

### Install a baremetal server

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Installs an operating system on a baremetal server. You can specify various installation parameters such as hostname, user credentials, partitions, and SSH keys.

```APIDOC
## Install Server

### Description
Install an OS on the server associated with the given ID.

### Parameters
#### Path Parameters
- **server_id** (int) - Required - Server ID to install.
- **os_id** (int) - Required - OS ID to install on the server.
- **hostname** (str) - Required - Hostname of the server.
- **zone** (str) - Optional - Zone to target. If none is passed will use default zone from the config.
- **user_login** (str) - Optional - User to install on the server.
- **user_password** (str) - Optional - User password to install on the server.
- **panel_password** (str) - Optional - Panel password to install on the server.
- **root_password** (str) - Optional - Root password to install on the server.
- **partitions** (List[InstallPartition]) - Optional - Partitions to install on the server.
- **ssh_key_ids** (List[str]) - Optional - SSH key IDs authorized on the server.
- **license_offer_id** (int) - Optional - Offer ID of license to install on server.
- **ip_id** (int) - Optional - IP to link at the license to install on server.

### Response
#### Success Response (200)
- **ServerInstall** - Details of the server installation.

### Usage
```python
result = api.install_server(
    server_id=1,
    os_id=1,
    hostname="example",
)
```
```

--------------------------------

### Start Server

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Starts a baremetal server. This action powers on the server associated with the provided server ID.

```APIDOC
## start_server

### Description
Start a baremetal server. Start the server associated with the given ID.

### Parameters
#### Path Parameters
- **server_id** (int) - Required - Server ID to start.
- **zone** (str) - Optional - Zone to target. If none is passed will use default zone from the config.

### Request Example
```python
result = api.start_server(
    server_id=1,
)
```
```

--------------------------------

### Install Scaleway SDK (Asynchronous)

Source: https://scaleway.github.io/scaleway-sdk-python/_sources/index.rst.txt

Install the asynchronous version of the Scaleway Python SDK from PyPI.

```bash
pip install scaleway-async
```

--------------------------------

### Start Server

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.baremetal.v1.html

Starts a stopped baremetal server. Requires the server ID and zone.

```APIDOC
## Start Server

### Description
Starts a stopped baremetal server.

### Method
POST

### Endpoint
`/servers/{server_id}/start`

### Parameters
#### Path Parameters
- **server_id** (string) - Required - The ID of the server to start.
- **zone** (string) - Required - The zone of the server.

#### Request Body
- **boot_type** (string) - Optional - The boot type to use (e.g., 'local', 'network').
- **ssh_key_ids** (array of strings) - Optional - IDs of SSH keys to be added to the server upon boot.

### Request Example
```json
{
  "boot_type": "local",
  "ssh_key_ids": ["ssh_key_uuid"]
}
```

### Response
#### Success Response (200)
- **server_private_networks** (array) - A list of server private networks.

#### Response Example
```json
{
  "server_private_networks": [
    {
      "id": "server_private_network_uuid",
      "server_id": "server_uuid",
      "private_network_id": "private_network_uuid",
      "project_id": "project_uuid",
      "vlan": 10,
      "status": "ATTACHED",
      "created_at": "2023-01-01T10:00:00Z",
      "updated_at": "2023-01-01T10:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Install Server

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.baremetal.v1.html

Installs an Operating System on an Elastic Metal server.

```APIDOC
## POST /baremetal/v1/servers/{server_id}/install

### Description
Install an Operating System (OS) on the Elastic Metal server with a specific ID.

### Method
POST

### Endpoint
/baremetal/v1/servers/{server_id}/install

### Parameters
#### Path Parameters
- **server_id** (string) - Required - Server ID to install.

#### Request Body
- **os_id** (string) - Required - ID of the OS to installation on the server.
- **hostname** (string) - Required - Hostname of the server.
- **ssh_key_ids** (List[string]) - Required - SSH key IDs authorized on the server.
- **zone** (string) - Optional - Zone to target. If none is passed will use default zone from the config.
- **user** (string) - Optional - User used for the installation.
- **password** (string) - Optional - Password used for the installation.
- **service_user** (string) - Optional - User used for the service to install.
- **service_password** (string) - Optional - Password used for the service to install.
- **partitioning_schema** (Schema) - Optional - Partitioning schema.

### Response
#### Success Response (200)
- **server** (Server) - The installed server details.
```

--------------------------------

### Server Installation Details

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway_async.dedibox.html

Information required and available during server installation.

```APIDOC
## Server Install

Details related to server installation:

* `ServerInstall.hostname`: The hostname for the server.
* `ServerInstall.os_id`: The identifier for the operating system to install.
* `ServerInstall.panel_url`: The URL for the server's control panel.
* `ServerInstall.partitions`: Configuration for disk partitioning.
* `ServerInstall.ssh_key_ids`: List of SSH key IDs to be added.
* `ServerInstall.status`: The current status of the installation.
* `ServerInstall.user_login`: The username for the initial login.
```

--------------------------------

### BaremetalV1API - Start Server

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.baremetal.html

Starts a stopped baremetal server.

```APIDOC
## POST /servers/{server_id}/start

### Description
Starts a stopped baremetal server.

### Method
POST

### Endpoint
/servers/{server_id}/start

### Parameters
#### Path Parameters
- **server_id** (string) - Required - The ID of the server to start.

#### Query Parameters
- **zone** (string) - Required - The availability zone of the server.

#### Request Body
- **boot_type** (string) - Optional - The boot type for the server (e.g., 'local_install', 'rescue', 'ipxe').
- **ssh_key_ids** (array of strings) - Optional - A list of SSH key IDs to associate with the server.
```

--------------------------------

### Install Server Request

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.baremetal.html

Defines the parameters required to install an operating system on a baremetal server.

```APIDOC
## InstallServerRequest

### Description
Represents the request payload for installing an OS on a baremetal server.

### Fields
- **server_id** (string) - Required - The ID of the server to install.
- **zone** (string) - Required - The zone of the server.
- **os_id** (string) - Required - The ID of the operating system to install.
- **hostname** (string) - Required - The hostname for the server.
- **partitioning_schema** (string) - Optional - The partitioning schema to use.
- **password** (string) - Optional - The root password for the OS.
- **ssh_key_ids** (array of strings) - Optional - IDs of SSH keys to authorize.
- **user** (string) - Optional - The default user to create.
- **service_user** (string) - Optional - The service user for specific OS.
- **service_password** (string) - Optional - The service password for specific OS.
```

--------------------------------

### Install Scaleway SDK (Synchronous)

Source: https://scaleway.github.io/scaleway-sdk-python/_sources/index.rst.txt

Install the synchronous version of the Scaleway Python SDK from PyPI.

```bash
pip install scaleway
```

--------------------------------

### Initialize Scaleway Client (Minimal Setup)

Source: https://scaleway.github.io/scaleway-sdk-python/_sources/index.rst.txt

Initialize the Scaleway client with access key, secret key, project ID, region, and zone. Requires importing Client and the specific API.

```python
from scaleway import Client
from scaleway.registry.v1 import RegistryV1API

client = Client(
   access_key="SCWXXXXXXXXXXXXXXXXX",
   secret_key="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
   default_project_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
   default_region="fr-par",
   default_zone="fr-par-1",
)

registry_api = RegistryV1API(client)
```

--------------------------------

### Start BMC Access

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.baremetal.v1.html

Initiates Baseboard Management Controller (BMC) access for a server. Requires server ID and an authorized IP. Note: BMC access is available one hour after server installation and requires prior setup of a Remote Access option.

```python
result = api.start_bmc_access(
    server_id="example",
    ip="example",
)

```

--------------------------------

### Create Hosting Plan Async

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway_async.webhosting.v1alpha1.html

Orders a new Web Hosting plan. Requires offer ID and domain name. Ensure the domain is already owned and DNS validated.

```python
result = await api.create_hosting(
    offer_id="example",
    domain="example",
)
```

--------------------------------

### Get Server Install Status

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Retrieves the installation status of an operating system on a server.

```APIDOC
## get_server_install(server_id: str, zone: str)

### Description
Retrieves the installation status of an operating system on a server.

### Method
GET

### Endpoint
/servers/{server_id}/install

### Parameters
#### Path Parameters
- **server_id** (string) - Required - The ID of the server.
- **zone** (string) - Required - The zone of the server.

### Response
#### Success Response (200)
- **status** (string) - The installation status (e.g., PENDING, INSTALLING, COMPLETED, FAILED).
- **progress** (integer) - The installation progress in percentage.

### Response Example
{
  "status": "INSTALLING",
  "progress": 50
}
```

--------------------------------

### Get Server Install Status

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Retrieves the installation status for a specific server. This allows you to check the progress or status of an OS installation on a baremetal server.

```APIDOC
## Get Server Install

### Description
Get a specific server installation status.
Get the server installation status associated with the given server ID.

### Parameters
#### Path Parameters
- **server_id** (int) - Required - Server ID of the server to install.
#### Query Parameters
- **zone** (str) - Optional - Zone to target. If none is passed will use default zone from the config.

### Returns
`ServerInstall`

### Usage
```python
result = api.get_server_install(
    server_id=1,
)
```
```

--------------------------------

### StartServerRequest

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.baremetal.v1.html

Request to start a baremetal server.

```APIDOC
## scaleway.baremetal.v1.types.StartServerRequest

### Description
Request to start a baremetal server.

### Fields
- **server_id** (str) - ID of the server to start.
- **zone** (Optional[ScwZone]) - Zone to target. If none is passed will use default zone from the config.
- **boot_type** (Optional[ServerBootType]) - The type of boot. Defaults to 'unknown_boot_type'.
- **ssh_key_ids** (Optional[List[str]]) - Additional SSH public key IDs to configure on rescue image.
```

--------------------------------

### Get Server Install Request

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Represents a request to install a server, specifying server ID and zone.

```APIDOC
## GetServerInstallRequest

### Description
Represents a request to install a server, specifying server ID and zone.

### Fields
- **server_id** (string) - Required - The ID of the server to install.
- **zone** (string) - Required - The zone where the server is located.
```

--------------------------------

### CreateServerRequestInstall

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway_async.baremetal.v1.html

Installation details for creating a baremetal server.

```APIDOC
## CreateServerRequestInstall

### Description
Installation details for creating a baremetal server.

### Attributes
- `hostname` (string) - The hostname for the server.
- `os_id` (string) - The ID of the operating system to install.
- `partitioning_schema` (string) - The partitioning schema to use.
- `password` (string) - The root password for the server.
- `service_password` (string) - The password for the service user.
- `service_user` (string) - The username for the service user.
- `ssh_key_ids` (array of strings) - IDs of SSH keys to authorize.
- `user` (string) - The username for the default user.
```

--------------------------------

### CreateServerRequestInstall

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.baremetal.v1.html

Details for OS installation on a new server.

```APIDOC
## CreateServerRequestInstall

### Description
Details for OS installation on a new server.

### Fields
- **os_id** (str) - Required - ID of the OS to installation on the server.
- **hostname** (str) - Required - Hostname of the server.
- **ssh_key_ids** (List[str]) - Required - SSH key IDs authorized on the server.
- **user** (Optional[str]) - Optional - User for the installation.
- **password** (Optional[str]) - Optional - Password for the installation.
- **service_user** (Optional[str]) - Optional - Regular user that runs the service to be installed on the server.
- **service_password** (Optional[str]) - Optional - Password used for the service to install.
- **partitioning_schema** (Optional[Schema]) - Optional - Partitioning schema.
```

--------------------------------

### Get Hub Metrics

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway_async.iot.v1.html

Get the metrics of an existing IoT Hub, specified by its Hub ID. Metrics are computed starting from the provided start_date.

```APIDOC
## Get Hub Metrics

### Description
Get the metrics of an existing IoT Hub, specified by its Hub ID. Metrics are computed starting from the provided start_date.

### Method
GET

### Endpoint
/iot/v1/hubs/{hub_id}/metrics

### Parameters
#### Path Parameters
- **hub_id** (string) - Required - Hub ID.
- **region** (string) - Optional - Region to target. If none is passed will use default region from the config.
- **start_date** (datetime) - Optional - Start date used to compute the best scale for returned metrics.

### Response
#### Success Response (200)
- **GetHubMetricsResponse** (object) - Metrics for the hub.

### Request Example
```python
result = await api.get_hub_metrics(
    hub_id="example",
)
```
```

--------------------------------

### Start BMC Access

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.baremetal.v1.html

Starts BMC access for a server, allowing remote management. Requires prior setup of Remote Access option.

```APIDOC
## start_bmc_access

### Description
Start BMC access. Start BMC (Baseboard Management Controller) access associated with the ID. The BMC (Baseboard Management Controller) access is available one hour after the installation of the server. You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. After adding the BMC option, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do not forget to delete the Option after use.

### Parameters
#### Path Parameters
- **server_id** (str) - Required - ID of the server.
- **ip** (str) - Required - The IP authorized to connect to the server.
#### Query Parameters
- **zone** (str) - Optional - Zone to target. If none is passed will use default zone from the config.

### Return Value
`BMCAccess`

### Usage
```python
result = api.start_bmc_access(
    server_id="example",
    ip="example",
)
```
```

--------------------------------

### InstallServerRequest

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.baremetal.v1.html

Request object for installing an OS on a bare metal server. Includes server ID, OS ID, hostname, SSH key IDs, and optional user, password, service user, service password, and partitioning schema.

```APIDOC
## InstallServerRequest

### Description
Request object for installing an OS on a bare metal server.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- **server_id** (str) - Required - Server ID to install.
- **os_id** (str) - Required - ID of the OS to installation on the server.
- **hostname** (str) - Required - Hostname of the server.
- **ssh_key_ids** (List[str]) - Required - SSH key IDs authorized on the server.
- **zone** (str) - Optional - Zone to target. If none is passed will use default zone from the config.
- **user** (str) - Optional - User used for the installation.
- **password** (str) - Optional - Password used for the installation.
- **service_user** (str) - Optional - User used for the service to install.
- **service_password** (str) - Optional - Password used for the service to install.
- **partitioning_schema** (Schema) - Optional - Partitioning schema.

#### Request Body
- None
```

--------------------------------

### Get Server Installation Status

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Retrieve the installation status for a specific baremetal server using its ID. The zone can be specified, otherwise the default zone is used.

```python
result = api.get_server_install(
    server_id=1,
)
```

--------------------------------

### Client Initialization from Config

Source: https://scaleway.github.io/scaleway-sdk-python/_sources/index.rst.txt

Shows how to initialize the Scaleway Client by loading configuration from a file and environment variables.

```APIDOC
## Client Initialization from Config

### Description
Initialize the Scaleway Client by automatically loading configuration from the default configuration file and environment variables.

### Method
```python
from scaleway import Client

client = Client.from_config_file_and_env()
```
```

--------------------------------

### Start BMC Access

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Starts the Baseboard Management Controller (BMC) access for a given baremetal server. The BMC access is available one hour after the server installation.

```APIDOC
## start_bmc_access

### Description
Start BMC (Baseboard Management Controller) access for a given baremetal server. The BMC (Baseboard Management Controller) access is available one hour after the installation of the server.

### Parameters
#### Path Parameters
- **server_id** (int) - Required - ID of the server to start the BMC access.
- **ip** (str) - Required - The IP authorized to connect to the given server.
- **zone** (str) - Optional - Zone to target. If none is passed will use default zone from the config.

### Request Example
```python
result = api.start_bmc_access(
    server_id=1,
    ip="example",
)
```
```

--------------------------------

### StartBMCAccessRequest Class

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway_async.baremetal.v1.html

Request object for starting BMC access for a baremetal server.

```APIDOC
## Class scaleway_async.baremetal.v1.StartBMCAccessRequest

Request object for starting BMC access for a baremetal server.

### Attributes

- **ip** (str): The IP address authorized to connect to the server.
- **server_id** (str): ID of the server.
- **zone** (Optional[ScwZone]): The zone to target. If none is passed, the default zone from the config will be used.
```

--------------------------------

### Get Hub Metrics

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway_async.iot.v1.html

Retrieves metrics for an IoT hub. Requires the hub ID, region, and a start date.

```APIDOC
## GetHubMetrics

### Description
Retrieves metrics for a hub.

### Method
GET

### Endpoint
/v1/hubs/{hub_id}/metrics

### Parameters
#### Path Parameters
- **hub_id** (string) - Required - The ID of the hub.

#### Query Parameters
- **region** (string) - Required - The region of the hub.
- **start_date** (string) - Required - The start date for retrieving metrics (ISO 8601 format).

### Response
#### Success Response (200)
- **metrics** (array of objects) - A list of metrics for the hub.
  - **timestamp** (string) - The timestamp of the metric.
  - **devices_connected** (integer) - The number of connected devices.
  - **messages_published** (integer) - The number of messages published.
  - **messages_received** (integer) - The number of messages received.
  - **bytes_published** (integer) - The number of bytes published.
  - **bytes_received** (integer) - The number of bytes received.
```

--------------------------------

### Create File System - Async

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway_async.file.v1alpha1.html

Use this to create a new file system. Ensure you provide a name and size compliant with Scaleway's limits. The region and project ID can be inferred from the client configuration if not explicitly provided.

```python
result = await api.create_file_system(
    name="example",
    size=1,
)
```

--------------------------------

### Get Device Metrics

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.iot.v1.html

Retrieves the metrics for a specific IoT device. You can filter metrics by specifying a start date.

```APIDOC
## GET /iot/devices/{device_id}/metrics

### Description
Get a device’s metrics. Get the metrics of an existing device, specified by its device ID.

### Method
GET

### Endpoint
/iot/devices/{device_id}/metrics

### Parameters
#### Path Parameters
- **device_id** (string) - Required - Device ID.
- **region** (string) - Optional - Region to target. If none is passed will use default region from the config.
- **start_date** (datetime) - Optional - Start date used to compute the best scale for the returned metrics.

### Response
#### Success Response (200)
- **GetDeviceMetricsResponse** - Contains the device metrics.
```

--------------------------------

### Initialize Scaleway Client (From Config)

Source: https://scaleway.github.io/scaleway-sdk-python/_sources/index.rst.txt

Initialize the Scaleway client by retrieving profile from configuration file and environment variables. Requires importing Client.

```python
from scaleway import Client

client = Client.from_config_file_and_env()
```

--------------------------------

### Get Device Metrics

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway_async.iot.v1.html

Retrieves metrics for a specific IoT device. Requires the device ID, region, and a start date.

```APIDOC
## GetDeviceMetrics

### Description
Retrieves metrics for a specific device.

### Method
GET

### Endpoint
/v1/devices/{device_id}/metrics

### Parameters
#### Path Parameters
- **device_id** (string) - Required - The ID of the device.

#### Query Parameters
- **region** (string) - Required - The region of the device.
- **start_date** (string) - Required - The start date for retrieving metrics (ISO 8601 format).

### Response
#### Success Response (200)
- **metrics** (array of objects) - A list of metrics for the device.
  - **timestamp** (string) - The timestamp of the metric.
  - **messages_published** (integer) - The number of messages published.
  - **messages_received** (integer) - The number of messages received.
  - **bytes_published** (integer) - The number of bytes published.
  - **bytes_received** (integer) - The number of bytes received.
```

--------------------------------

### Get Device Metrics

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.iot.v1.html

Retrieves the metrics of an existing device specified by its device ID. Includes an optional start date for filtering.

```APIDOC
## Get Device Metrics

### Description
Retrieves the metrics of an existing device, specified by its device ID. The `start_date` parameter can be used to specify the beginning of the period for which metrics are requested.

### Parameters
#### Path Parameters
- **device_id** (string) - Required - Device ID.
- **region** (string) - Optional - Region to target. If none is provided, the default region from the config will be used.
- **start_date** (datetime) - Optional - Start date used to compute the best scale for the returned metrics.

### Returns
- `GetDeviceMetricsResponse` - The response object containing device metrics.

### Usage
```python
result = api.get_device_metrics(device_id="example")
```
```

--------------------------------

### DediboxV1API Operations

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Operations for managing Dedibox servers, including retrieving information, installing, rebooting, starting, stopping, and updating server configurations.

```APIDOC
## DediboxV1API

### get_server_default_partitioning

**Description**: Retrieves the default partitioning for a server.

### get_server_install

**Description**: Gets the installation status or details for a server.

### get_service

**Description**: Retrieves details for a specific service.

### install_server

**Description**: Initiates the installation process for a server.

### list_failover_i_ps

**Description**: Lists failover IPs associated with a resource.

### list_failover_i_ps_all

**Description**: Lists all failover IPs associated with a resource.

### list_offers

**Description**: Lists available offers.

### list_offers_all

**Description**: Lists all available offers.

### list_os

**Description**: Lists available operating systems.

### list_os_all

**Description**: Lists all available operating systems.

### list_server_disks

**Description**: Lists disks associated with a server.

### list_server_disks_all

**Description**: Lists all disks associated with a server.

### list_server_events

**Description**: Lists events for a server.

### list_server_events_all

**Description**: Lists all events for a server.

### list_servers

**Description**: Lists servers.

### list_servers_all

**Description**: Lists all servers.

### list_services

**Description**: Lists services.

### list_services_all

**Description**: Lists all services.

### list_subscribable_server_options

**Description**: Lists subscribable options for a server.

### list_subscribable_server_options_all

**Description**: Lists all subscribable options for a server.

### reboot_server

**Description**: Reboots a server.

### start_bmc_access

**Description**: Starts BMC (Baseboard Management Controller) access for a server.

### start_rescue

**Description**: Starts the rescue mode for a server.

### start_server

**Description**: Starts a server.

### stop_bmc_access

**Description**: Stops BMC access for a server.

### stop_rescue

**Description**: Stops the rescue mode for a server.

### stop_server

**Description**: Stops a server.

### subscribe_server_option

**Description**: Subscribes to an option for a server.

### subscribe_storage_options

**Description**: Subscribes to storage options.

### update_raid

**Description**: Updates the RAID configuration for a server.

### update_reverse

**Description**: Updates reverse DNS settings.

### update_server

**Description**: Updates server settings.

### update_server_backup

**Description**: Updates server backup settings.

### update_server_tags

**Description**: Updates tags for a server.

### wait_for_bmc_access

**Description**: Waits for BMC access to become available for a server.

### wait_for_server

**Description**: Waits for a server to reach a specific state.

### wait_for_server_install

**Description**: Waits for a server installation to complete.
```

--------------------------------

### Start BMC Access

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.baremetal.v1.html

Initiates BMC (Baseboard Management Controller) access for a server. Requires prior setup of remote access options.

```APIDOC
## start_bmc_access

### Description
Start BMC access. Start BMC (Baseboard Management Controller) access associated with the ID. The BMC (Baseboard Management Controller) access is available one hour after the installation of the server. You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. After adding the BMC option, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do not forget to delete the Option after use.

### Parameters
#### Path Parameters
- **server_id** (str) - Required - ID of the server.
- **ip** (str) - Required - The IP authorized to connect to the server.
#### Query Parameters
- **zone** (str | None) - Optional - Zone to target. If none is passed will use default zone from the config.

### Returns
- `BMCAccess` - Information about the BMC access.
```

--------------------------------

### Install Server

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Installs an operating system on a baremetal server. This operation requires server ID, OS ID, and a hostname, with optional parameters for user credentials, partitioning, and SSH keys.

```APIDOC
## Install Server

### Description
Install a baremetal server.
Install an OS on the server associated with the given ID.

### Parameters
#### Path Parameters
- **server_id** (int) - Required - Server ID to install.
- **os_id** (int) - Required - OS ID to install on the server.
- **hostname** (str) - Required - Hostname of the server.
#### Query Parameters
- **zone** (str) - Optional - Zone to target. If none is passed will use default zone from the config.
- **user_login** (str) - Optional - User to install on the server.
- **user_password** (str) - Optional - User password to install on the server.
- **panel_password** (str) - Optional - Panel password to install on the server.
- **root_password** (str) - Optional - Root password to install on the server.
- **partitions** (List[InstallPartition]) - Optional - Partitions to install on the server.
- **ssh_key_ids** (List[str]) - Optional - SSH key IDs authorized on the server.
- **license_offer_id** (int) - Optional - Offer ID of license to install on server.
- **ip_id** (int) - Optional - IP to link at the license to install on server.

### Returns
`ServerInstall`

### Usage
```python
result = api.install_server(
    server_id=1,
    os_id=1,
    hostname="example",
)
```
```

--------------------------------

### Get OS

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway_async.baremetal.v1.html

Retrieves a specific Operating System by its ID. This function is useful for fetching details about an OS before performing actions like server installation.

```APIDOC
## GET /v1/os/{os_id}

### Description
Get OS with an ID. Return the specific OS for the ID.

### Method
GET

### Endpoint
/v1/os/{os_id}

### Parameters
#### Path Parameters
- **os_id** (string) - Required - ID of the OS.
- **zone** (string) - Optional - Zone to target. If none is passed will use default zone from the config.

### Response
#### Success Response (200)
- **OS** (object) - Details of the OS.
```

--------------------------------

### Install a Baremetal Server

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Install an operating system on a baremetal server. Requires server ID, OS ID, and hostname. Optional parameters include user credentials, partitioning, SSH keys, and license offers.

```python
result = api.install_server(
    server_id=1,
    os_id=1,
    hostname="example",
)
```

--------------------------------

### GetClusterMetricsRequest

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.redis.v1.html

Represents the request to get cluster metrics. It requires the cluster ID and optionally accepts a zone, start and end dates, and a metric name.

```APIDOC
## GetClusterMetricsRequest

### Description
Represents the request to get cluster metrics.

### Parameters
#### Path Parameters
- **cluster_id** (str) - Required - UUID of the cluster.
- **zone** (Optional[ScwZone]) - Optional - Zone to target. If none is passed will use default zone from the config.
- **start_at** (Optional[datetime]) - Optional - Start date.
- **end_at** (Optional[datetime]) - Optional - End date.
- **metric_name** (Optional[str]) - Optional - Name of the metric to gather.
```

--------------------------------

### Get Scaleway IoT Hub Metrics

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.iot.v1.html

Retrieve metrics for an IoT Hub. Specify the hub ID and optionally the region and start date for metric computation.

```python
result = api.get_hub_metrics(
    hub_id="example",
)
```

--------------------------------

### StartServerRequest

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.baremetal.v1.html

Request object for starting a bare metal server.

```APIDOC
## StartServerRequest

### Description
Request object for starting a bare metal server.

### Fields
- `boot_type` (string) - The boot type for the server.
- `server_id` (string) - The ID of the server to start.
- `ssh_key_ids` (array of strings) - A list of SSH key IDs to deploy.
- `zone` (string) - The zone of the server.
```

--------------------------------

### Get Hub Metrics - Scaleway IoT API

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway_async.iot.v1.html

Retrieves metrics for an IoT Hub. Requires the hub ID. The region and a start date for metric computation can be provided.

```python
result = await api.get_hub_metrics(
    hub_id="example",
)
```

--------------------------------

### InstallServerRequest Fields

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway_async.baremetal.html

Fields for installing an operating system on a server.

```APIDOC
## InstallServerRequest Fields

### `hostname` (string)

Hostname for the server.

### `os_id` (string)

ID of the operating system.

### `partitioning_schema` (string)

Partitioning schema for the server.

### `password` (string)

Password for the server.

### `server_id` (string)

ID of the server to install.

### `service_password` (string)

Service password for the server.

### `service_user` (string)

Service user for the server.

### `ssh_key_ids` (array of strings)

IDs of SSH keys to be added.

### `user` (string)

User for the server.

### `zone` (string)

Zone of the server.
```

--------------------------------

### Get Scaleway IoT Device Metrics

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.iot.v1.html

Retrieve metrics for a specific IoT device. Specify the device ID and optionally the region and start date for metric computation.

```python
result = api.get_device_metrics(
    device_id="example",
)
```

--------------------------------

### Start BMC Access for Baremetal Server

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Initiates Baseboard Management Controller (BMC) access for a baremetal server. BMC access is available one hour after server installation. Specify the server ID and the IP authorized to connect.

```python
result = api.start_bmc_access(
    server_id=1,
    ip="example",
)
```

--------------------------------

### InstallServerRequest Object

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Request object for installing an operating system on a server.

```APIDOC
## InstallServerRequest Object

### Description
Request object for installing an operating system on a server.

### Properties
- **hostname** (string) - The hostname for the server.
- **ip_id** (string) - The ID of the IP address to assign to the server.
- **license_offer_id** (string) - The ID of the license offer.
- **os_id** (string) - The ID of the operating system to install.
- **panel_password** (string) - The password for the control panel.
- **partitions** (array) - A list of partitions to create on the server.
- **root_password** (string) - The root password for the server.
- **server_id** (string) - The ID of the server to install.
- **ssh_key_ids** (array) - A list of SSH key IDs to authorize for the server.
- **user_login** (string) - The login name for the user.
- **user_password** (string) - The password for the user.
- **zone** (string) - The zone where the server is located.
```

--------------------------------

### Get Hub Metrics

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.iot.v1.html

Retrieves metrics for a specific IoT Hub. This function allows you to fetch performance and usage data for an existing IoT Hub, identified by its Hub ID. You can optionally specify a region and a start date for the metrics calculation.

```APIDOC
## GET /v1/hubs/{hub_id}/metrics

### Description
Get a hub’s metrics. Get the metrics of an existing IoT Hub, specified by its Hub ID.

### Method
GET

### Endpoint
/v1/hubs/{hub_id}/metrics

### Parameters
#### Path Parameters
- **hub_id** (string) - Required - Hub ID.
- **region** (string) - Optional - Region to target. If none is passed will use default region from the config.
- **start_date** (datetime) - Optional - Start date used to compute the best scale for returned metrics.

### Response
#### Success Response (200)
- **GetHubMetricsResponse** - Details about the hub's metrics.
```

--------------------------------

### Get Database Instance Metrics

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway_async.document_db.v1beta1.html

Retrieves time series metrics for a Database Instance. Allows specifying a date range and a specific metric name. Requires the instance ID and optionally the region, start date, end date, and metric name.

```python
result = await api.get_instance_metrics(
    instance_id="example",
)
```

--------------------------------

### GetServerInstallRequest

Source: https://scaleway.github.io/scaleway-sdk-python/source/scaleway.dedibox.v1.html

Request object for initiating a server installation on a Dedibox server.

```APIDOC
## GetServerInstallRequest

### Description
Request object for initiating a server installation on a Dedibox server.

### Parameters
#### Path Parameters
None

#### Query Parameters
- **zone** (ScwZone) - Optional - Zone to target. If none is passed will use default zone from the config.

#### Request Body
- **server_id** (int) - Required - Server ID of the server to install.
```
Tokens:
Raw