Scaleway API

https://www.scaleway.com/en/developers/api/
Admin
The Scaleway API allows you to create and manage all your Scaleway resources programmatically, from...
Tokens:2,185,199
Snippets:10,180
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example Server Installation Status Response

Source: https://www.scaleway.com/en/developers/api/dedibox/install

An example of the JSON response when querying the status of a server installation. It includes details like OS ID, hostname, and installation status.

```json
{
  "os_id": 0,
  "hostname": "hostname",
  "user_login": "user_login",
  "partitions": [
    {
      "type": "primary",
      "file_system": "unknown",
      "mount_point": "mount_point",
      "raid_level": "no_raid",
      "capacity": 0,
      "connectors": [
        "string"
      ]
    }
  ],
  "ssh_key_ids": [
    "string"
  ],
  "status": "unknown",
  "panel_url": "panel_url"
}
```

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

### Example Response: Get OS by ID

Source: https://www.scaleway.com/en/developers/api/elastic-metal/os

This is an example of a successful response when retrieving a specific OS by its ID. It provides all the details of the OS, including its configuration and support features.

```json
{
  "id": "id",
  "name": "name",
  "version": "version",
  "logo_url": "logo_url",
  "ssh": {
    "editable": true,
    "required": true,
    "default_value": "default_value"
  },
  "user": {
    "editable": true,
    "required": true,
    "default_value": "default_value"
  },
  "password": {
    "editable": true,
    "required": true,
    "default_value": "default_value"
  },
  "service_user": {
    "editable": true,
    "required": true,
    "default_value": "default_value"
  },
  "service_password": {
    "editable": true,
    "required": true,
    "default_value": "default_value"
  },
  "enabled": true,
  "license_required": true,
  "allowed": true,
  "custom_partitioning_supported": true,
  "cloud_init_supported": true,
  "cloud_init_version": "cloud_init_version",
  "zone": "zone"
}
```

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

### Example Baremetal Server Install Request Body

Source: https://www.scaleway.com/en/developers/api/dedibox/install

This JSON object represents a sample request body for installing an OS on a baremetal server. It includes parameters for OS ID, hostname, user credentials, partitioning, and SSH keys.

```json
{
  "os_id": 0,
  "hostname": "hostname",
  "user_login": "user_login",
  "user_password": "user_password",
  "panel_password": "panel_password",
  "root_password": "root_password",
  "partitions": [
    {
      "file_system": "unknown",
      "mount_point": "mount_point",
      "raid_level": "no_raid",
      "capacity": 0,
      "connectors": [
        "string"
      ]
    }
  ],
  "ssh_key_ids": [
    "string"
  ],
  "license_offer_id": 0,
  "ip_id": 0
}
```

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

### Example Response for Get Instance Compatible Types

Source: https://www.scaleway.com/en/developers/api/instance/instances

An example of a successful response when querying for compatible instance types, listing available types as an array of strings.

```json
{
  "compatible_types": [
    "string"
  ]
}
```

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

### Example Response for Get Database Instance Logs

Source: https://www.scaleway.com/en/developers/api/managed-database-postgre-mysql/database-instances

This is an example of a successful response when retrieving logs for a Database Instance. It includes the download URL, log ID, status, node name, expiration, creation, and region.

```json
{
  "download_url": "download_url",
  "id": "id",
  "status": "unknown",
  "node_name": "node_name",
  "expires_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "region": "region"
}
```

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

### Example Response: List OSes

Source: https://www.scaleway.com/en/developers/api/elastic-metal/os

This is an example of a successful response when listing available OSes. It includes total count and details for each OS, such as ID, name, version, and configuration options.

```json
{
  "total_count": 0,
  "os": [
    {
      "id": "id",
      "name": "name",
      "version": "version",
      "logo_url": "logo_url",
      "ssh": {
        "editable": true,
        "required": true,
        "default_value": "default_value"
      },
      "user": {
        "editable": true,
        "required": true,
        "default_value": "default_value"
      },
      "password": {
        "editable": true,
        "required": true,
        "default_value": "default_value"
      },
      "service_user": {
        "editable": true,
        "required": true,
        "default_value": "default_value"
      },
      "service_password": {
        "editable": true,
        "required": true,
        "default_value": "default_value"
      },
      "enabled": true,
      "license_required": true,
      "allowed": true,
      "custom_partitioning_supported": true,
      "cloud_init_supported": true,
      "cloud_init_version": "cloud_init_version",
      "zone": "zone"
    }
  ]
}
```

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

### Get Server Installation Status

