Method: projects.locations.deployPolicies.list

Lists DeployPolicies in a given project and location.

HTTP request

GET https://clouddeploy.googleapis.com/v1/{parent=projects/*/locations/*}/deployPolicies

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of deploy policies. Format must be projects/{projectId}/locations/{location_name}.

Query parameters

Parameters
pageSize

integer

The maximum number of deploy policies to return. The service may return fewer than this value. If unspecified, at most 50 deploy policies will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
pageToken

string

A page token, received from a previous deployPolicies.list call. Provide this to retrieve the subsequent page.

When paginating, all other provided parameters match the call that provided the page token.
filter

string

Filter deploy policies to be returned. See https://google.aip.dev/160 for more details. All fields can be used in the filter.
orderBy

string

Field to sort by. See https://google.aip.dev/132#ordering for more details.

Request body

The request body must be empty.

Response body

The response object from deployPolicies.list.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "deployPolicies": [
    {
      object (DeployPolicy)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
deployPolicies[]

object (DeployPolicy)

The DeployPolicy objects.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
unreachable[]

string

Locations that could not be reached.

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:

  • clouddeploy.deployPolicies.list

For more information, see the IAM documentation.