11openapi: 3.0.1
22info:
3- version: 4.78.3
3+ version: 4.79.0
44
55 title: Linode API
66 description: |
@@ -11133,6 +11133,7 @@ paths:
1113311133 For more fine-grained control of both systems, please use the S3 API directly.
1113411134
1113511135
11136+
1113611137 This endpoint is available for convenience. It is recommended that instead you
1113711138 use the more more [fully-featured S3 API](https://docs.ceph.com/docs/mimic/radosgw/s3/bucketops/#put-bucket-acl) directly.
1113811139 tags:
@@ -11160,6 +11161,8 @@ paths:
1116011161 - private
1116111162 - public-read
1116211163 - authenticated-read
11164+ - public-read-write
11165+ - custom
1116311166 description: >
1116411167 The Access Control Level of the bucket, as a canned ACL string.
1116511168 For more fine-grained control of ACLs, use the S3 API directly.
@@ -11183,6 +11186,230 @@ paths:
1118311186 "acl": "private"
1118411187 }' \
1118511188 https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/access
11189+ put:
11190+ operationId: modifyObjectStorageBucketAccess
11191+ x-linode-cli-skip: true
11192+ servers:
11193+ - url: https://api.linode.com/v4
11194+ summary: Object Storage Bucket Access Update
11195+ description: |
11196+ Allows changing basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings.
11197+ Only allows enabling/disabling CORS for all origins, and/or setting canned ACLs.
11198+ For more fine-grained control of both systems, please use the S3 API directly.
11199+
11200+
11201+ This endpoint is available for convenience. It is recommended that instead you
11202+ use the more more [fully-featured S3 API](https://docs.ceph.com/docs/mimic/radosgw/s3/bucketops/#put-bucket-acl) directly.
11203+ tags:
11204+ - Object Storage
11205+ security:
11206+ - personalAccessToken: []
11207+ - oauth:
11208+ - object_storage:read_write
11209+ requestBody:
11210+ description: The changes to make to the bucket's access controls.
11211+ content:
11212+ application/json:
11213+ schema:
11214+ properties:
11215+ cors_enabled:
11216+ type: boolean
11217+ description: >
11218+ If true, the bucket will be created with CORS enabled for all
11219+ origins. For more fine-grained controls of CORS, use the S3
11220+ API directly.
11221+ example: true
11222+ acl:
11223+ type: string
11224+ enum:
11225+ - private
11226+ - public-read
11227+ - authenticated-read
11228+ - public-read-write
11229+ - custom
11230+ description: >
11231+ The Access Control Level of the bucket, as a canned ACL string.
11232+ For more fine-grained control of ACLs, use the S3 API directly.
11233+ example: private
11234+ responses:
11235+ '200':
11236+ description: Access controls updated.
11237+ content:
11238+ application/json:
11239+ schema:
11240+ type: object
11241+ default:
11242+ $ref: '#/components/responses/ErrorResponse'
11243+ x-code-samples:
11244+ - lang: Shell
11245+ source: >
11246+ curl -H "Content-Type: application/json" \
11247+ -H "Authorization: Bearer $TOKEN" \
11248+ -X PUT -d '{
11249+ "cors_enabled": true,
11250+ "acl": "private"
11251+ }' \
11252+ https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/access
11253+ /object-storage/buckets/{clusterId}/{bucket}/object-acl:
11254+ parameters:
11255+ - name: clusterId
11256+ in: path
11257+ description: The ID of the cluster this bucket exists in.
11258+ required: true
11259+ schema:
11260+ type: string
11261+ - name: bucket
11262+ in: path
11263+ description: The bucket name.
11264+ required: true
11265+ schema:
11266+ type: string
11267+ get:
11268+ operationId: viewObjectStorageBucketAccess
11269+ x-linode-cli-skip: true
11270+ servers:
11271+ - url: https://api.linode.com/v4
11272+ summary: Object Storage Object ACL Config View
11273+ description: |
11274+ This Object Storage bucket's currently configured Access Control List (ACL).
11275+ ACLs define who can access your buckets and objects and specify the level of access
11276+ granted to those users.
11277+
11278+
11279+ This endpoint is available for convenience. It is recommended that instead you
11280+ use the more more [fully-featured S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/get-object-acl.html) directly.
11281+ tags:
11282+ - Object Storage
11283+ security:
11284+ - personalAccessToken: []
11285+ - oauth:
11286+ - object_storage:read_only
11287+ parameters:
11288+ - name: name
11289+ in: query
11290+ required: true
11291+ description: >
11292+ The `name` of the object for which to retrieve its Access Control List (ACL).
11293+ Use the [Object Storage Bucket Contents List](/docs/api/object-storage/#object-storage-bucket-contents-list)
11294+ endpoint to access all object names in a bucket.
11295+ schema:
11296+ type: string
11297+ responses:
11298+ '200':
11299+ description: The Object's canned ACL and policy.
11300+ content:
11301+ application/json:
11302+ schema:
11303+ type: object
11304+ properties:
11305+ acl:
11306+ type: string
11307+ enum:
11308+ - private
11309+ - public-read
11310+ - authenticated-read
11311+ - public-read-write
11312+ - custom
11313+ description: >
11314+ The Access Control Level of the bucket, as a canned ACL string.
11315+ For more fine-grained control of ACLs, use the S3 API directly.
11316+ example: public-read
11317+ acl_xml:
11318+ type: string
11319+ description: >
11320+ The full XML of the object's ACL policy.
11321+ example: "<AccessControlPolicy>...</AccessControlPolicy>"
11322+ default:
11323+ $ref: '#/components/responses/ErrorResponse'
11324+ x-code-samples:
11325+ - lang: Shell
11326+ source: >
11327+ curl -H "Authorization: Bearer $TOKEN" \
11328+ https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/object-acl?name=example.txt
11329+ put:
11330+ operationId: viewObjectStorageBucketAccess
11331+ x-linode-cli-skip: true
11332+ servers:
11333+ - url: https://api.linode.com/v4
11334+ summary: Object Storage Object ACL Config Update
11335+ description: |
11336+ Update an Object's configured Access Control List (ACL) in this Object Storage bucket.
11337+ ACLs define who can access your buckets and objects and specify the level of access
11338+ granted to those users.
11339+
11340+
11341+ This endpoint is available for convenience. It is recommended that instead you
11342+ use the more more [fully-featured S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/put-object-acl.html) directly.
11343+ tags:
11344+ - Object Storage
11345+ security:
11346+ - personalAccessToken: []
11347+ - oauth:
11348+ - object_storage:read_write
11349+ parameters:
11350+ - name: name
11351+ in: query
11352+ required: true
11353+ description: >
11354+ The `name` of the object for which to update its Access Control List (ACL).
11355+ Use the [Object Storage Bucket Contents List](/docs/api/object-storage/#object-storage-bucket-contents-list)
11356+ endpoint to access all object names in a bucket.
11357+ schema:
11358+ type: string
11359+ requestBody:
11360+ description: The changes to make to this Object's access controls.
11361+ content:
11362+ application/json:
11363+ schema:
11364+ properties:
11365+ acl:
11366+ type: string
11367+ enum:
11368+ - private
11369+ - public-read
11370+ - authenticated-read
11371+ - public-read-write
11372+ - custom
11373+ description: >
11374+ The Access Control Level of the bucket, as a canned ACL string.
11375+ For more fine-grained control of ACLs, use the S3 API directly.
11376+ example: public-read
11377+ responses:
11378+ '200':
11379+ description: The Object's canned ACL and policy.
11380+ content:
11381+ application/json:
11382+ schema:
11383+ type: object
11384+ properties:
11385+ acl:
11386+ type: string
11387+ enum:
11388+ - private
11389+ - public-read
11390+ - authenticated-read
11391+ - public-read-write
11392+ - custom
11393+ description: >
11394+ The Access Control Level of the bucket, as a canned ACL string.
11395+ For more fine-grained control of ACLs, use the S3 API directly.
11396+ example: public-read
11397+ acl_xml:
11398+ type: string
11399+ description: >
11400+ The full XML of the object's ACL policy.
11401+ example: "<AccessControlPolicy>...</AccessControlPolicy>"
11402+ default:
11403+ $ref: '#/components/responses/ErrorResponse'
11404+ x-code-samples:
11405+ - lang: Shell
11406+ source: >
11407+ curl -H "Content-Type: application/json" \
11408+ -H "Authorization: Bearer $TOKEN" \
11409+ -X PUT -d '{
11410+ "acl": "public-read"
11411+ }' \
11412+ https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/object-acl?name=example.txt
1118611413 /object-storage/buckets/{clusterId}/{bucket}/object-list:
1118711414 parameters:
1118811415 - name: clusterId
@@ -11850,6 +12077,47 @@ paths:
1185012077 source: >
1185112078 linode-cli object-storage ssl-delete \
1185212079 us-east-1 example-bucket
12080+ /object-storage/transfer:
12081+ get:
12082+ operationId: getObjectStorageTransfer
12083+ x-linode-cli-skip: true
12084+ servers:
12085+ - url: https://api.linode.com/v4
12086+ summary: Object Storage Transfer View
12087+ description: |
12088+ The amount of outbound data transfer used by your account's Object Storage buckets.
12089+ Object Storage adds 1 terabyte of outbound data transfer to your data transfer pool.
12090+ See the [Object Storage Pricing and Limitations](/docs/guides/pricing-and-limitations/)
12091+ guide for details on Object Storage transfer quotas.
12092+
12093+ tags:
12094+ - Object Storage
12095+ security:
12096+ - personalAccessToken: []
12097+ - oauth:
12098+ - object_storage:read_only
12099+ responses:
12100+ '200':
12101+ description: >
12102+ Returns the amount of outbound data transfer used by your account's Object Storage buckets.
12103+ content:
12104+ application/json:
12105+ schema:
12106+ properties:
12107+ used:
12108+ type: integer
12109+ description: >
12110+ The amount of outbound data transfer used by your account's Object Storage buckets,
12111+ in GB, for the current month’s billing cycle.
12112+ example: 12956600198
12113+ readOnly: true
12114+ default:
12115+ $ref: '#/components/responses/ErrorResponse'
12116+ x-code-samples:
12117+ - lang: Shell
12118+ source: >
12119+ curl -H "Authorization: Bearer $TOKEN" \
12120+ https://api.linode.com/v4/object-storage/transfer/
1185312121 /profile:
1185412122 x-linode-cli-command: profile
1185512123 get:
@@ -13243,7 +13511,7 @@ paths:
1324313511 source: >
1324413512 curl -H "Authorization: Bearer $TOKEN" \
1324513513 -X POST \
13246- -F 'file=/Users/LinodeGuy/pictures/screen_shot.jpg' \
13514+ -F 'file=@ /Users/LinodeGuy/pictures/screen_shot.jpg' \
1324713515 https://api.linode.com/v4/support/tickets/11223344/attachments
1324813516 /support/tickets/{ticketId}/close:
1324913517 parameters:
@@ -18853,6 +19121,11 @@ components:
1885319121 type: integer
1885419122 description: The size of the bucket in bytes.
1885519123 example: 188318981
19124+ objects:
19125+ type: integer
19126+ description: >
19127+ The number of objects stored in this bucket.
19128+ example: 4
1885619129 ObjectStorageObject:
1885719130 type: object
1885819131 description: >
0 commit comments