OS Config API
OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.
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
OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.
Endpoints 7
projects.locations.global.policyOrchestrators
- GETLists the policy orchestrators under the given parent project resource.
/v2/:parent/policyOrchestrators?filter=string&orderBy=string&pageSize=0&pageToken=stringLists the policy orchestrators under the given parent project resource. - POSTCreates a new policy orchestrator under the given project resource
/v2/:parent/policyOrchestrators?policyOrchestratorId=string&requestId=stringCreates a new policy orchestrator under the given project resource. name field of the given orchestrator are ignored and instead replaced by a product of… - PATCHUpdates an existing policy orchestrator, parented by a project.
/v2/:name?updateMask=stringUpdates an existing policy orchestrator, parented by a project.
projects.locations.operations
- GETGets the latest state of a long-running operation
/v2/:nameGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - DELETEDeletes a long-running operation
/v2/:nameDeletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If… - POSTStarts asynchronous cancellation on a long-running operation
/v2/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the… - GETLists operations that match the specified filter in the request
/v2/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
API details
- Base URL
https://osconfig.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 7 operations on 4 pathsGET 3POST 2PATCH 1DELETE 1
- Main resources
- projects.locations.operations 4projects.locations.global.policyOrchestrators 3
- Response formats
application/json- Description format
- Google API Discovery, API version
v2 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the OS Config API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the OS Config API collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Lists the policy orchestrators under the given parent project resource.” (GET /v2/:parent/policyOrchestrators?filter=string&orderBy=string&pageSize=0&pageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the OS Config API?
OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances. It is listed under Developer tools and has 7 endpoints.
Who publishes the OS Config 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 OS Config API?
Requests go to https://osconfig.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the OS Config 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 OS Config API have?
7 operations on 4 paths (3 GET, 2 POST, 1 PATCH, 1 DELETE). The largest groups are projects.locations.operations, projects.locations.global.policyOrchestrators.
Is forking the OS Config API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.