Source: https://www.scaleway.com/en/developers/api/dedibox/install

Retrieve the current status of a server's installation. This is useful for monitoring the progress of a new server setup.

```shell
curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/dedibox/v1/zones/{zone}/servers/{server_id}/install"
```

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

### Create Device Example

Source: https://www.scaleway.com/en/developers/api/iot/v1/schema.yml

Example of how to create a new IoT device and publish a message.

```APIDOC
## Create Device and Publish Message

### Description
This example demonstrates how to create a new IoT device and publish a message to a specific topic using the Scaleway IoT Hub.

### Method
POST

### Endpoint
`/iot/v1/devices`

### Parameters
#### Query Parameters
- **hub_id** (string) - Required - The ID of the IoT Hub to which the device will be added.

#### Request Body
- **name** (string) - Required - The name of the device.
- **description** (string) - Optional - A description for the device.
- **status** (string) - Optional - The status of the device (e.g., `enabled`, `disabled`). Defaults to `unknown`.
- **allow_insecure** (boolean) - Optional - Whether to allow insecure connections.
- **allow_multiple_connections** (boolean) - Optional - Whether to allow multiple connections with the same device credentials.
- **message_filters** (object) - Optional - Filters to restrict topics the device can publish/subscribe to.
  - **publish** (object) - Optional - Filtering rule for publish topics.
    - **policy** (string) - Optional - How to use the topic list (`accept` or `reject`). Defaults to `unknown`.

### Request Example
```json
{
  "name": "mydevice",
  "description": "My first device",
  "status": "enabled",
  "allow_insecure": false,
  "allow_multiple_connections": false,
  "message_filters": {
    "publish": {
      "policy": "accept",
      "topics": [
        "mydevice/events",
        "mydevice/state"
      ]
    }
  }
}
```

### Response
#### Success Response (200)
- **device** (object) - Information about the created device.
  - **id** (string) - Device ID.
  - **name** (string) - Device name.
  - **description** (string) - Device description.
  - **status** (string) - Device status.
  - **hub_id** (string) - Hub ID.
  - **last_activity_at** (string) - Last activity date (RFC 3339 format).
  - **is_connected** (boolean) - Whether the device is connected.
  - **allow_insecure** (boolean) - Whether insecure connections are allowed.
  - **allow_multiple_connections** (boolean) - Whether multiple connections are allowed.
  - **message_filters** (object) - Message filters applied to the device.

#### Response Example
```json
{
  "device": {
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "name": "mydevice",
    "description": "My first device",
    "status": "enabled",
    "hub_id": "00000000-0000-0000-0000-000000000000",
    "last_activity_at": "2023-10-27T10:00:00Z",
    "is_connected": false,
    "allow_insecure": false,
    "allow_multiple_connections": false,
    "message_filters": {
      "publish": {
        "policy": "accept",
        "topics": [
          "mydevice/events",
          "mydevice/state"
        ]
      }
    }
  }
}
```

### Publishing a Message
```bash
export SCW_SECRET_KEY='YOUR_SECRET_KEY'
export SCW_ACCESS_KEY='YOUR_ACCESS_KEY'

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Scaleway-IAM $SCW_ACCESS_KEY:$SCW_SECRET_KEY" \
  -d '{"message": "Hello, world!"}' \
  https://api.scaleway.com/iot/v1/hubs/00000000-0000-0000-0000-000000000000/devices/a1b2c3d4-e5f6-7890-1234-567890abcdef/publish?topic=mytopic/mysubtopic
```
```

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

### Example JSON Request Body for Starting Rescue

Source: https://www.scaleway.com/en/developers/api/dedibox/rescue

This is an example of the JSON request body required when starting rescue mode on a baremetal server.

```json
{
  "os_id": 0
}
```

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

### Example Request Body for Creating Servers

Source: https://www.scaleway.com/en/developers/api/elastic-metal/servers

This JSON payload demonstrates the structure for creating multiple Elastic Metal servers, including common configurations and individual server specifications. It allows for detailed setup of OS installation, partitioning, and other options.

