Get Container ACL

Article
09/19/2023

The Get Container ACL operation gets the permissions for the specified container. The permissions indicate whether container data may be accessed publicly.

As of version 2009-09-19, the container permissions provide the following options for managing container access:

Full public read access: Container and blob data can be read via anonymous request. Clients can enumerate blobs within the container via anonymous request, but they can't enumerate containers within the storage account.
Public read access for blobs only: Blob data within this container can be read via anonymous request, but container data isn't available. Clients can't enumerate blobs within the container via anonymous request.
No public read access: Container and blob data can be read by the account owner only.

Get Container ACL also returns details about any container-level access policies that are specified on the container that may be used with shared access signatures. For more information, see Define a stored access policy.

All public access to the container is anonymous, as is access via a shared access signature.

Request

The Get Container ACL request may be constructed as follows. We recommend that you use HTTPS. Replace myaccount with the name of your storage account:

Method	Request URI	HTTP version
`GET/HEAD`	`https://myaccount.blob.core.windows.net/mycontainer?restype=container&comp=acl`	HTTP/1.1

Emulated storage service request

When you're making a request against the emulated storage service, specify the emulator hostname and Blob Storage port as 127.0.0.1:10000, followed by the emulated storage account name:

Method	Request URI	HTTP version
`GET/HEAD`	`http://127.0.0.1:10000/devstoreaccount1/mycontainer?restype=container&comp=acl`	HTTP/1.1

For more information, see Use the Azurite emulator for local Azure Storage development.

URI parameters

The following additional parameters may be specified on the request URI:

Parameter	Description
`timeout`	Optional. The `timeout` parameter is expressed in seconds. For more information, see Set time-outs for Blob Storage operations.

Request error codes

The required and optional request headers are described in the following table:

Request header	Description
`Authorization`	Required. Specifies the authorization scheme, account name, and signature. For more information, see Authorize requests to Azure Storage.
`Date` or `x-ms-date`	Required. Specifies the Coordinated Universal Time (UTC) for the request. For more information, see Authorize requests to Azure Storage.
`x-ms-lease-id: <ID>`	Optional, version 2012-02-12 and later. If it's specified, `Get Container ACL` succeeds only if the container’s lease is active and matches this ID. If there's no active lease or the ID does not match, `412 (Precondition Failed)` is returned.
`x-ms-version`	Required for all authorized requests. Specifies the version of the operation to use for this request. For more information, see Versioning for the Azure Storage services.
`x-ms-client-request-id`	Optional. Provides a client-generated, opaque value with a 1-kibibyte (KiB) character limit that's recorded in the logs when logging is configured. We highly recommend that you use this header to correlate client-side activities with requests that the server receives. For more information, see Monitor Azure Blob Storage.

Request body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status code

A successful operation returns status code 200 (OK).

For information about status codes, see Status and error codes.

Response error codes

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response header	Description
`x-ms-blob-public-access`	Indicates whether data in the container may be accessed publicly and the level of access. Possible values include: - `container`: Indicates full public read access for container and blob data. Clients can enumerate blobs within the container via anonymous request, but they can't enumerate containers within the storage account. - `blob:` Indicates public read access for blobs. Blob data within this container can be read via anonymous request, but container data isn't available. Clients can't enumerate blobs within the container via anonymous request. - `true:` Versions earlier than 2016-05-31 only. Indicates that the container was marked for full public read access by using a version earlier than 2009-09-19. As of version 2016-05-31, this value is returned as `container` instead. If this header isn't returned in the response, the container is private to the account owner.
`ETag`	The entity tag for the container. If the request version is 2011-08-18 or later, the ETag value is enclosed in quotation marks.
`Last-Modified`	Returns the date and time when the container was last modified. The date format follows RFC 1123. For more information, see Represent date/time values in error codes. Any operation that modifies the container or its properties or metadata updates the last modified time. Operations on blobs don't affect the last modified time of the container.
`x-ms-request-id`	Uniquely identifies the request that was made, and it can be used to troubleshoot the request. For more information, see Troubleshoot API operations.
`x-ms-version`	Indicates the service version that was used to execute the request. This header is returned for requests that were made against version 2009-09-19 and later.
`Date`	A UTC date/time value that's generated by the service, which indicates the time when the response was initiated.
`x-ms-client-request-id`	Can be used to troubleshoot requests and their corresponding responses. The value of this header is equal to the value of the `x-ms-client-request-id` header if it's present in the request and the value contains no more than 1,024 visible ASCII characters. If the `x-ms-client-request-id` header isn't present in the request, this header isn't present in the response.

Response body

If a container-level access policy has been specified for the container, Get Container ACL returns the signed identifier and access policy in the response body.

<?xml version="1.0" encoding="utf-8"?>  
<SignedIdentifiers>  
  <SignedIdentifier>  
    <Id>unique-value</Id>  
    <AccessPolicy>  
      <Start>start-time</Start>  
      <Expiry>expiry-time</Expiry>  
      <Permission>abbreviated-permission-list</Permission>  
    </AccessPolicy>  
  </SignedIdentifier>  
</SignedIdentifiers>

Sample response

Response Status:  
HTTP/1.1 200 OK  
  
Response Headers:  
Transfer-Encoding: chunked  
x-ms-blob-public-access: container  
Date: Sun, 25 Sep 2011 20:28:22 GMT  
ETag: "0x8CAFB82EFF70C46"  
Last-Modified: Sun, 25 Sep 2011 19:42:18 GMT  
x-ms-version: 2011-08-18  
Server: Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0  
  
<?xml version="1.0" encoding="utf-8"?>  
<SignedIdentifiers>  
  <SignedIdentifier>   
    <Id>MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI=</Id>  
    <AccessPolicy>  
      <Start>2009-09-28T08:49:37.0000000Z</Start>  
      <Expiry>2009-09-29T08:49:37.0000000Z</Expiry>  
      <Permission>rwd</Permission>  
    </AccessPolicy>  
  </SignedIdentifier>  
</SignedIdentifiers>

Authorization

The Get Container ACL operation only supports Shared Key authorization.

Remarks

Only the account owner may read data in a particular storage account, unless the account owner has specified that blobs within the container are available for public read access, or has made resources in the container available via a shared access signature.

Billing

Pricing requests can originate from clients that use Blob Storage APIs, either directly through the Blob Storage REST API, or from an Azure Storage client library. These requests accrue charges per transaction. The type of transaction affects how the account is charged. For example, read transactions accrue to a different billing category than write transactions. The following table shows the billing category for Get Container ACL requests based on the storage account type:

Operation	Storage account type	Billing category
Get Container ACL	Premium block blob Standard general-purpose v2	Other operations
Get Container ACL	Standard general-purpose v1	Read operations

To learn about pricing for the specified billing category, see Azure Blob Storage Pricing.

Share via