- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Patch VM instances by creating and running a patch job.
HTTP request
POST https://osconfig.googleapis.com/v1/{parent=projects/*}/patchJobs:execute
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The project in which to run this patch in the form |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "description": string, "instanceFilter": { object ( |
Fields | |
---|---|
description |
Description of the patch job. Length of the description is limited to 1024 characters. |
instanceFilter |
Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels. |
patchConfig |
Patch configuration being applied. If omitted, instances are patched using the default configurations. |
duration |
Duration of the patch job. After the duration ends, the patch job times out. A duration in seconds with up to nine fractional digits, ending with ' |
dryRun |
If this patch is a dry-run only, instances are contacted but will do nothing. |
displayName |
Display name for this patch job. This does not have to be unique. |
rollout |
Rollout strategy of the patch job. |
Response body
If successful, the response body contains an instance of PatchJob
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent
resource:
osconfig.patchJobs.exec
For more information, see the IAM documentation.