```json
{
  "common_configuration": {
    "zone": "fr-par-1",
    "offer_id": "offer_id",
    "organization_id": "organization_id",
    "project_id": "project_id",
    "name": "name",
    "description": "description",
    "tags": [
      "string"
    ],
    "install": {
      "os_id": "os_id",
      "hostname": "hostname",
      "ssh_key_ids": [
        "string"
      ],
      "user": "user",
      "password": "password",
      "service_user": "service_user",
      "service_password": "service_password",
      "partitioning_schema": {
        "disks": [
          {
            "device": "device",
            "partitions": [
              {
                "label": "unknown_partition_label",
                "number": 0,
                "size": 0,
                "use_all_available_space": true
              }
            ]
          }
        ],
        "raids": [
          {
            "name": "name",
            "level": "unknown_raid_level",
            "devices": [
              "string"
            ]
          }
        ],
        "filesystems": [
          {
            "device": "device",
            "format": "unknown_format",
            "mountpoint": "mountpoint"
          }
        ],
        "zfs": {
          "pools": [
            {
              "name": "name",
              "type": "unknown_type",
              "devices": [
                "string"
              ],
              "options": [
                "string"
              ],
              "filesystem_options": [
                "string"
              ]
            }
          ]
        }
      }
    },
    "option_ids": [
      "string"
    ],
    "protected": true,
    "user_data": {
      "value": "value"
    }
  },
  "servers": [
    {
      "hostname": "hostname",
      "description": "description",
      "tags": [
        "string"
      ]
    }
  ]
}
```

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

### Prepare Logs Response Example

Source: https://www.scaleway.com/en/developers/api/managed-database-postgre-mysql/database-instances

This is an example of a successful response (200 OK) when preparing database instance logs. It contains a list of `instance_logs` with details like `download_url`, `id`, and `status`.

```json
{ 
  "instance_logs": [ 
    { 
      "download_url": "download_url", 
      "id": "id", 
      "status": "unknown", 
      "node_name": "node_name", 
      "expires_at": "2022-03-22T12:34:56.123456Z", 
      "created_at": "2022-03-22T12:34:56.123456Z", 
      "region": "region" 
    } 
  ] 
}
```

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

### Get Server Installation Status

Source: https://www.scaleway.com/en/developers/api/dedibox/v1/schema.yml

Retrieves the installation status of a specific Dedibox server.

```APIDOC
## GET /dedibox/v1/zones/{zone}/servers/{server_id}/install

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

### Method
GET

### Endpoint
/dedibox/v1/zones/{zone}/servers/{server_id}/install

### Parameters
#### Path Parameters
- **zone** (string) - Required - The zone you want to target
- **server_id** (integer) - Required - Server ID of the server to install.

### Response
#### Success Response (200)
- **status** (string) - The current installation status of the server.
- **os_id** (integer) - The ID of the OS installed on the server.

#### Response Example
{
  "example": "{\"status\": \"installed\", \"os_id\": 123}"
}
```

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

### Example Response: List All Instances

Source: https://www.scaleway.com/en/developers/api/instance/instances

This is an example of a successful response when listing instances. It includes details about each server such as ID, name, tags, commercial type, and IP addresses.

```json
{
  "servers": [
    {
      "id": "id",
      "name": "name",
      "organization": "organization",
      "project": "project",
      "allowed_actions": [
        "poweron"
      ],
      "tags": [
        "string"
      ],
      "commercial_type": "commercial_type",
      "creation_date": "2022-03-22T12:34:56.123456Z",
      "dynamic_ip_required": true,
      "routed_ip_enabled": true,
      "enable_ipv6": true,
      "hostname": "hostname",
      "image": {
        "id": "id",
        "name": "name",
        "arch": "unknown_arch",
        "creation_date": "2022-03-22T12:34:56.123456Z",
        "modification_date": "2022-03-22T12:34:56.123456Z",
        "default_bootscript": {
          "architecture": "unknown_arch",
          "bootcmdargs": "bootcmdargs",
          "default": true,
          "dtb": "dtb",
          "id": "id",
          "initrd": "initrd",
          "kernel": "kernel",
          "organization": "organization",
          "public": true,
          "title": "title",
          "project": "project",
          "zone": "zone"
        },
        "extra_volumes": {
          "<extra_volumeKey>": {
            "id": "id",
            "name": "name",
            "export_uri": "export_uri",
            "size": 0,
            "volume_type": "l_ssd",
            "creation_date": "2022-03-22T12:34:56.123456Z",
            "modification_date": "2022-03-22T12:34:56.123456Z",
            "organization": "organization",
            "project": "project",
            "tags": [
              "string"
            ],
            "server": {
              "id": "id",
              "name": "name"
            },
            "state": "available",
            "zone": "zone"
          }
        },
        "from_server": "from_server",
        "organization": "organization",
        "public": true,
        "root_volume": {
          "id": "id",
          "name": "name",
          "size": 0,
          "volume_type": "l_ssd"
        },
        "state": "available",
        "project": "project",
        "tags": [
          "string"
        ],
        "zone": "zone"
      },
      "protected": true,
      "private_ip": "private_ip",
      "public_ip": {
        "id": "id",
        "address": "1.2.3.4",
        "gateway": "1.2.3.4",
        "netmask": "netmask",
        "family": "inet",
        "dynamic": true,
        "provisioning_mode": "manual",
        "tags": [

```

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

