Partitioning-schemas

Download schema

You have the possibility to customize server partitioning schema on some offers/os.

Get default partitioning schema

GET

https://api.scaleway.com

/baremetal/v1/zones/{zone}/partitioning-schemas/default

Get the default partitioning schema for the given offer ID and OS ID.

Get default partitioning schema › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

pl-waw-2

pl-waw-3

Get default partitioning schema › query Parameters

offer_id

string · required

ID of the offer.

os_id

string · required

ID of the OS.

Get default partitioning schema › Responses

200

scaleway.baremetal.v1.Schema

scaleway.baremetal.v1.Schema.Disk[]

scaleway.baremetal.v1.Schema.RAID[]

scaleway.baremetal.v1.Schema.Filesystem[]

scaleway.baremetal.v1.Schema.ZFS

GET/baremetal/v1/zones/{zone}/partitioning-schemas/default

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/baremetal/v1/zones/{zone}/partitioning-schemas/default?offer_id=string&os_id=string"

Example Responses

{
  "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"
        ]
      }
    ]
  }
}

json

application/json

Validate client partitioning schema

POST

https://api.scaleway.com

/baremetal/v1/zones/{zone}/partitioning-schemas/validate

Validate the incoming partitioning schema from a user before installing the server. Return default ErrorCode if invalid.

Validate client partitioning schema › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

pl-waw-2

pl-waw-3

Validate client partitioning schema › Request Body

object

Partitioning schema.

offer_id

string

Offer ID of the server.

os_id

string

OS ID.

Validate client partitioning schema › Responses

No data returned

POST/baremetal/v1/zones/{zone}/partitioning-schemas/validate

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"offer_id":"string","os_id":"string"}' \
  "https://api.scaleway.com/baremetal/v1/zones/{zone}/partitioning-schemas/validate"

Example Request Body

{
  "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"
          ]
        }
      ]
    }
  },
  "offer_id": "offer_id",
  "os_id": "os_id"
}

json

Example Responses

No example specified for this content type

Elastic Metal API

Partitioning-schemas

Download schema

You have the possibility to customize server partitioning schema on some offers/os.

Get default partitioning schema

GET

https://api.scaleway.com

/baremetal/v1/zones/{zone}/partitioning-schemas/default

Get the default partitioning schema for the given offer ID and OS ID.

Get default partitioning schema › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

pl-waw-2

pl-waw-3

Get default partitioning schema › query Parameters

offer_id

string · required

ID of the offer.

os_id

string · required

ID of the OS.

Get default partitioning schema › Responses

200

scaleway.baremetal.v1.Schema

scaleway.baremetal.v1.Schema.Disk[]

scaleway.baremetal.v1.Schema.RAID[]

scaleway.baremetal.v1.Schema.Filesystem[]

scaleway.baremetal.v1.Schema.ZFS

GET/baremetal/v1/zones/{zone}/partitioning-schemas/default

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/baremetal/v1/zones/{zone}/partitioning-schemas/default?offer_id=string&os_id=string"

Example Responses

{
  "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"
        ]
      }
    ]
  }
}

json

application/json

Validate client partitioning schema

POST

https://api.scaleway.com

/baremetal/v1/zones/{zone}/partitioning-schemas/validate

Validate the incoming partitioning schema from a user before installing the server. Return default ErrorCode if invalid.

Validate client partitioning schema › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

nl-ams-1

nl-ams-2

pl-waw-2

pl-waw-3

Validate client partitioning schema › Request Body

object

Partitioning schema.

offer_id

string

Offer ID of the server.

os_id

string

OS ID.

Validate client partitioning schema › Responses

No data returned

POST/baremetal/v1/zones/{zone}/partitioning-schemas/validate

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"offer_id":"string","os_id":"string"}' \
  "https://api.scaleway.com/baremetal/v1/zones/{zone}/partitioning-schemas/validate"

Example Request Body

{
  "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"
          ]
        }
      ]
    }
  },
  "offer_id": "offer_id",
  "os_id": "os_id"
}

json

Example Responses

No example specified for this content type