/
osconfig.v1.json
3774 lines (3774 loc) 路 170 KB
/
osconfig.v1.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://osconfig.googleapis.com/",
"batchPath": "batch",
"canonicalName": "OS Config",
"description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "osconfig:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://osconfig.mtls.googleapis.com/",
"name": "osconfig",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"resources": {
"instances": {
"resources": {
"inventories": {
"methods": {
"get": {
"description": "Get inventory data for the specified VM instance. If the VM has no associated inventory, the message `NOT_FOUND` is returned.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/inventory",
"httpMethod": "GET",
"id": "osconfig.projects.locations.instances.inventories.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. API resource name for inventory resource. Format: `projects/{project}/locations/{location}/instances/{instance}/inventory` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance}`, either Compute Engine `instance-id` or `instance-name` can be provided.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/inventory$",
"required": true,
"type": "string"
},
"view": {
"description": "Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.",
"enum": [
"INVENTORY_VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"enumDescriptions": [
"The default value. The API defaults to the BASIC view.",
"Returns the basic inventory information that includes `os_info`.",
"Returns all fields."
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Inventory"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "List inventory data for all VM instances in the specified zone.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/inventories",
"httpMethod": "GET",
"id": "osconfig.projects.locations.instances.inventories.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "If provided, this field specifies the criteria that must be met by a `Inventory` API resource to be included in the response.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to `ListInventories` that indicates where this listing should continue from.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/instances/-` For `{project}`, either `project-number` or `project-id` can be provided.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
},
"view": {
"description": "Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.",
"enum": [
"INVENTORY_VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"enumDescriptions": [
"The default value. The API defaults to the BASIC view.",
"Returns the basic inventory information that includes `os_info`.",
"Returns all fields."
],
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/inventories",
"response": {
"$ref": "ListInventoriesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"osPolicyAssignments": {
"resources": {
"reports": {
"methods": {
"get": {
"description": "Get the OS policy asssignment report for the specified Compute Engine VM instance.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/osPolicyAssignments/{osPolicyAssignmentsId}/report",
"httpMethod": "GET",
"id": "osconfig.projects.locations.instances.osPolicyAssignments.reports.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. API resource name for OS policy assignment report. Format: `/projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance_id}`, either Compute Engine `instance-id` or `instance-name` can be provided. For `{assignment_id}`, the OSPolicyAssignment id must be provided.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/osPolicyAssignments/[^/]+/report$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "OSPolicyAssignmentReport"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "List OS policy asssignment reports for all Compute Engine VM instances in the specified zone.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/osPolicyAssignments/{osPolicyAssignmentsId}/reports",
"httpMethod": "GET",
"id": "osconfig.projects.locations.instances.osPolicyAssignments.reports.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "If provided, this field specifies the criteria that must be met by the `OSPolicyAssignmentReport` API resource that is included in the response.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to the `ListOSPolicyAssignmentReports` method that indicates where this listing should continue from.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/reports` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance}`, either `instance-name`, `instance-id`, or `-` can be provided. If '-' is provided, the response will include OSPolicyAssignmentReports for all instances in the project/location. For `{assignment}`, either `assignment-id` or `-` can be provided. If '-' is provided, the response will include OSPolicyAssignmentReports for all OSPolicyAssignments in the project/location. Either {instance} or {assignment} must be `-`. For example: `projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/-/reports` returns all reports for the instance `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/{assignment-id}/reports` returns all the reports for the given assignment across all instances. `projects/{project}/locations/{location}/instances/-/osPolicyAssignments/-/reports` returns all the reports for all assignments across all instances.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/osPolicyAssignments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/reports",
"response": {
"$ref": "ListOSPolicyAssignmentReportsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"vulnerabilityReports": {
"methods": {
"get": {
"description": "Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/vulnerabilityReport",
"httpMethod": "GET",
"id": "osconfig.projects.locations.instances.vulnerabilityReports.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. API resource name for vulnerability resource. Format: `projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance}`, either Compute Engine `instance-id` or `instance-name` can be provided.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+/vulnerabilityReport$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "VulnerabilityReport"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "List vulnerability reports for all VM instances in the specified zone.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}/vulnerabilityReports",
"httpMethod": "GET",
"id": "osconfig.projects.locations.instances.vulnerabilityReports.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "This field supports filtering by the severity level for the vulnerability. For a list of severity levels, see [Severity levels for vulnerabilities](https://cloud.google.com/container-analysis/docs/container-scanning-overview#severity_levels_for_vulnerabilities). The filter field follows the rules described in the [AIP-160](https://google.aip.dev/160) guidelines as follows: + **Filter for a specific severity type**: you can list reports that contain vulnerabilities that are classified as medium by specifying `vulnerabilities.details.severity:MEDIUM`. + **Filter for a range of severities** : you can list reports that have vulnerabilities that are classified as critical or high by specifying `vulnerabilities.details.severity:HIGH OR vulnerabilities.details.severity:CRITICAL`",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to `ListVulnerabilityReports` that indicates where this listing should continue from.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/instances/-` For `{project}`, either `project-number` or `project-id` can be provided.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/vulnerabilityReports",
"response": {
"$ref": "ListVulnerabilityReportsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"osPolicyAssignments": {
"methods": {
"create": {
"description": "Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments",
"httpMethod": "POST",
"id": "osconfig.projects.locations.osPolicyAssignments.create",
"parameterOrder": [
"parent"
],
"parameters": {
"osPolicyAssignmentId": {
"description": "Required. The logical name of the OS policy assignment in the project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name in the form: projects/{project}/locations/{location}. Note: Specify the zone of your VMs as the location.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/osPolicyAssignments",
"request": {
"$ref": "OSPolicyAssignment"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}",
"httpMethod": "DELETE",
"id": "osconfig.projects.locations.osPolicyAssignments.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the OS policy assignment to be deleted",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/osPolicyAssignments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Retrieve an existing OS policy assignment. This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the `name` parameter.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}",
"httpMethod": "GET",
"id": "osconfig.projects.locations.osPolicyAssignments.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of OS policy assignment. Format: `projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}@{revisionId}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/osPolicyAssignments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "OSPolicyAssignment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments",
"httpMethod": "GET",
"id": "osconfig.projects.locations.osPolicyAssignments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "The maximum number of assignments to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to `ListOSPolicyAssignments` that indicates where this listing should continue from.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent resource name.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/osPolicyAssignments",
"response": {
"$ref": "ListOSPolicyAssignmentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"listRevisions": {
"description": "List the OS policy assignment revisions for a given OS policy assignment.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}:listRevisions",
"httpMethod": "GET",
"id": "osconfig.projects.locations.osPolicyAssignments.listRevisions",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the OS policy assignment to list revisions for.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/osPolicyAssignments/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The maximum number of revisions to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call to `ListOSPolicyAssignmentRevisions` that indicates where this listing should continue from.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}:listRevisions",
"response": {
"$ref": "ListOSPolicyAssignmentRevisionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see [Method: projects.locations.osPolicyAssignments.operations.cancel](https://cloud.google.com/compute/docs/osconfig/rest/v1/projects.locations.osPolicyAssignments.operations/cancel).",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}",
"httpMethod": "PATCH",
"id": "osconfig.projects.locations.osPolicyAssignments.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/osPolicyAssignments/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask that controls which fields of the assignment should be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "OSPolicyAssignment"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "osconfig.projects.locations.osPolicyAssignments.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/osPolicyAssignments/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "CancelOperationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets 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.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/osPolicyAssignments/{osPolicyAssignmentsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "osconfig.projects.locations.osPolicyAssignments.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/osPolicyAssignments/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
},
"patchDeployments": {
"methods": {
"create": {
"description": "Create an OS Config patch deployment.",
"flatPath": "v1/projects/{projectsId}/patchDeployments",
"httpMethod": "POST",
"id": "osconfig.projects.patchDeployments.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project to apply this patch deployment to in the form `projects/*`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"patchDeploymentId": {
"description": "Required. A name for the patch deployment in the project. When creating a name the following rules apply: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/patchDeployments",
"request": {
"$ref": "PatchDeployment"
},
"response": {
"$ref": "PatchDeployment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Delete an OS Config patch deployment.",
"flatPath": "v1/projects/{projectsId}/patchDeployments/{patchDeploymentsId}",
"httpMethod": "DELETE",
"id": "osconfig.projects.patchDeployments.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.",
"location": "path",
"pattern": "^projects/[^/]+/patchDeployments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Get an OS Config patch deployment.",
"flatPath": "v1/projects/{projectsId}/patchDeployments/{patchDeploymentsId}",
"httpMethod": "GET",
"id": "osconfig.projects.patchDeployments.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.",
"location": "path",
"pattern": "^projects/[^/]+/patchDeployments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "PatchDeployment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Get a page of OS Config patch deployments.",
"flatPath": "v1/projects/{projectsId}/patchDeployments",
"httpMethod": "GET",
"id": "osconfig.projects.patchDeployments.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of patch deployments to return. Default is 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the parent in the form `projects/*`.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/patchDeployments",
"response": {
"$ref": "ListPatchDeploymentsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Update an OS Config patch deployment.",
"flatPath": "v1/projects/{projectsId}/patchDeployments/{patchDeploymentsId}",
"httpMethod": "PATCH",
"id": "osconfig.projects.patchDeployments.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment.",
"location": "path",
"pattern": "^projects/[^/]+/patchDeployments/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Optional. Field mask that controls which fields of the patch deployment should be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "PatchDeployment"
},
"response": {
"$ref": "PatchDeployment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"pause": {
"description": "Change state of patch deployment to \"PAUSED\". Patch deployment in paused state doesn't generate patch jobs.",
"flatPath": "v1/projects/{projectsId}/patchDeployments/{patchDeploymentsId}:pause",
"httpMethod": "POST",
"id": "osconfig.projects.patchDeployments.pause",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.",
"location": "path",
"pattern": "^projects/[^/]+/patchDeployments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:pause",
"request": {
"$ref": "PausePatchDeploymentRequest"
},
"response": {
"$ref": "PatchDeployment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"resume": {
"description": "Change state of patch deployment back to \"ACTIVE\". Patch deployment in active state continues to generate patch jobs.",
"flatPath": "v1/projects/{projectsId}/patchDeployments/{patchDeploymentsId}:resume",
"httpMethod": "POST",
"id": "osconfig.projects.patchDeployments.resume",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the patch deployment in the form `projects/*/patchDeployments/*`.",
"location": "path",
"pattern": "^projects/[^/]+/patchDeployments/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:resume",
"request": {
"$ref": "ResumePatchDeploymentRequest"
},
"response": {
"$ref": "PatchDeployment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"patchJobs": {
"methods": {
"cancel": {
"description": "Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.",
"flatPath": "v1/projects/{projectsId}/patchJobs/{patchJobsId}:cancel",
"httpMethod": "POST",
"id": "osconfig.projects.patchJobs.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the patch in the form `projects/*/patchJobs/*`",
"location": "path",
"pattern": "^projects/[^/]+/patchJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"request": {
"$ref": "CancelPatchJobRequest"
},
"response": {
"$ref": "PatchJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"execute": {
"description": "Patch VM instances by creating and running a patch job.",
"flatPath": "v1/projects/{projectsId}/patchJobs:execute",
"httpMethod": "POST",
"id": "osconfig.projects.patchJobs.execute",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project in which to run this patch in the form `projects/*`",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/patchJobs:execute",
"request": {
"$ref": "ExecutePatchJobRequest"
},
"response": {
"$ref": "PatchJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.",
"flatPath": "v1/projects/{projectsId}/patchJobs/{patchJobsId}",
"httpMethod": "GET",
"id": "osconfig.projects.patchJobs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the patch in the form `projects/*/patchJobs/*`",
"location": "path",
"pattern": "^projects/[^/]+/patchJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "PatchJob"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Get a list of patch jobs.",
"flatPath": "v1/projects/{projectsId}/patchJobs",
"httpMethod": "GET",
"id": "osconfig.projects.patchJobs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of instance status to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call that indicates where this listing should continue from.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. In the form of `projects/*`",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/patchJobs",
"response": {
"$ref": "ListPatchJobsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"instanceDetails": {
"methods": {
"list": {
"description": "Get a list of instance details for a given patch job.",
"flatPath": "v1/projects/{projectsId}/patchJobs/{patchJobsId}/instanceDetails",
"httpMethod": "GET",
"id": "osconfig.projects.patchJobs.instanceDetails.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or `failure_reason`.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of instance details records to return. Default is 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A pagination token returned from a previous call that indicates where this listing should continue from.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The parent for the instances are in the form of `projects/*/patchJobs/*`.",
"location": "path",
"pattern": "^projects/[^/]+/patchJobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/instanceDetails",
"response": {
"$ref": "ListPatchJobInstanceDetailsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}