### Start Job Definition (POST Request)

Source: https://www.scaleway.com/en/developers/api/serverless-jobs/v1alpha2/schema.yml

This example demonstrates how to initiate a job run for an existing job definition. It requires the region and job definition ID in the URL path. The request body should contain any specific parameters for the job run, if applicable.

```HTTP
POST /serverless-jobs/v1alpha2/regions/{region}/job-definitions/{job_definition_id}/start HTTP/1.1
Host: api.scaleway.com
Content-Type: application/json
Authorization: Scaleway-Token $SCW_SECRET_KEY

{}
```

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

### Example Response for Getting a SAML Certificate

Source: https://www.scaleway.com/en/developers/api/iam/saml

This is an example of a successful response when retrieving a SAML certificate.

```json
{
  "id": "id",
  "type": "unknown_certificate_type",
  "origin": "unknown_certificate_origin",
  "content": "content",
  "expires_at": "2022-03-22T12:34:56.123456Z"
}
```

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

### Example Response for Get Backups

Source: https://www.scaleway.com/en/developers/api/dedibox/~endpoints

An example of a successful response when retrieving Dedibox server backups.

```json
{
  "id": 0,
  "login": "login",
  "server": "server",
  "status": "unknown_backup_status",
  "acl_enabled": true,
  "autologin": true,
  "quota_space": 0,
  "quota_space_used": 0,
  "quota_files": 0,
  "quota_files_used": 0
}
```

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

### Example Response for Listing Users

Source: https://www.scaleway.com/en/developers/api/messageq/cloud-essentials-for-rabbitmq

This is an example of a successful response when listing deployment users, showing the 'users' array and 'total_count'.

```json
{
  "users": [
    {
      "username": "username"
    }
  ],
  "total_count": 0
}
```

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

### Get Server Installation Status

Source: https://www.scaleway.com/en/developers/api/dedibox/install

Retrieves the status of the server installation associated with the given server ID.

```APIDOC
## GET /dedibox/v1/zones/{zone}/servers/{server_id}/install

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

### Method
GET

### Endpoint
https://api.scaleway.com/dedibox/v1/zones/{zone}/servers/{server_id}/install

### Parameters
#### Path Parameters
- **zone** (string) - Required - The zone you want to target (Enum values: fr-par-1, fr-par-2, nl-ams-1)
- **server_id** (integer) - Required - Server ID of the server to install.

### Responses
#### Success Response (200)
- **os_id** (integer) - 
- **hostname** (string) - 
- **user_login** (string) - 
- **partitions** (scaleway.dedibox.v1.Partition[]) - 
- **ssh_key_ids** (string[]) - 
- **status** (scaleway.dedibox.v1.Server.Install.Status) - Enum values: unknown, booting, setting_up_raid, partitioning, formatting, installing, configuring, configuring_bootloader, show 2 more. Default: unknown
- **panel_url** (string) - 

### Request Example
```json
{
  "os_id": 0,
  "hostname": "hostname",
  "user_login": "user_login",
  "partitions": [
    {
      "type": "primary",
      "file_system": "unknown",
      "mount_point": "mount_point",
      "raid_level": "no_raid",
      "capacity": 0,
      "connectors": [
        "string"
      ]
    }
  ],
  "ssh_key_ids": [
    "string"
  ],
  "status": "unknown",
  "panel_url": "panel_url"
}
```
```

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

### Get ACL Rules for VPC Response Example

Source: https://www.scaleway.com/en/developers/api/vpc/network-acls

Example JSON response when retrieving ACL rules for a VPC.

```json
{
  "rules": [
    {
      "protocol": "ANY",
      "source": "1.2.3.4/32",
      "src_port_low": 0,
      "src_port_high": 0,
      "destination": "1.2.3.4/32",
      "dst_port_low": 0,
      "dst_port_high": 0,
      "action": "unknown_action",
      "description": "description"
    }
  ],
  "default_policy": "unknown_action"
}
```

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

### Install Server

Source: https://www.scaleway.com/en/developers/api/dedibox/v1/schema.yml

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

