Object Storage

Object Storage Object ACL Config View

get
https://api.linode.com/v4/object-storage/buckets/{clusterId}/{bucket}/object-acl

View an Object's configured Access Control List (ACL) in this Object Storage bucket. ACLs define who can access your buckets and objects and specify the level of access granted to those users.

This endpoint is available for convenience. It is recommended that instead you use the more fully-featured S3 API directly.

Path Parameters

clusterId
Required
string

The ID of the cluster this bucket exists in.

bucket
Required
string

The bucket name.

Query Parameters

name
Required
string

The name of the object for which to retrieve its Access Control List (ACL). Use the Object Storage Bucket Contents List endpoint to access all object names in a bucket.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
  https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/object-acl?name=example.txt

Response Samples

{
  "acl": "public-read",
  "acl_xml": "<AccessControlPolicy>...</AccessControlPolicy>"
}

Responses

200: The Object's canned ACL and policy.

acl
string
Enum: "private""public-read""authenticated-read""public-read-write""custom"

The Access Control Level of the bucket, as a canned ACL string. For more fine-grained control of ACLs, use the S3 API directly.

acl_xml
string

The full XML of the object's ACL policy.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.

Object Storage Object ACL Config Update

put
https://api.linode.com/v4/object-storage/buckets/{clusterId}/{bucket}/object-acl

Update an Object's configured Access Control List (ACL) in this Object Storage bucket. ACLs define who can access your buckets and objects and specify the level of access granted to those users.

This endpoint is available for convenience. It is recommended that instead you use the more fully-featured S3 API directly.

Path Parameters

clusterId
Required
string

The ID of the cluster this bucket exists in.

bucket
Required
string

The bucket name.

Request Body Schema

acl
Required
string
Enum: "private""public-read""authenticated-read""public-read-write""custom"

The Access Control Level of the bucket, as a canned ACL string. For more fine-grained control of ACLs, use the S3 API directly.

name
Required
string

The name of the object for which to update its Access Control List (ACL). Use the Object Storage Bucket Contents List endpoint to access all object names in a bucket.

Request Samples

curl -H "Content-Type: application/json" \
 -H "Authorization: Bearer $TOKEN" \
  -X PUT -d '{
    "acl": "public-read",
    "name": "example.txt"
  }' \
  https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/object-acl

Response Samples

{
  "acl": "public-read",
  "acl_xml": "<AccessControlPolicy>...</AccessControlPolicy>"
}

Responses

200: The Object's canned ACL and policy.

name
string

The name of the object for which to update its Access Control List (ACL). Use the Object Storage Bucket Contents List endpoint to access all object names in a bucket.

acl
string
Enum: "private""public-read""authenticated-read""public-read-write""custom"

The Access Control Level of the bucket, as a canned ACL string. For more fine-grained control of ACLs, use the S3 API directly.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.