BareMetal API, REST: Server.Reinstall

Written by

Updated at October 30, 2025

HTTP request
Path parameters
Body parameters
OsSettingsSpec
Storage
StoragePartition
Disk
Raid
LockboxSecret
Response
ReinstallServerMetadata
Status

Reinstalls the specified server.

HTTP request

POST https://baremetal.api.cloud.yandex.net/baremetal/v1alpha/servers/{serverId}:reinstall

Path parameters

Field

Description

serverId

string

Required field. ID of the server to reinstall.

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

Body parameters

{
  "osSettingsSpec": {
    "imageId": "string",
    "storages": [
      {
        "partitions": [
          {
            "type": "string",
            "sizeGib": "string",
            "mountPoint": "string"
          }
        ],
        // Includes only one of the fields `disk`, `raid`
        "disk": {
          "id": "string",
          "type": "string",
          "sizeGib": "string"
        },
        "raid": {
          "type": "string",
          "disks": [
            {
              "id": "string",
              "type": "string",
              "sizeGib": "string"
            }
          ]
        }
        // end of the list of possible fields
      }
    ],
    // Includes only one of the fields `sshPublicKey`, `userSshId`
    "sshPublicKey": "string",
    "userSshId": "string",
    // end of the list of possible fields
    // Includes only one of the fields `passwordPlainText`, `passwordLockboxSecret`
    "passwordPlainText": "string",
    "passwordLockboxSecret": {
      "secretId": "string",
      "versionId": "string",
      "key": "string"
    }
    // end of the list of possible fields
  }
}

Field

Description

osSettingsSpec

OsSettingsSpec

Operating system specific settings for provisioning the server.

OsSettingsSpec

Field	Description
imageId	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.
sshPublicKey	string Public SSH key for the server. Includes only one of the fields `sshPublicKey`, `userSshId`. Root user SSH key.
userSshId	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 `sshPublicKey`, `userSshId`. Root user SSH key.
passwordPlainText	string Raw password. Includes only one of the fields `passwordPlainText`, `passwordLockboxSecret`. Password for the server.
passwordLockboxSecret	LockboxSecret Reference to the Lockbox secret used to obtain the password. Includes only one of the fields `passwordPlainText`, `passwordLockboxSecret`. 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.
sizeGib	string (int64) Size of the storage partition in gibibytes (2^30 bytes).
mountPoint	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 (magnetic storage). `SSD`: Solid state drive with SATA/SAS interface. `NVME`: Solid state drive with NVMe interface.
sizeGib	string (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
secretId	string Required field. The unique identifier for the lockbox secret that contains the user password.
versionId	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.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "serverId": "string"
  },
  // Includes only one of the fields `error`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  }
  // 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.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean 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	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`. 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

serverId

string

ID of the Server resource that is being reinstalled.

Status

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

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

BareMetal API, REST: Server.Reinstall

HTTP requestHTTP request

Path parametersPath parameters

Body parametersBody parameters

OsSettingsSpecOsSettingsSpec

StorageStorage

StoragePartitionStoragePartition

DiskDisk

RaidRaid

LockboxSecretLockboxSecret

ResponseResponse

ReinstallServerMetadataReinstallServerMetadata

StatusStatus

Was the article helpful?

HTTP request

Path parameters

Body parameters

OsSettingsSpec

Storage

StoragePartition

Disk

Raid

LockboxSecret

Response

ReinstallServerMetadata

Status