```APIDOC
## POST /dedibox/v1/zones/{zone}/servers/{server_id}/install

### Description
Installs an operating system on a server with specified configuration details.

### Method
POST

### Endpoint
/dedibox/v1/zones/{zone}/servers/{server_id}/install

### Parameters
#### Path Parameters
- **zone** (string) - Required - The zone you want to target
- **server_id** (integer) - Required - ID of the server.

#### Request Body
- **os_id** (integer) - Required - Operating system to install on the server.
- **hostname** (string) - Optional - Hostname of the server.
- **user_login** (string) - Optional - User to install on the server.
- **user_password** (string) - Optional - User password to install on the server.
- **panel_password** (string) - Optional - Panel password to install on the server.
- **root_password** (string) - Optional - Root password to install on the server.
- **partitions** (array) - Optional - Partitions to install on the server.
- **ssh_key_ids** (array) - Optional - SSH key IDs authorized on the server.
- **license_offer_id** (integer) - Optional - Offer ID of license to install on server.
- **ip_id** (integer) - Optional - IP to link at the license to install on server.

### Request Example
{
  "example": "{\"hostname\":\"string\",\"os_id\":42}"
}

### Response
#### Success Response (200)
- **(No specific fields documented)**

#### Response Example
{
  "example": "(No example provided in source)"
}
```

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

### Example Response for Get Cloud Twin Document

Source: https://www.scaleway.com/en/developers/api/iot/iot-cloud-twins

This is an example of a successful response when retrieving a Cloud Twin document.

```json
{
  "twin_id": "twin_id",
  "document_name": "document_name",
  "version": 0,
  "data": {
    "<fieldKey>": {}
  }
}
```

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

### Example Response for Listing Notebook Versions

Source: https://www.scaleway.com/en/developers/api/data-lab/clusters-for-apache-sparktm

This is an example of a successful response (200 OK) when listing notebook versions. It includes details about the notebook versions available, such as their name, description, and specific version information.

```json
{
  "notebooks": [
    {
      "name": "name",
      "description": "description",
      "versions": [
        {
          "version": "version",
          "end_of_life": "2022-03-22T12:34:56.123456Z",
          "created_at": "2022-03-22T12:34:56.123456Z",
          "updated_at": "2022-03-22T12:34:56.123456Z",
          "disabled": true,
          "beta": true
        }
      ]
    }
  ],
  "total_count": 0
}
```

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

### Get Server Installation Status

Source: https://www.scaleway.com/en/developers/api/dedibox/v1/schema.yml

Check the current installation status of a baremetal server in a specified zone. This operation requires authentication.

```cURL
curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/dedibox/v1/zones/{zone}/servers/{server_id}/install"
```

```HTTPie
http GET "https://api.scaleway.com/dedibox/v1/zones/{zone}/servers/{server_id}/install" \
  X-Auth-Token:$SCW_SECRET_KEY
```

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

### Start Job Definition Response

Source: https://www.scaleway.com/en/developers/api/serverless-jobs/job-definitions

Example JSON response when a job definition is successfully started. Includes details about the created job runs.

```json
{
  "job_runs": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "job_definition_id": "6170692e-7363-616c-6577-61792e636f6d",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "started_at": "2022-03-22T12:34:56.123456Z",
      "terminated_at": "2022-03-22T12:34:56.123456Z",
      "run_duration": "2.5s",
      "state": "unknown_state",
      "reason": "unknown_reason",
      "exit_code": 0,
      "error_message": "error_message",
      "cpu_limit": 0,
      "memory_limit": 0,
      "local_storage_capacity": 0,
      "command": "command",
      "environment_variables": {
        "<environment_variableKey>": "<environment_variableKey>"
      },
      "startup_command": [
        "string"
      ],
      "args": [
        "string"
      ],
      "attempts": 0,
      "region": "region"
    }
  ]
}
```

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

### Example of creating a device using curl

Source: https://www.scaleway.com/en/developers/api/iot/v1/schema.yml

This example demonstrates how to create a new IoT device using `curl`. It requires the Hub ID and specifies device details like name and description.

```bash
curl -X POST https://api.scaleway.com/iot/v1/devices \
  -H "Content-Type: application/json" \
  -u "YOUR_ACCESS_KEY:YOUR_SECRET_KEY" \
  -d @- << EOF
{
  "name": "mydevice",
  "description": "My first device",
  "hub_id": "YOUR_HUB_ID"
}
EOF
```

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

### Example response for getting an ACL rule

Source: https://www.scaleway.com/en/developers/api/managed-database-redis/acl-rules

This is an example of a successful response when retrieving an ACL rule, showing its ID, IP CIDR, and description.

```json
{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "ip_cidr": "1.2.3.4/32",
  "description": "description"
}
```

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

