APIHub
Back to Explore

Bare Metal Solution API

Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center.

Analytics
OAuth
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
POST

/v2/{name}:evict

Skips lun's cooloff and deletes it now. Lun must be in cooloff state.

  • name (path, required) — Required. The name of the lun.
POST

/v2/{name}:enableInteractiveSerialConsole

Enable the interactive serial console feature on an instance.

  • name (path, required) — Required. Name of the resource.
POST

/v2/{instance}:detachLun

Detach LUN from Instance.

  • instance (path, required) — Required. Name of the instance.
GET

/v2/{location}/instanceProvisioningSettings:fetch

Get instance provisioning settings for a given project. This is hidden method used by UI only.

  • location (path, required) — Required. The parent project and location containing the ProvisioningSettings.
GET

/v2/{location}/networks:listNetworkUsage

List all Networks (and used IPs for each Network) in the vendor account associated with the specified project.

  • location (path, required) — Required. Parent value (project and location).
DELETE

/v2/{name}

Deletes a volume snapshot. Returns INVALID_ARGUMENT if called for a non-boot volume.

  • name (path, required) — Required. The name of the snapshot to delete.
GET

/v2/{name}

Returns the specified snapshot resource. Returns INVALID_ARGUMENT if called for a non-boot volume.

  • name (path, required) — Required. The name of the snapshot.
PATCH

/v2/{name}

Update details of a single storage volume.

  • name (path, required) — Output only. The resource name of this `Volume`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/volumes/{volume}`
  • updateMask (query) — The list of fields to update. The only currently supported fields are: 'labels'
GET

/v2/{name}/locations

Lists information about the supported locations for this service.

  • name (path, required) — The resource that owns the locations collection, if applicable.
  • filter (query) — A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
  • pageSize (query, limit) — The maximum number of results to return. If not set, the service selects a default.
  • pageToken (query) — A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
POST

/v2/{name}:disableInteractiveSerialConsole

Disable the interactive serial console feature on an instance.

  • name (path, required) — Required. Name of the resource.
POST

/v2/{name}:rename

RenameVolume sets a new name for a volume. Use with caution, previous names become immediately invalidated.

  • name (path, required) — Required. The `name` field is used to identify the volume. Format: projects/{project}/locations/{location}/volumes/{volume}
POST

/v2/{name}:reset

Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.

  • name (path, required) — Required. Name of the resource.
POST

/v2/{name}:start

Starts a server that was shutdown.

  • name (path, required) — Required. Name of the resource.
POST

/v2/{name}:stop

Stop a running server.

  • name (path, required) — Required. Name of the resource.
GET

/v2/{parent}/instances

List servers in a given project and location.

  • parent (path, required) — Required. Parent value for ListInstancesRequest.
  • filter (query) — List filter.
  • pageSize (query, limit) — Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  • pageToken (query) — A token identifying a page of results from the server.
POST

/v2/{parent}/instances

Create an Instance.

  • parent (path, required) — Required. The parent project and location.
GET

/v2/{parent}/luns

List storage volume luns for given storage volume.

  • parent (path, required) — Required. Parent value for ListLunsRequest.
  • pageSize (query, limit) — Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
  • pageToken (query) — A token identifying a page of results from the server.
GET

/v2/{parent}/networks

List network in a given project and location.

  • parent (path, required) — Required. Parent value for ListNetworksRequest.
  • filter (query) — List filter.
  • pageSize (query, limit) — Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
  • pageToken (query) — A token identifying a page of results from the server.
GET

/v2/{parent}/nfsShares

List NFS shares.

  • parent (path, required) — Required. Parent value for ListNfsSharesRequest.
  • filter (query) — List filter.
  • pageSize (query, limit) — Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
  • pageToken (query) — A token identifying a page of results from the server.
POST

/v2/{parent}/nfsShares

Create an NFS share.

  • parent (path, required) — Required. The parent project and location.
POST

/v2/{parent}/provisioningConfigs

Create new ProvisioningConfig.

  • parent (path, required) — Required. The parent project and location containing the ProvisioningConfig.
  • email (query) — Optional. Email provided to send a confirmation with provisioning config to.
POST

/v2/{parent}/provisioningConfigs:submit

Submit a provisiong configuration for a given project.

  • parent (path, required) — Required. The parent project and location containing the ProvisioningConfig.
GET

/v2/{parent}/provisioningQuotas

List the budget details to provision resources on a given project.

  • parent (path, required) — Required. Parent value for ListProvisioningQuotasRequest.
  • pageSize (query, limit) — Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default. Notice that page_size field is not supported and won't be respected in the API request for now, will be updated when pagination is supported.
  • pageToken (query) — A token identifying a page of results from the server.
GET

/v2/{parent}/snapshots

Retrieves the list of snapshots for the specified volume. Returns a response with an empty list of snapshots if called for a non-boot volume.

  • parent (path, required) — Required. Parent value for ListVolumesRequest.
  • pageSize (query, limit) — Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
  • pageToken (query) — A token identifying a page of results from the server.
POST

/v2/{parent}/snapshots

Takes a snapshot of a boot volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

  • parent (path, required) — Required. The volume to snapshot.
GET

/v2/{parent}/sshKeys

Lists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature.

  • parent (path, required) — Required. The parent containing the SSH keys. Currently, the only valid value for the location is "global".
  • pageSize (query, limit) — The maximum number of items to return.
  • pageToken (query) — The next_page_token value returned from a previous List request, if any.
POST

/v2/{parent}/sshKeys

Register a public SSH key in the specified project for use with the interactive serial console feature.

  • parent (path, required) — Required. The parent containing the SSH keys.
  • sshKeyId (query) — Required. The ID to use for the key, which will become the final component of the key's resource name. This value must match the regex: [a-zA-Z0-9@.\-_]{1,64}
GET

/v2/{parent}/volumes

List storage volumes in a given project and location.

  • parent (path, required) — Required. Parent value for ListVolumesRequest.
  • filter (query) — List filter.
  • pageSize (query, limit) — Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
  • pageToken (query) — A token identifying a page of results from the server.
POST

/v2/{volumeSnapshot}:restoreVolumeSnapshot

Uses the specified snapshot to restore its parent volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

  • volumeSnapshot (path, required) — Required. Name of the snapshot which will be used to restore its parent volume.
POST

/v2/{volume}:resize

Emergency Volume resize.

  • volume (path, required) — Required. Volume to resize.

30 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X POST \
  "https://baremetalsolution.googleapis.com/v2/{name}:evict"

baremetalsolution.googleapis.com · HTTPS only