Scaleway · JSON Structure

Scaleway Instance Structure

Structure of a Scaleway virtual machine instance resource

Type: Properties: 0
AICloud ComputingContainersDatabaseEuropean CloudInfrastructureKubernetesServerlessStorage

Scaleway Instance is a JSON Structure definition published by Scaleway.

Meta-schema:

JSON Structure

Raw ↑
{
  "name": "Scaleway Instance",
  "description": "Structure of a Scaleway virtual machine instance resource",
  "fields": [
    {
      "name": "id",
      "type": "string",
      "format": "uuid",
      "description": "Unique identifier",
      "required": true
    },
    {
      "name": "name",
      "type": "string",
      "description": "Display name",
      "required": true
    },
    {
      "name": "state",
      "type": "enum",
      "values": ["running", "stopped", "stopped in place", "starting", "stopping", "locked"],
      "description": "Current operational state",
      "required": true
    },
    {
      "name": "commercial_type",
      "type": "string",
      "description": "Instance type (GP1-S, DEV1-S, etc.)",
      "required": true
    },
    {
      "name": "image",
      "type": "object",
      "description": "Operating system image",
      "fields": [
        {"name": "id", "type": "string"},
        {"name": "name", "type": "string"},
        {"name": "arch", "type": "enum", "values": ["x86_64", "arm64"]}
      ]
    },
    {
      "name": "volumes",
      "type": "map",
      "description": "Storage volumes (keyed by slot index)",
      "valueType": {
        "name": "Volume",
        "fields": [
          {"name": "id", "type": "string"},
          {"name": "name", "type": "string"},
          {"name": "size", "type": "integer", "description": "Size in bytes"},
          {"name": "volume_type", "type": "enum", "values": ["l_ssd", "b_ssd", "sbs_volume"]}
        ]
      }
    },
    {
      "name": "public_ip",
      "type": "object",
      "description": "Public IP address",
      "fields": [
        {"name": "address", "type": "string", "format": "ipv4"},
        {"name": "dynamic", "type": "boolean"}
      ]
    },
    {
      "name": "private_ip",
      "type": "string",
      "format": "ipv4",
      "description": "Private network IP address"
    },
    {
      "name": "zone",
      "type": "string",
      "description": "Availability zone (e.g., fr-par-1)",
      "required": true
    },
    {
      "name": "organization",
      "type": "string",
      "format": "uuid",
      "description": "Owner organization ID"
    },
    {
      "name": "project",
      "type": "string",
      "format": "uuid",
      "description": "Project ID"
    },
    {
      "name": "tags",
      "type": "array",
      "itemType": "string",
      "description": "User-defined labels"
    },
    {
      "name": "security_group",
      "type": "object",
      "description": "Applied security group",
      "fields": [
        {"name": "id", "type": "string"},
        {"name": "name", "type": "string"}
      ]
    },
    {
      "name": "enable_ipv6",
      "type": "boolean",
      "description": "IPv6 enabled flag"
    },
    {
      "name": "creation_date",
      "type": "string",
      "format": "date-time"
    },
    {
      "name": "modification_date",
      "type": "string",
      "format": "date-time"
    }
  ]
}