### Install Baremetal Server with cURL

Source: https://www.scaleway.com/en/developers/api/dedibox/install

Use this cURL command to install an OS on a baremetal server. Ensure you replace `{zone}` and `{server_id}` with your specific values and set the `X-Auth-Token` environment variable.

```bash
curl -X POST \   -H "X-Auth-Token: $SCW_SECRET_KEY" \   -H "Content-Type: application/json" \   -d '{"hostname":"string","os_id":42}' \   "https://api.scaleway.com/dedibox/v1/zones/{zone}/servers/{server_id}/install"
```

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

### Example Response for Get Link

Source: https://www.scaleway.com/en/developers/api/interlink/links

This is an example of a successful JSON response when retrieving link details. It includes comprehensive information about the link's configuration and status.

```json
{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "tags": [
    "string"
  ],
  "pop_id": "6170692e-7363-616c-6577-61792e636f6d",
  "bandwidth_mbps": 0,
  "status": "unknown_link_status",
  "bgp_v4_status": "unknown_bgp_status",
  "bgp_v6_status": "unknown_bgp_status",
  "vpc_id": "6170692e-7363-616c-6577-61792e636f6d",
  "routing_policy_id": "6170692e-7363-616c-6577-61792e636f6d",
  "enable_route_propagation": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "partner": {
    "partner_id": "6170692e-7363-616c-6577-61792e636f6d",
    "pairing_key": "pairing_key",
    "disapproved_reason": "disapproved_reason",
    "l3_connectivity": true
  },
  "self": {
    "connection_id": "6170692e-7363-616c-6577-61792e636f6d"
  },
  "vlan": 0,
  "scw_bgp_config": {
    "asn": 0,
    "ipv4": "1.2.3.4/32",
    "ipv6": "1.2.3.4/32"
  },
  "peer_bgp_config": {
    "asn": 0,
    "ipv4": "1.2.3.4/32",
    "ipv6": "1.2.3.4/32"
  },
  "routing_policy_v4_id": "6170692e-7363-616c-6577-61792e636f6d",
  "routing_policy_v6_id": "6170692e-7363-616c-6577-61792e636f6d",
  "region": "region"
}
```

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

### Example Response for Listing Versions

Source: https://www.scaleway.com/en/developers/api/cloud-essentials-for-opensearch/cloud-essentials-for-opensearch

This is an example of a successful response when listing available Cloud Essentials for OpenSearch versions. It includes details about each version and the total count.

```json
{
  "versions": [
    {
      "version": "version",
      "end_of_life": "2022-03-22T12:34:56.123456Z",
      "disabled": true,
      "beta": true
    }
  ],
  "total_count": 0
}
```

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

### Install a baremetal server

Source: https://www.scaleway.com/en/developers/api/dedibox/install

Installs an OS on the server associated with the given ID. This operation requires specifying the zone, server ID, and OS ID, along with optional configuration details.

```APIDOC
## POST /dedibox/v1/zones/{zone}/servers/{server_id}/install

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

### Method
POST

### Endpoint
https://api.scaleway.com/dedibox/v1/zones/{zone}/servers/{server_id}/install

### Parameters
#### Path Parameters
- **zone** (string) - Required - The zone you want to target. Enum values: fr-par-1, fr-par-2, nl-ams-1
- **server_id** (integer) - Required - Server ID to install.

#### Request Body
- **os_id** (integer) - Optional - OS ID to install on the server.
- **hostname** (string) - Optional - Hostname of the server.
- **user_login** (string) - Optional - User to install on the server.
- **user_password** (string) - Optional - User password to install on the server.
- **panel_password** (string) - Optional - Panel password to install on the server.
- **root_password** (string) - Optional - Root password to install on the server.
- **partitions** (scaleway.dedibox.v1.InstallPartition[]) - Optional - Partitions to install on the server.
- **ssh_key_ids** (string[]) - Optional - SSH key IDs authorized on the server.
- **license_offer_id** (integer) - Optional - Offer ID of license to install on server.
- **ip_id** (integer) - Optional - IP to link at the license to install on server.

### Request Example
```json
{
  "os_id": 0,
  "hostname": "hostname",
  "user_login": "user_login",
  "user_password": "user_password",
  "panel_password": "panel_password",
  "root_password": "root_password",
  "partitions": [
    {
      "file_system": "unknown",
      "mount_point": "mount_point",
      "raid_level": "no_raid",
      "capacity": 0,
      "connectors": [
        "string"
      ]
    }
  ],
  "ssh_key_ids": [
    "string"
  ],
  "license_offer_id": 0,
  "ip_id": 0
}
```

### Response
#### Success Response (200)
- **os_id** (integer) - OS ID to install on the server.
- **hostname** (string) - Hostname of the server.
- **user_login** (string) - User to install on the server.
- **partitions** (scaleway.dedibox.v1.Partition[]) - Partitions to install on the server.
- **ssh_key_ids** (string[]) - SSH key IDs authorized on the server.
- **status** (scaleway.dedibox.v1.Server.Install.Status) - Status of the installation. Enum values: unknown, booting, setting_up_raid, partitioning, formatting, installing, configuring, configuring_bootloader, show 2 more. Default: unknown
- **panel_url** (google.protobuf.StringValue) - URL for the panel.

#### Response Example
```json
{
  "os_id": 0,
  "hostname": "hostname",
  "user_login": "user_login",
  "partitions": [
    {
      "type": "primary",
      "file_system": "unknown",
      "mount_point": "mount_point",
      "raid_level": "no_raid",
      "capacity": 0,
      "connectors": [
        "string"
      ]
    }
  ],
  "ssh_key_ids": [
    "string"
  ],
  "status": "unknown",
  "panel_url": "panel_url"
}
```
```

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

