folders

Changed on

Retrieves a list of folders matching the criteria. Only applicable to buckets with hierarchical namespace enabled.

get/b/{bucket}/folders

Request

  • Base URL: https://storage.googleapis.com/storage/v1
  • URL: https://storage.googleapis.com/storage/v1/b/{bucket}/folders
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform.read-only) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform.read-only)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/devstorage.full_control) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/devstorage.full_control)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/devstorage.read_only) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/devstorage.read_only)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/devstorage.read_write) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/devstorage.read_write)

Path parameters

bucketstring required

Name of the bucket in which to look for folders.

Query parameters

delimiterstring

Returns results in a directory-like mode. The only supported value is '/'. If set, items will only contain folders that either exactly match the prefix, or are one level below the prefix.

endOffsetstring

Filter results to folders whose names are lexicographically before endOffset. If startOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).

pageSizeinteger

Maximum number of items to return in a single page of responses.

pageTokenstring

A previously-returned page token representing part of the larger set of results to view.

prefixstring

Filter results to folders whose paths begin with this prefix. If set, the value must either be an empty string or end with a '/'.

startOffsetstring

Filter results to folders whose names are lexicographically equal to or after startOffset. If endOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).

Response

Successful response

Changes

  • 1663d8472a14Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/devstorage.read_write was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/devstorage.read_write was removed from the endpoint's security scheme Oauth2c

  • 0cdf1c1a070fRevision changes
    • breaking

      removed the media type */* for the response with the status

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/devstorage.read_write was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/devstorage.read_write was removed from the endpoint's security scheme Oauth2c