Method: projects.patchJobs.execute

HTTP request
Path parameters
Request body
- JSON representation
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/v1beta/{parent=projects/*}/patchJobs:execute

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`parent`	`string` Required. The project in which to run this patch in the form `projects/*`

parent

string

Required. The project in which to run this patch in the form projects/*

Request body

The request body contains data with the following structure:

JSON representation

JSON representation
{ "description" : string , "instanceFilter" : { object ( `PatchInstanceFilter` ) } , "patchConfig" : { object ( `PatchConfig` ) } , "duration" : string , "dryRun" : boolean , "displayName" : string , "rollout" : { object ( `PatchRollout` ) } }

 { 
 "description" 
 : 
 string 
 , 
 "instanceFilter" 
 : 
 { 
 object (  PatchInstanceFilter 
 
) 
 } 
 , 
 "patchConfig" 
 : 
 { 
 object (  PatchConfig 
 
) 
 } 
 , 
 "duration" 
 : 
 string 
 , 
 "dryRun" 
 : 
 boolean 
 , 
 "displayName" 
 : 
 string 
 , 
 "rollout" 
 : 
 { 
 object (  PatchRollout 
 
) 
 } 
 }

Fields
`description`	`string` Description of the patch job. Length of the description is limited to 1024 characters.
`instanceFilter`	`object ( PatchInstanceFilter )` Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.
`patchConfig`	`object ( PatchConfig )` Patch configuration being applied. If omitted, instances are patched using the default configurations.
`duration`	`string ( Duration format)` 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 ' `s` '. Example: `"3.5s"` .
`dryRun`	`boolean` If this patch is a dry-run only, instances are contacted but will do nothing.
`displayName`	`string` Display name for this patch job. This does not have to be unique.
`rollout`	`object ( PatchRollout )` 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 .