### Job Definition Start Request Body

Source: https://www.scaleway.com/en/developers/api/serverless-jobs/job-definitions

Example JSON payload for starting a job definition. Allows customization of command, arguments, environment variables, and replica count.

```json
{
  "command": "command",
  "startup_command": [
    "string"
  ],
  "args": [
    "string"
  ],
  "environment_variables": {
    "<key>": "<key>"
  },
  "replicas": 0
}
```

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

### List Projects Response Example

Source: https://www.scaleway.com/en/developers/api/account/project

An example response when listing projects. It includes the total count and a list of project objects.

```json
{
  "total_count": "2",
  "projects": [
    {
      "id": "0fe11800-ddbb-4b62-8906-ed08780cdddb",
      "name": "default",
      "organization_id": "b12d5c3g-c612-5674-c1e9-92627f36c5b9",
      "created_at": "2022-08-31T07:45:53.657735Z",
      "updated_at": "2022-08-31T07:45:53.657735Z",
      "description": "cannot_be_deleted"
    },
    {
        "id":"6170692e-7363-616c-6577-61792e636f6d",
        "name":"Dis-Iz-My-Projekt",
        "organization_id":"b12d5c3g-c612-5674-c1e9-92627f36c5b9",
        "created_at":"2023-03-02T22:00:28.888380Z",
        "updated_at":"2023-03-02T22:00:28.888380Z",
        "description":"This is the description of my Project"
    },
]
}
```

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

### Get a Model - Example Response

Source: https://www.scaleway.com/en/developers/api/inference/models

This is a sample JSON response for a successful request to get a model. It includes details such as the model's ID, name, status, and configuration.

```json
{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "tags": [
    "string"
  ],
  "status": "unknown_status",
  "description": "description",
  "error_message": "error_message",
  "has_eula": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "region": "region",
  "nodes_support": [
    {
      "nodes": [
        {
          "node_type_name": "node_type_name",
          "quantizations": [
            {
              "quantization_bits": 0,
              "allowed": true,
              "max_context_size": 0
            }
          ]
        }
      ]
    }
  ],
  "parameter_size_bits": 0,
  "size_bytes": 0
}
```

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

### Example Instance Response

Source: https://www.scaleway.com/en/developers/api/instance/instances

This is an example of a successful response (200 OK) when retrieving instance details. It includes comprehensive information about the server's configuration, state, and associated resources.

