Required. The parent for the instances are in the form of projects/*/patchJobs/*.
Query parameters
Parameters
pageSize
integer
The maximum number of instance details records to return. Default is 100.
pageToken
string
A pagination token returned from a previous call that indicates where this listing should continue from.
filter
string
A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or failureReason.
Request body
The request body must be empty.
Response body
A response message for listing the instances details for a patch job.
If successful, the response body contains data with the following structure:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-28 UTC."],[[["\u003cp\u003eThis webpage provides information on how to retrieve a list of instance details for a specific patch job using an HTTP GET request.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003eparent\u003c/code\u003e path parameter in the format \u003ccode\u003eprojects/*/patchJobs/*\u003c/code\u003e to specify the target patch job.\u003c/p\u003e\n"],["\u003cp\u003eOptional query parameters include \u003ccode\u003epageSize\u003c/code\u003e to limit the number of returned instance details, \u003ccode\u003epageToken\u003c/code\u003e for pagination, and \u003ccode\u003efilter\u003c/code\u003e to narrow down results by instance zone, name, state, or failure reason.\u003c/p\u003e\n"],["\u003cp\u003eThe response body, if successful, will include an array of \u003ccode\u003epatchJobInstanceDetails\u003c/code\u003e objects and a \u003ccode\u003enextPageToken\u003c/code\u003e for further pagination if needed.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization to perform this action requires the \u003ccode\u003eosconfig.patchJobs.get\u003c/code\u003e IAM permission on the parent resource and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.patchJobs.instanceDetails.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListPatchJobInstanceDetailsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nGet a list of instance details for a given patch job.\n\n### HTTP request\n\n`GET https://osconfig.googleapis.com/v1/{parent=projects/*/patchJobs/*}/instanceDetails`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA response message for listing the instances details for a patch job.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `osconfig.patchJobs.get`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
