Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

BareMetal API, gRPC: ServerService.Reinstall

Written by
Updated at March 28, 2025

Reinstalls the specified server.

gRPC request

rpc Reinstall (ReinstallServerRequest) returns (operation.Operation)

ReinstallServerRequest

{
  "server_id": "string",
  "os_settings_spec": {
    "image_id": "string",
    "storages": [
      {
        "partitions": [
          {
            "type": "StoragePartitionType",
            "size_gib": "int64",
            "mount_point": "string"
          }
        ],
        // Includes only one of the fields `disk`, `raid`
        "disk": {
          "id": "string",
          "type": "DiskDriveType",
          "size_gib": "int64"
        },
        "raid": {
          "type": "RaidType",
          "disks": [
            {
              "id": "string",
              "type": "DiskDriveType",
              "size_gib": "int64"
            }
          ]
        }
        // end of the list of possible fields
      }
    ],
    // Includes only one of the fields `ssh_public_key`, `user_ssh_id`
    "ssh_public_key": "string",
    "user_ssh_id": "string",
    // end of the list of possible fields
    // Includes only one of the fields `password_plain_text`, `password_lockbox_secret`
    "password_plain_text": "string",
    "password_lockbox_secret": {
      "secret_id": "string",
      "version_id": "string",
      "key": "string"
    }
    // end of the list of possible fields
  }
}

Field

Description

server_id

string

ID of the server to reinstall.

To get the server ID, use a ServerService.List request.

os_settings_spec

OsSettingsSpec

Operating system specific settings for provisioning the server.

OsSettingsSpec

Field

Description

image_id

string

ID of the image that the server was created from.

storages[]

Storage

List of storages to be created on the server. If not specified, the default value based on the
selected configuration will be used as the field value.

ssh_public_key

string

Public SSH key for the server.

Includes only one of the fields ssh_public_key, user_ssh_id.

Root user SSH key.

user_ssh_id

string

ID of the user SSH key to use for the server.

To get the user SSH key ID, use a yandex.cloud.organizationmanager.v1.UserSshKeyService.List request.

Includes only one of the fields ssh_public_key, user_ssh_id.

Root user SSH key.

password_plain_text

string

Raw password.

Includes only one of the fields password_plain_text, password_lockbox_secret.

Password for the server.

password_lockbox_secret

LockboxSecret

Reference to the Lockbox secret used to obtain the password.

Includes only one of the fields password_plain_text, password_lockbox_secret.

Password for the server.

Storage

Storage, a OS-level storage entity used for creating partitions. For example, this could
represent a plain disk or a software RAID of disks.

Field

Description

partitions[]

StoragePartition

Array of partitions created on the storage.

disk

Disk

Disk storage.

Includes only one of the fields disk, raid.

Storage type.

raid

Raid

RAID storage.

Includes only one of the fields disk, raid.

Storage type.

StoragePartition

Field

Description

type

enum StoragePartitionType

Partition type.

  • STORAGE_PARTITION_TYPE_UNSPECIFIED: Unspecified storage partition type.
  • EXT4: ext4 file system partition type.
  • SWAP: Swap partition type.
  • EXT3: ext3 file system partition type.
  • XFS: XFS file system partition type.

size_gib

int64

Size of the storage partition in gibibytes (2^30 bytes).

mount_point

string

Storage mount point.

Disk

Disk.

Field

Description

id

string

ID of the disk.

type

enum DiskDriveType

Type of the disk drive.

  • DISK_DRIVE_TYPE_UNSPECIFIED: Unspecified disk drive type.
  • HDD: Hard disk drive.
  • SSD: Solid state drive.

size_gib

int64

Size of the disk in gibibytes (2^30 bytes).

Raid

RAID storage.

Field

Description

type

enum RaidType

RAID type.

  • RAID_TYPE_UNSPECIFIED: Unspecified RAID configuration.
  • RAID0: RAID0 configuration.
  • RAID1: RAID1 configuration.
  • RAID10: RAID10 configuration.

disks[]

Disk

Array of disks in the RAID configuration.

LockboxSecret

Field

Description

secret_id

string

Required field. The unique identifier for the lockbox secret that contains the user password.

version_id

string

The unique identifier for the lockbox version.
If omitted, the current version of the secret will be used.

key

string

Required field. The key used to access a specific secret entry.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "server_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Empty"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

ReinstallServerMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

google.protobuf.Empty

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

ReinstallServerMetadata

Field

Description

server_id

string

ID of the Server resource that is being reinstalled.
Previous
Reboot
Next
StartProlongation