```json
{
  "server": {
    "id": "id",
    "name": "name",
    "organization": "organization",
    "project": "project",
    "allowed_actions": [
      "poweron"
    ],
    "tags": [
      "string"
    ],
    "commercial_type": "commercial_type",
    "creation_date": "2022-03-22T12:34:56.123456Z",
    "dynamic_ip_required": true,
    "routed_ip_enabled": true,
    "enable_ipv6": true,
    "hostname": "hostname",
    "image": {
      "id": "id",
      "name": "name",
      "arch": "unknown_arch",
      "creation_date": "2022-03-22T12:34:56.123456Z",
      "modification_date": "2022-03-22T12:34:56.123456Z",
      "default_bootscript": {
        "architecture": "unknown_arch",
        "bootcmdargs": "bootcmdargs",
        "default": true,
        "dtb": "dtb",
        "id": "id",
        "initrd": "initrd",
        "kernel": "kernel",
        "organization": "organization",
        "public": true,
        "title": "title",
        "project": "project",
        "zone": "zone"
      },
      "extra_volumes": {
        "<extra_volumeKey>": {
          "id": "id",
          "name": "name",
          "export_uri": "export_uri",
          "size": 0,
          "volume_type": "l_ssd",
          "creation_date": "2022-03-22T12:34:56.123456Z",
          "modification_date": "2022-03-22T12:34:56.123456Z",
          "organization": "organization",
          "project": "project",
          "tags": [
            "string"
          ],
          "server": {
            "id": "id",
            "name": "name"
          },
          "state": "available",
          "zone": "zone"
        }
      },
      "from_server": "from_server",
      "organization": "organization",
      "public": true,
      "root_volume": {
        "id": "id",
        "name": "name",
        "size": 0,
        "volume_type": "l_ssd"
      },
      "state": "available",
      "project": "project",
      "tags": [
        "string"
      ],
      "zone": "zone"
    },
    "protected": true,
    "private_ip": "private_ip",
    "public_ip": {
      "id": "id",
      "address": "1.2.3.4",
      "gateway": "1.2.3.4",
      "netmask": "netmask",
      "family": "inet",
      "dynamic": true,
      "provisioning_mode": "manual",
      "tags": [
        "string"
      ],
      "ipam_id": "6170692e-7363-616c-6577-61792e636f6d",
      "state": "unknown_state"
    },
    "public_ips": [
      {
        "id": "id",
        "address": "1.2.3.4",
        "gateway": "1.2.3.4",
        "netmask": "netmask",
        "family": "inet",
        "dynamic": true,
        "provisioning_mode": "manual",
        "tags": [
          "string"
        ],
        "ipam_id": "6170692e-7363-616c-6577-61792e636f6d",
        "state": "unknown_state"
      }
    ],
    "mac_address": "mac_address",
    "modification_date": "2022-03-22T12:34:56.123456Z",
    "state": "running",
    "location": {
      "cluster_id": "cluster_id",
      "hypervisor_id": "hypervisor_id",
      "node_id": "node_id",
      "platform_id": "platform_id",
      "zone_id": "zone_id"
    },
    "ipv6": {
      "address": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "gateway": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "netmask": "netmask"
    },
    "boot_type": "local",
    "volumes": {
      "<volumeKey>": {
        "id": "id",
        "name": "name",
        "export_uri": "export_uri",
        "organization": "organization",
        "server": {
          "id": "id",
          "name": "name"
        },
        "size": 0,
        "volume_type": "l_ssd",
        "creation_date": "2022-03-22T12:34:56.123456Z",
        "modification_date": "2022-03-22T12:34:56.123456Z",
        "state": "available",
        "project": "project",
        "boot": true,
        "zone": "zone"
      }
    },
    "security_group": {
      "id": "id",
      "name": "name"
    },
    "maintenances": [
      {
        "reason": "reason",
        "start_date": "2022-03-22T12:34:56.123456Z"
      }
    ],
    "state_detail": "state_detail",
    "arch": "unknown_arch",
    "placement_group": {
      "id": "id",
      "name": "name",
      "organization": "organization",
      "project": "project",
      "tags": [
        "string"
      ],
      "policy_mode": "optional",
      "policy_type": "max_availability"
    }
  }
}
```

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

### Example Response for Setting Privileges

Source: https://www.scaleway.com/en/developers/api/managed-database-postgre-mysql/privileges

A sample JSON response after successfully setting user privileges, confirming the assigned permission, database name, and user name.

```json
{
  "permission": "readonly",
  "database_name": "database_name",
  "user_name": "user_name"
}
```

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

### Get a JWT Response Example

Source: https://www.scaleway.com/en/developers/api/iam/jwts

Example JSON response when retrieving a single JWT, detailing its properties like creation date, expiration, and associated IP address.

```json
{
  "jti": "jti",
  "issuer_id": "issuer_id",
  "audience_id": "audience_id",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "expires_at": "2022-03-22T12:34:56.123456Z",
  "ip": "1.2.3.4",
  "user_agent": "user_agent"
}
```

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

### Project Creation Response Example

Source: https://www.scaleway.com/en/developers/api/account/project

Example of a successful response after creating a project. Note that UUIDs in the example are not real.

```json
{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "Dis-Iz-My-Projekt",
  "organization_id": "b12d5c3g-c612-5674-c1e9-92627f36c5b9",
  "created_at": "2023-03-02T22:00:28.888380Z",
  "updated_at": "2023-03-02T22:00:28.888380Z",
  "description": "This is the description of my project"
}
```
Tokens:
Raw