{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/scaleway.instance.v1.Server",
  "title": "scaleway.instance.v1.Server",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Instance unique ID."
    },
    "name": {
      "type": "string",
      "description": "Instance name."
    },
    "organization": {
      "type": "string",
      "description": "Instance Organization ID."
    },
    "project": {
      "type": "string",
      "description": "Instance Project ID."
    },
    "allowed_actions": {
      "type": "array",
      "description": "List of allowed actions on the Instance.",
      "items": {
        "$ref": "#/components/schemas/scaleway.instance.v1.Server.Action"
      }
    },
    "tags": {
      "type": "array",
      "description": "Tags associated with the Instance.",
      "items": {
        "type": "string"
      }
    },
    "commercial_type": {
      "type": "string",
      "description": "Instance commercial type (eg. GP1-M)."
    },
    "creation_date": {
      "type": "string",
      "description": "Instance creation date. (RFC 3339 format)",
      "format": "date-time",
      "example": "2022-03-22T12:34:56.123456Z",
      "nullable": true
    },
    "dynamic_ip_required": {
      "type": "boolean",
      "description": "True if a dynamic IPv4 is required."
    },
    "routed_ip_enabled": {
      "type": "boolean",
      "description": "True to configure the instance so it uses the routed IP mode. Use of `routed_ip_enabled` as `False` is deprecated.",
      "deprecated": true
    },
    "enable_ipv6": {
      "type": "boolean",
      "description": "True if IPv6 is enabled (deprecated and always `False` when `routed_ip_enabled` is `True`).",
      "deprecated": true
    },
    "hostname": {
      "type": "string",
      "description": "Instance host name."
    },
    "image": {
      "type": "object",
      "description": "Information about the Instance image.",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "arch": {
          "$ref": "#/components/schemas/scaleway.instance.v1.Arch"
        },
        "creation_date": {
          "type": "string",
          "description": "(RFC 3339 format)",
          "format": "date-time",
          "example": "2022-03-22T12:34:56.123456Z",
          "nullable": true
        },
        "modification_date": {
          "type": "string",
          "description": "(RFC 3339 format)",
          "format": "date-time",
          "example": "2022-03-22T12:34:56.123456Z",
          "nullable": true
        },
        "default_bootscript": {
          "deprecated": true,
          "$ref": "#/components/schemas/scaleway.instance.v1.Bootscript"
        },
        "extra_volumes": {
          "type": "object",
          "properties": {
            "<extra_volumeKey>": {
              "$ref": "#/components/schemas/scaleway.instance.v1.Volume"
            }
          },
          "additionalProperties": true
        },
        "from_server": {
          "type": "string"
        },
        "organization": {
          "type": "string"
        },
        "public": {
          "type": "boolean"
        },
        "root_volume": {
          "$ref": "#/components/schemas/scaleway.instance.v1.VolumeSummary"
        },
        "state": {
          "$ref": "#/components/schemas/scaleway.instance.v1.Image.State"
        },
        "project": {
          "type": "string"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "zone": {
          "type": "string",
          "description": "The zone you want to target"
        }
      },
      "x-properties-order": [
        "id",
        "name",
        "arch",
        "creation_date",
        "modification_date",
        "default_bootscript",
        "extra_volumes",
        "from_server",
        "organization",
        "public",
        "root_volume",
        "state",
        "project",
        "tags",
        "zone"
      ]
    },
    "protected": {
      "type": "boolean",
      "description": "Defines whether the Instance protection option is activated."
    },
    "private_ip": {
      "type": "string",
      "description": "Private IP address of the Instance (deprecated and always `null` when `routed_ip_enabled` is `True`).",
      "nullable": true
    },
    "public_ip": {
      "type": "object",
      "description": "Information about the public IP (deprecated in favor of `public_ips`).",
      "deprecated": true,
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique ID of the IP address."
        },
        "address": {
          "type": "string",
          "description": "Instance's public IP-Address. (IP address)",
          "example": "1.2.3.4"
        },
        "gateway": {
          "type": "string",
          "description": "Gateway's IP address. (IP address)",
          "example": "1.2.3.4"
        },
        "netmask": {
          "type": "string",
          "description": "CIDR netmask."
        },
        "family": {
          "type": "string",
          "description": "IP address family (inet or inet6).",
          "enum": [
            "inet",
            "inet6"
          ],
          "default": "inet"
        },
        "dynamic": {
          "type": "boolean",
          "description": "True if the IP address is dynamic."
        },
        "provisioning_mode": {
          "type": "string",
          "description": "Information about this address provisioning mode.",
          "enum": [
            "manual",
            "dhcp",
            "slaac"
          ],
          "default": "manual"
        },
        "tags": {
          "type": "array",
          "description": "Tags associated with the IP.",
          "items": {
            "type": "string"
          }
        },
        "ipam_id": {
          "type": "string",
          "description": "The ip_id of an IPAM ip if the ip is created from IPAM, null if not. (UUID format)",
          "example": "6170692e-7363-616c-6577-61792e636f6d"
        },
        "state": {
          "type": "string",
          "description": "IP address state.",
          "enum": [
            "unknown_state",
            "detached",
            "attached",
            "pending",
            "error"
          ],
          "default": "unknown_state"
        }
      },
      "x-properties-order": [
        "id",
        "address",
        "gateway",
        "netmask",
        "family",
        "dynamic",
        "provisioning_mode",
        "tags",
        "ipam_id",
        "state"
      ]
    },
    "public_ips": {
      "type": "array",
      "description": "Information about all the public IPs attached to the server.",
      "items": {
        "$ref": "#/components/schemas/scaleway.instance.v1.Server.Ip"
      }
    },
    "mac_address": {
      "type": "string",
      "description": "The server's MAC address."
    },
    "modification_date": {
      "type": "string",
      "description": "Instance modification date. (RFC 3339 format)",
      "format": "date-time",
      "example": "2022-03-22T12:34:56.123456Z",
      "nullable": true
    },
    "state": {
      "type": "string",
      "description": "Instance state.",
      "enum": [
        "running",
        "stopped",
        "stopped in place",
        "starting",
        "stopping",
        "locked"
      ],
      "default": "running"
    },
    "location": {
      "type": "object",
      "description": "Instance location.",
      "properties": {
        "cluster_id": {
          "type": "string"
        },
        "hypervisor_id": {
          "type": "string"
        },
        "node_id": {
          "type": "string"
        },
        "platform_id": {
          "type": "string"
        },
        "zone_id": {
          "type": "string"
        }
      },
      "x-properties-order": [
        "cluster_id",
        "hypervisor_id",
        "node_id",
        "platform_id",
        "zone_id"
      ]
    },
    "ipv6": {
      "type": "object",
      "description": "Instance IPv6 address (deprecated when `routed_ip_enabled` is `True`).",
      "deprecated": true,
      "properties": {
        "address": {
          "type": "string",
          "description": "Instance IPv6 IP-Address. (IPv6 address)",
          "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
        },
        "gateway": {
          "type": "string",
          "description": "IPv6 IP-addresses gateway. (IPv6 address)",
          "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
        },
        "netmask": {
          "type": "string",
          "description": "IPv6 IP-addresses CIDR netmask."
        }
      },
      "x-properties-order": [
        "address",
        "gateway",
        "netmask"
      ]
    },
    "boot_type": {
      "type": "string",
      "description": "Instance boot type.",
      "enum": [
        "local",
        "bootscript",
        "rescue"
      ],
      "default": "local"
    },
    "volumes": {
      "type": "object",
      "description": "Instance volumes.",
      "properties": {
        "<volumeKey>": {
          "type": "object",
          "description": "Instance volumes.",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "export_uri": {
              "type": "string",
              "deprecated": true
            },
            "organization": {
              "type": "string"
            },
            "server": {
              "$ref": "#/components/schemas/scaleway.instance.v1.ServerSummary"
            },
            "size": {
              "type": "integer",
              "description": "(in bytes)",
              "format": "uint64"
            },
            "volume_type": {
              "$ref": "#/components/schemas/scaleway.instance.v1.VolumeServer.VolumeType"
            },
            "creation_date": {
              "type": "string",
              "description": "(RFC 3339 format)",
              "format": "date-time",
              "example": "2022-03-22T12:34:56.123456Z",
              "nullable": true
            },
            "modification_date": {
              "type": "string",
              "description": "(RFC 3339 format)",
              "format": "date-time",
              "example": "2022-03-22T12:34:56.123456Z",
              "nullable": true
            },
            "state": {
              "$ref": "#/components/schemas/scaleway.instance.v1.VolumeServer.State"
            },
            "project": {
              "type": "string"
            },
            "boot": {
              "type": "boolean"
            },
            "zone": {
              "type": "string",
              "description": "The zone you want to target"
            }
          },
          "x-properties-order": [
            "id",
            "name",
            "export_uri",
            "organization",
            "server",
            "size",
            "volume_type",
            "creation_date",
            "modification_date",
            "state",
            "project",
            "boot",
            "zone"
          ]
        }
      },
      "additionalProperties": true
    },
    "security_group": {
      "type": "object",
      "description": "Instance security group.",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "x-properties-order": [
        "id",
        "name"
      ]
    },
    "maintenances": {
      "type": "array",
      "description": "Instance planned maintenance.",
      "items": {
        "$ref": "#/components/schemas/scaleway.instance.v1.Server.Maintenance"
      }
    },
    "state_detail": {
      "type": "string",
      "description": "Detailed information about the Instance state."
    },
    "arch": {
      "type": "string",
      "description": "Instance architecture.",
      "enum": [
        "unknown_arch",
        "x86_64",
        "arm",
        "arm64"
      ],
      "default": "unknown_arch"
    },
    "placement_group": {
      "type": "object",
      "description": "Instance placement group.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Placement group unique ID."
        },
        "name": {
          "type": "string",
          "description": "Placement group name."
        },
        "organization": {
          "type": "string",
          "description": "Placement group Organization ID."
        },
        "project": {
          "type": "string",
          "description": "Placement group Project ID."
        },
        "tags": {
          "type": "array",
          "description": "Placement group tags.",
          "items": {
            "type": "string"
          }
        },
        "policy_mode": {
          "type": "string",
          "description": "Select the failure mode when the placement cannot be respected, either optional or enforced.",
          "enum": [
            "optional",
            "enforced"
          ],
          "default": "optional"
        },
        "policy_type": {
          "type": "string",
          "description": "Select the behavior of the placement group, either low_latency (group) or max_availability (spread).",
          "enum": [
            "max_availability",
            "low_latency"
          ],
          "default": "max_availability"
        },
        "policy_respected": {
          "type": "boolean",
          "description": "True if the policy is respected, false otherwise.\nIn the server endpoints the value is always false as it is deprecated.\nIn the placement group endpoints the value is correct."
        },
        "zone": {
          "type": "string",
          "description": "Zone in which the placement group is located."
        }
      },
      "x-properties-order": [
        "id",
        "name",
        "organization",
        "project",
        "tags",
        "policy_mode",
        "policy_type",
        "policy_respected",
        "zone"
      ]
    },
    "private_nics": {
      "type": "array",
      "description": "Instance private NICs.",
      "items": {
        "$ref": "#/components/schemas/scaleway.instance.v1.PrivateNIC"
      }
    },
    "zone": {
      "type": "string",
      "description": "Zone in which the Instance is located."
    },
    "admin_password_encryption_ssh_key_id": {
      "type": "string",
      "description": "UUID of the SSH RSA key that will be used to encrypt the initial admin password for OS requiring it. Mandatory for Windows OS.\nThe public_key value of this key is used to encrypt the admin password. When set to an empty string, reset this value and admin_password_encrypted_value to an empty string so a new password may be generated.",
      "nullable": true
    },
    "admin_password_encrypted_value": {
      "type": "string",
      "description": "A base64 encoded string containing the admin password encrypted with the public key pointed to by admin_password_encryption_ssh_key_id.\nThis value is reset when admin_password_encryption_ssh_key_id is set to an empty string.",
      "nullable": true
    },
    "filesystems": {
      "type": "array",
      "description": "List of attached filesystems.",
      "items": {
        "$ref": "#/components/schemas/scaleway.instance.v1.Server.Filesystem"
      }
    },
    "end_of_service": {
      "type": "boolean",
      "description": "True if the Instance type has reached end of service."
    },
    "dns": {
      "type": "string",
      "description": "Public DNS of the server.",
      "nullable": true
    }
  },
  "x-properties-order": [
    "id",
    "name",
    "organization",
    "project",
    "allowed_actions",
    "tags",
    "commercial_type",
    "creation_date",
    "dynamic_ip_required",
    "routed_ip_enabled",
    "enable_ipv6",
    "hostname",
    "image",
    "protected",
    "private_ip",
    "public_ip",
    "public_ips",
    "mac_address",
    "modification_date",
    "state",
    "location",
    "ipv6",
    "boot_type",
    "volumes",
    "security_group",
    "maintenances",
    "state_detail",
    "arch",
    "placement_group",
    "private_nics",
    "zone",
    "admin_password_encryption_ssh_key_id",
    "admin_password_encrypted_value",
    "filesystems",
    "end_of_service",
    "dns"
  ]
}