Method: entitiesBlocklists.list

Full name: projects.locations.instances.entitiesBlocklists.list

List page of EntitiesBlocklists.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list EntitiesBlocklists for. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
pageSize

integer

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

string

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

When paginating, all other parameters provided to entitiesBlocklists.list must match the call that provided the page token.
filter

string

Optional. A filter to apply to the list of EntitiesBlocklists. Supported filter fields: * entityIdentifier: Filter by the user-facing name. * entityType: Filter by the entity type. * action: Filter by the action. * environmentsJson: Filter by the environments. Example: filter="entityIdentifier='EntitiesBlocklist 1'"
orderBy

string

Optional. Configures ordering of EntitiesBlocklists in the response. If not specified, EntitiesBlocklists are returned in descending order of their create time. The default ordering is by create time in descending order. The orderBy string is a comma separated list of fields. Supported fields: * entityIdentifier

Request body

The request body must be empty.

Response body

Response message for entitiesBlocklists.list.

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

JSON representation 
{
  "entitiesBlocklists": [
    {
      object (EntitiesBlocklist)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
entitiesBlocklists[]

object (EntitiesBlocklist)

The list of EntitiesBlocklists. Ordered by Id by default.
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.
totalSize

integer

Total number of EntitiesBlocklists.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.