Skip to content

Bare Metal Solution API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

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

Bare Metal Solution API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 30 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://baremetalsolution.googleapis.com/
Version
v2
Endpoints
30
Spec updated
2023-03-20

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://baremetalsolution.googleapis.com/v2/LOCATION/instanceProvisioningSettings:fetch" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://baremetalsolution.googleapis.com/v2/LOCATION/instanceProvisioningSettings:fetch", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://baremetalsolution.googleapis.com/v2/LOCATION/instanceProvisioningSettings:fetch",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/v2/{instance}:detachLunDetach LUN from Instance.
GET/v2/{location}/instanceProvisioningSettings:fetchGet instance provisioning settings for a given project. This is hidden method used by UI only.
GET/v2/{location}/networks:listNetworkUsageList all Networks (and used IPs for each Network) in the vendor account associated with the specified project.
GET/v2/{name}Returns the specified snapshot resource. Returns INVALID_ARGUMENT if called for a non-boot volume.
PATCH/v2/{name}Update details of a single storage volume.
DELETE/v2/{name}Deletes a volume snapshot. Returns INVALID_ARGUMENT if called for a non-boot volume.
GET/v2/{name}/locationsLists information about the supported locations for this service.
POST/v2/{name}:disableInteractiveSerialConsoleDisable the interactive serial console feature on an instance.
POST/v2/{name}:enableInteractiveSerialConsoleEnable the interactive serial console feature on an instance.
POST/v2/{name}:evictSkips lun's cooloff and deletes it now. Lun must be in cooloff state.
POST/v2/{name}:renameRenameVolume sets a new name for a volume. Use with caution, previous names become immediately invalidated.
POST/v2/{name}:resetPerform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.
POST/v2/{name}:startStarts a server that was shutdown.
POST/v2/{name}:stopStop a running server.
GET/v2/{parent}/instancesList servers in a given project and location.
POST/v2/{parent}/instancesCreate an Instance.
GET/v2/{parent}/lunsList storage volume luns for given storage volume.
GET/v2/{parent}/networksList network in a given project and location.
GET/v2/{parent}/nfsSharesList NFS shares.
POST/v2/{parent}/nfsSharesCreate an NFS share.
POST/v2/{parent}/provisioningConfigsCreate new ProvisioningConfig.
POST/v2/{parent}/provisioningConfigs:submitSubmit a provisiong configuration for a given project.
GET/v2/{parent}/provisioningQuotasList the budget details to provision resources on a given project.
GET/v2/{parent}/snapshotsRetrieves the list of snapshots for the specified volume. Returns a response with an empty list of snapshots if called for a non-boot volume.
POST/v2/{parent}/snapshotsTakes a snapshot of a boot volume. Returns INVALID_ARGUMENT if called for a non-boot volume.
GET/v2/{parent}/sshKeysLists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature.
POST/v2/{parent}/sshKeysRegister a public SSH key in the specified project for use with the interactive serial console feature.
GET/v2/{parent}/volumesList storage volumes in a given project and location.
POST/v2/{volumeSnapshot}:restoreVolumeSnapshotUses the specified snapshot to restore its parent volume. Returns INVALID_ARGUMENT if called for a non-boot volume.
POST/v2/{volume}:resizeEmergency Volume resize.

Questions

Does the Bare Metal Solution API API need an API key?

Yes. The Bare Metal Solution API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Bare Metal Solution API API support HTTPS?

Yes, the Bare Metal Solution API API is served over HTTPS.

How many endpoints does the Bare Metal Solution API API have?

Its OpenAPI description lists 30 endpoints in version v2. All of them are shown on this page.

What are alternatives to the Bare Metal Solution API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).