Google

Bare Metal Solution API

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

Developer tools#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

Endpoints 33

projects.locations.volumes.snapshots

  • GETReturns the specified snapshot resource/v2/:nameReturns the specified snapshot resource. Returns INVALID_ARGUMENT if called for a non-boot volume.
  • DELETEDeletes a volume snapshot/v2/:nameDeletes a volume snapshot. Returns INVALID_ARGUMENT if called for a non-boot volume.
  • GETRetrieves the list of snapshots for the specified volume/v2/:parent/snapshots?pageSize=0&pageToken=stringRetrieves the list of snapshots for the specified volume. Returns a response with an empty list of snapshots if called for a non-boot volume.
  • POSTTakes a snapshot of a boot volume/v2/:parent/snapshotsTakes a snapshot of a boot volume. Returns INVALID_ARGUMENT if called for a non-boot volume.
  • POSTUses the specified snapshot to restore its parent volume/v2/:volumeSnapshot:restoreVolumeSnapshotUses the specified snapshot to restore its parent volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

projects.locations.volumes

  • PATCHUpdate details of a single storage volume./v2/:name?updateMask=stringUpdate details of a single storage volume.
  • POSTRenameVolume sets a new name for a volume/v2/:name:renameRenameVolume sets a new name for a volume. Use with caution, previous names become immediately invalidated.
  • GETList storage volumes in a given project and location./v2/:parent/volumes?filter=string&pageSize=0&pageToken=stringList storage volumes in a given project and location.
  • POSTEmergency Volume resize./v2/:volume:resizeEmergency Volume resize.

projects.locations

  • GETLists information about the supported locations for this service/v2/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…

projects.locations.instances

  • POSTDetach LUN from Instance./v2/:instance:detachLunDetach LUN from Instance.
  • POSTPerform disable hyperthreading operation on a single server./v2/:name:disableHyperthreadingPerform disable hyperthreading operation on a single server.
  • POSTDisable the interactive serial console feature on an instance./v2/:name:disableInteractiveSerialConsoleDisable the interactive serial console feature on an instance.
  • POSTPerform enable hyperthreading operation on a single server./v2/:name:enableHyperthreadingPerform enable hyperthreading operation on a single server.
  • POSTEnable the interactive serial console feature on an instance./v2/:name:enableInteractiveSerialConsoleEnable the interactive serial console feature on an instance.
  • GETList servers in a given project and location./v2/:parent/instances?filter=string&pageSize=0&pageToken=stringList servers in a given project and location.
  • GETLoad auth info for a server./v2/:name:loadAuthInfoLoad auth info for a server.
  • POSTPerform reimage operation on a single server./v2/:name:reimagePerform reimage operation on a single server.
  • POSTPerform an ungraceful, hard reset on a server/v2/:name:resetPerform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.
  • POSTStarts a server that was shutdown./v2/:name:startStarts a server that was shutdown.
  • POSTStop a running server./v2/:name:stopStop a running server.

projects.locations.networks

  • GETList network in a given project and location./v2/:parent/networks?filter=string&pageSize=0&pageToken=stringList network in a given project and location.
  • GETList all Networks (and used IPs for each Network) in the vendor account associated with the specified project./v2/:location/networks:listNetworkUsageList all Networks (and used IPs for each Network) in the vendor account associated with the specified project.

projects.locations.nfsShares

  • GETList NFS shares./v2/:parent/nfsShares?filter=string&pageSize=0&pageToken=stringList NFS shares.
  • POSTCreate an NFS share./v2/:parent/nfsSharesCreate an NFS share.

projects.locations.osImages

  • GETRetrieves the list of OS images which are currently approved./v2/:parent/osImages?pageSize=0&pageToken=stringRetrieves the list of OS images which are currently approved.

projects.locations.provisioningConfigs

  • POSTCreate new ProvisioningConfig./v2/:parent/provisioningConfigs?email=stringCreate new ProvisioningConfig.
  • POSTSubmit a provisioning configuration for a given project./v2/:parent/provisioningConfigs:submitSubmit a provisioning configuration for a given project.

projects.locations.provisioningQuotas

  • GETList the budget details to provision resources on a given project./v2/:parent/provisioningQuotas?pageSize=0&pageToken=stringList the budget details to provision resources on a given project.

projects.locations.sshKeys

  • GETLists the public SSH keys registered for the specified project/v2/:parent/sshKeys?pageSize=0&pageToken=stringLists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature.
  • POSTRegister a public SSH key in the specified project for use with the interactive serial console feature./v2/:parent/sshKeys?sshKeyId=stringRegister a public SSH key in the specified project for use with the interactive serial console feature.

projects.locations.volumes.luns

  • POSTSkips lun's cooloff and deletes it now/v2/:name:evictSkips lun's cooloff and deletes it now. Lun must be in cooloff state.
  • GETList storage volume luns for given storage volume./v2/:parent/luns?pageSize=0&pageToken=stringList storage volume luns for given storage volume.

API details

Base URL
https://baremetalsolution.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
33 operations on 28 pathsPOST 18GET 13PATCH 1DELETE 1
Main resources
projects.locations.instances 11projects.locations.volumes.snapshots 5projects.locations.volumes 4projects.locations.networks 2projects.locations.nfsShares 2projects.locations.provisioningConfigs 2projects.locations.sshKeys 2projects.locations.volumes.luns 2projects.locations 1projects.locations.osImages 1
Response formats
application/json
Description format
Google API Discovery, API version v2

How to test the Bare Metal Solution API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Bare Metal Solution API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Returns the specified snapshot resource” (GET /v2/:name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Bare Metal Solution API?

Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center. It is listed under Developer tools and has 33 endpoints.

Who publishes the Bare Metal Solution API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Bare Metal Solution API?

Requests go to https://baremetalsolution.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Bare Metal Solution API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.

How many endpoints does the Bare Metal Solution API have?

33 operations on 28 paths (18 POST, 13 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.instances, projects.locations.volumes.snapshots, projects.locations.volumes, projects.locations.networks.

Is forking the Bare Metal Solution API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.