Skip to content
OpenParablePublic APIs

OS Config API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.

OS Config API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 14 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://osconfig.googleapis.com/
Version
v1beta
Endpoints
14
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

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

cURL
curl -X GET "https://osconfig.googleapis.com/v1beta/NAME" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://osconfig.googleapis.com/v1beta/NAME", {
  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://osconfig.googleapis.com/v1beta/NAME",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/v1beta/{instance}:lookupEffectiveGuestPolicyLookup the effective guest policy that applies to a VM instance. This lookup merges all policies that are assigned to the instance ancestry.
GET/v1beta/{name}Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.
PATCH/v1beta/{name}Update an OS Config patch deployment.
DELETE/v1beta/{name}Delete an OS Config patch deployment.
POST/v1beta/{name}:cancelCancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.
POST/v1beta/{name}:pauseChange state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.
POST/v1beta/{name}:resumeChange state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs.
GET/v1beta/{parent}/guestPoliciesGet a page of OS Config guest policies.
POST/v1beta/{parent}/guestPoliciesCreate an OS Config guest policy.
GET/v1beta/{parent}/instanceDetailsGet a list of instance details for a given patch job.
GET/v1beta/{parent}/patchDeploymentsGet a page of OS Config patch deployments.
POST/v1beta/{parent}/patchDeploymentsCreate an OS Config patch deployment.
GET/v1beta/{parent}/patchJobsGet a list of patch jobs.
POST/v1beta/{parent}/patchJobs:executePatch VM instances by creating and running a patch job.

Questions

Does the OS Config API API need an API key?

Yes. The OS Config API API uses OAuth authentication; the documentation explains how to get credentials.

Does the OS Config API API support HTTPS?

Yes, the OS Config API API is served over HTTPS.

How many endpoints does the OS Config API API have?

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

What are alternatives to the OS Config 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).