BareMetal API, REST: Server.Update

Written by

Updated at October 30, 2025

HTTP request
Path parameters
Body parameters
NetworkInterfaceSpec
PrivateSubnetNetworkInterface
PublicSubnetNetworkInterface
Response
UpdateServerMetadata
Status
Server
OsSettings
Storage
StoragePartition
Disk
Raid
NetworkInterface
PrivateSubnetNetworkInterface
PublicSubnetNetworkInterface

Updates the specified server.

HTTP request

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

Path parameters

Field

Description

serverId

string

Required field. ID of the server to update.

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

Body parameters

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "networkInterfaces": [
    {
      "id": "string",
      // Includes only one of the fields `privateSubnet`, `publicSubnet`
      "privateSubnet": {
        "privateSubnetId": "string"
      },
      "publicSubnet": {
        "publicSubnetId": "string"
      }
      // end of the list of possible fields
    }
  ],
  "labels": "object"
}

Field	Description
updateMask	string (field-mask) A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in `updateMask` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `updateMask` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
name	string Name of the server. The name must be unique within the folder.
description	string Description of the server.
networkInterfaces[]	NetworkInterfaceSpec Network configuration for the server. Specifies how the network interface is configured to interact with other servers on the internal network and on the internet. Currently up to 2 network interfaces are supported: required private network interface and optional public network interface.
labels	object (map<string, string>) Resource labels as `key:value` pairs.

NetworkInterfaceSpec

Field	Description
id	string ID of the network interface. Should not be specified when creating a server.
privateSubnet	PrivateSubnetNetworkInterface Private subnet. Includes only one of the fields `privateSubnet`, `publicSubnet`. Subnet that the network interface belongs to.
publicSubnet	PublicSubnetNetworkInterface Public subnet. Includes only one of the fields `privateSubnet`, `publicSubnet`. Subnet that the network interface belongs to.

PrivateSubnetNetworkInterface

Field

Description

privateSubnetId

string

ID of the private subnet.

PublicSubnetNetworkInterface

Field

Description

publicSubnetId

string

ID of the public subnet.

A new ephemeral public subnet will be created if not specified.

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`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "cloudId": "string",
    "folderId": "string",
    "name": "string",
    "description": "string",
    "zoneId": "string",
    "hardwarePoolId": "string",
    "status": "string",
    "osSettings": {
      "imageId": "string",
      "sshPublicKey": "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
        }
      ]
    },
    "networkInterfaces": [
      {
        "id": "string",
        "macAddress": "string",
        "ipAddress": "string",
        // Includes only one of the fields `privateSubnet`, `publicSubnet`
        "privateSubnet": {
          "privateSubnetId": "string"
        },
        "publicSubnet": {
          "publicSubnetId": "string"
        }
        // end of the list of possible fields
      }
    ],
    "configurationId": "string",
    "disks": [
      {
        "id": "string",
        "type": "string",
        "sizeGib": "string"
      }
    ],
    "createdAt": "string",
    "labels": "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	UpdateServerMetadata 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`, `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	Server 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.

UpdateServerMetadata

Field

Description

serverId

string

ID of the Server resource that is being updated.

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.

Server

A Server resource.

Field	Description
id	string ID of the server.
cloudId	string ID of the cloud that the server belongs to.
folderId	string ID of the folder that the server belongs to.
name	string Name of the server. The name is unique within the folder.
description	string Description of the server.
zoneId	string ID of the availability zone where the server is resides.
hardwarePoolId	string ID of the hardware pool that the server belongs to.
status	enum (Status) Status of the server. `STATUS_UNSPECIFIED`: Unspecified server status. `PROVISIONING`: Server is waiting for to be allocated from the hardware pool. `STOPPING`: Server is being stopped. `STOPPED`: Server has been stopped. `STARTING`: Server is being started. `RESTARTING`: Server is being restarted. `ERROR`: Server encountered a problem and cannot operate. `DELETING`: Server is being deleted. `REINSTALLING`: Server operating system is being reinstalled. `UPDATING`: Server is being updated. `QUARANTINED`: Server has been quarantined `RUNNING`: Server is running normaly
osSettings	OsSettings Operating system specific settings of the server. Optional, will be empty if the server is provisioned without an operating system.
networkInterfaces[]	NetworkInterface Array of network interfaces that are attached to the instance.
configurationId	string ID of the configuration that was used to create the server.
disks[]	Disk Array of disks that are attached to the server.
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).
labels	object (map<string, string>) Resource labels as `key:value` pairs.

OsSettings

Field	Description
imageId	string ID of the image that the server was created from.
sshPublicKey	string Public SSH key of the server.
storages[]	Storage List of storages.

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.

NetworkInterface

Field	Description
id	string ID of the network interface.
macAddress	string MAC address that is assigned to the network interface.
ipAddress	string IPv4 address that is assigned to the server for this network interface.
privateSubnet	PrivateSubnetNetworkInterface Private subnet. Includes only one of the fields `privateSubnet`, `publicSubnet`. Subnet that the network interface belongs to.
publicSubnet	PublicSubnetNetworkInterface Public subnet. Includes only one of the fields `privateSubnet`, `publicSubnet`. Subnet that the network interface belongs to.

PrivateSubnetNetworkInterface

Field

Description

privateSubnetId

string

ID of the private subnet.

PublicSubnetNetworkInterface

Field

Description

publicSubnetId

string

ID of the public subnet.

A new ephemeral public subnet will be created if not specified.

BareMetal API, REST: Server.Update

HTTP requestHTTP request

Path parametersPath parameters

Body parametersBody parameters

NetworkInterfaceSpecNetworkInterfaceSpec

PrivateSubnetNetworkInterfacePrivateSubnetNetworkInterface

PublicSubnetNetworkInterfacePublicSubnetNetworkInterface

ResponseResponse

UpdateServerMetadataUpdateServerMetadata

StatusStatus

ServerServer

OsSettingsOsSettings

StorageStorage

StoragePartitionStoragePartition

DiskDisk

RaidRaid

NetworkInterfaceNetworkInterface

PrivateSubnetNetworkInterfacePrivateSubnetNetworkInterface

PublicSubnetNetworkInterfacePublicSubnetNetworkInterface

Was the article helpful?

HTTP request

Path parameters

Body parameters

NetworkInterfaceSpec

PrivateSubnetNetworkInterface

PublicSubnetNetworkInterface

Response

UpdateServerMetadata

Status

Server

OsSettings

Storage

StoragePartition

Disk

Raid

NetworkInterface

PrivateSubnetNetworkInterface

PublicSubnetNetworkInterface