Class: LinodeOpenapiClient::ObjectStorageApi

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/api/object_storage_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ObjectStorageApi

Returns a new instance of ObjectStorageApi.



19
20
21
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_object_storage_bucket(api_version, region_id, bucket, opts = {}) ⇒ Object

Remove an Object Storage bucket Removes a single bucket. > 📘 > > - You need to remove all objects from a bucket before you can delete it. While you can delete a bucket using the [s3cmd command-line tool](www.linode.com/docs/products/storage/object-storage/guides/s3cmd/#delete-a-bucket), this operation fails if the bucket contains too many objects. The best way to empty large buckets is to use the [S3 API to configure lifecycle policies](docs.ceph.com/en/latest/radosgw/bucketpolicy/#). Set a policy to remove all objects, wait a day or more for the system to remove all objects, then delete the bucket. > > - The [S3 API](docs.ceph.com/en/latest/radosgw/s3/bucketops/#delete-bucket) equivalent operation offers more detail. <<LB>> — - __OAuth scopes__. “‘ object_storage:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


29
30
31
32
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 29

def delete_object_storage_bucket(api_version, region_id, bucket, opts = {})
  data, _status_code, _headers = delete_object_storage_bucket_with_http_info(api_version, region_id, bucket, opts)
  data
end

#delete_object_storage_bucket_with_http_info(api_version, region_id, bucket, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Remove an Object Storage bucket Removes a single bucket. &gt; 📘 &gt; &gt; - You need to remove all objects from a bucket before you can delete it. While you can delete a bucket using the [s3cmd command-line tool](www.linode.com/docs/products/storage/object-storage/guides/s3cmd/#delete-a-bucket), this operation fails if the bucket contains too many objects. The best way to empty large buckets is to use the [S3 API to configure lifecycle policies](docs.ceph.com/en/latest/radosgw/bucketpolicy/#). Set a policy to remove all objects, wait a day or more for the system to remove all objects, then delete the bucket. &gt; &gt; - The [S3 API](docs.ceph.com/en/latest/radosgw/s3/bucketops/#delete-bucket) equivalent operation offers more detail. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 41

def delete_object_storage_bucket_with_http_info(api_version, region_id, bucket, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.delete_object_storage_bucket ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.delete_object_storage_bucket"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling ObjectStorageApi.delete_object_storage_bucket"
  end
  # verify the required parameter 'bucket' is set
  if @api_client.config.client_side_validation && bucket.nil?
    fail ArgumentError, "Missing the required parameter 'bucket' when calling ObjectStorageApi.delete_object_storage_bucket"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/buckets/{regionId}/{bucket}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'regionId' + '}', CGI.escape(region_id.to_s)).sub('{' + 'bucket' + '}', CGI.escape(bucket.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.delete_object_storage_bucket",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#delete_object_storage_bucket\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_object_storage_key(api_version, key_id, opts = {}) ⇒ Object

Revoke an Object Storage key Revokes an Object Storage Key. This keypair will no longer be usable by third-party clients. - A successful request triggers an ‘obj_access_key_delete` event. <<LB>> — - __CLI__. “` linode-cli object-storage keys-delete 12345 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` object_storage:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • key_id (Integer) —

    The key to look up.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


108
109
110
111
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 108

def delete_object_storage_key(api_version, key_id, opts = {})
  data, _status_code, _headers = delete_object_storage_key_with_http_info(api_version, key_id, opts)
  data
end

#delete_object_storage_key_with_http_info(api_version, key_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Revoke an Object Storage key Revokes an Object Storage Key. This keypair will no longer be usable by third-party clients. - A successful request triggers an &#x60;obj_access_key_delete&#x60; event. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli object-storage keys-delete 12345 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • key_id (Integer) —

    The key to look up.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 119

def delete_object_storage_key_with_http_info(api_version, key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.delete_object_storage_key ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.delete_object_storage_key"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling ObjectStorageApi.delete_object_storage_key"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/keys/{keyId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'keyId' + '}', CGI.escape(key_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.delete_object_storage_key",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#delete_object_storage_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_object_storage_ssl(api_version, region_id, bucket, opts = {}) ⇒ Object

Delete an Object Storage TLS/SSL certificate Deletes this Object Storage bucket’s user uploaded TLS/SSL certificate and private key. <<LB>> — - __CLI__. “‘ linode-cli object-storage ssl-delete \ us-east-1 example-bucket “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` object_storage:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


183
184
185
186
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 183

def delete_object_storage_ssl(api_version, region_id, bucket, opts = {})
  data, _status_code, _headers = delete_object_storage_ssl_with_http_info(api_version, region_id, bucket, opts)
  data
end

#delete_object_storage_ssl_with_http_info(api_version, region_id, bucket, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete an Object Storage TLS/SSL certificate Deletes this Object Storage bucket&#39;s user uploaded TLS/SSL certificate and private key. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli object-storage ssl-delete \ us-east-1 example-bucket &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 195

def delete_object_storage_ssl_with_http_info(api_version, region_id, bucket, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.delete_object_storage_ssl ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.delete_object_storage_ssl"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling ObjectStorageApi.delete_object_storage_ssl"
  end
  # verify the required parameter 'bucket' is set
  if @api_client.config.client_side_validation && bucket.nil?
    fail ArgumentError, "Missing the required parameter 'bucket' when calling ObjectStorageApi.delete_object_storage_ssl"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/buckets/{regionId}/{bucket}/ssl'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'regionId' + '}', CGI.escape(region_id.to_s)).sub('{' + 'bucket' + '}', CGI.escape(bucket.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.delete_object_storage_ssl",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#delete_object_storage_ssl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_object_storage_bucket(api_version, region_id, bucket, opts = {}) ⇒ GetObjectStorageBucket200Response

Get an Object Storage bucket Returns a single Object Storage bucket. > 📘 > > The [S3 API](docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) equivalent operation offers more detail. <<LB>> — - __OAuth scopes__. “‘ object_storage:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



263
264
265
266
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 263

def get_object_storage_bucket(api_version, region_id, bucket, opts = {})
  data, _status_code, _headers = get_object_storage_bucket_with_http_info(api_version, region_id, bucket, opts)
  data
end

#get_object_storage_bucket_acl(api_version, region_id, bucket, name, opts = {}) ⇒ GetObjectStorageBucketAcl200Response

Get an Object Storage object ACL config 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. > 📘 > > The [S3 API](docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object-acl) equivalent operation offers more detail. <<LB>> — - __OAuth scopes__. “‘ object_storage:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • name (String) —

    The &#x60;name&#x60; of the object for which to retrieve its Access Control List (ACL). Run the [List Object Storage bucket contents](techdocs.akamai.com/linode-api/reference/get-object-storage-bucket-content) operation to access all object names in a bucket.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



344
345
346
347
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 344

def get_object_storage_bucket_acl(api_version, region_id, bucket, name, opts = {})
  data, _status_code, _headers = get_object_storage_bucket_acl_with_http_info(api_version, region_id, bucket, name, opts)
  data
end

#get_object_storage_bucket_acl_with_http_info(api_version, region_id, bucket, name, opts = {}) ⇒ Array<(GetObjectStorageBucketAcl200Response, Integer, Hash)>

Get an Object Storage object ACL config View an Object&#39;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. &gt; 📘 &gt; &gt; The [S3 API](docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object-acl) equivalent operation offers more detail. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • name (String) —

    The &#x60;name&#x60; of the object for which to retrieve its Access Control List (ACL). Run the [List Object Storage bucket contents](techdocs.akamai.com/linode-api/reference/get-object-storage-bucket-content) operation to access all object names in a bucket.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 357

def get_object_storage_bucket_acl_with_http_info(api_version, region_id, bucket, name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.get_object_storage_bucket_acl ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.get_object_storage_bucket_acl"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling ObjectStorageApi.get_object_storage_bucket_acl"
  end
  # verify the required parameter 'bucket' is set
  if @api_client.config.client_side_validation && bucket.nil?
    fail ArgumentError, "Missing the required parameter 'bucket' when calling ObjectStorageApi.get_object_storage_bucket_acl"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling ObjectStorageApi.get_object_storage_bucket_acl"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/buckets/{regionId}/{bucket}/object-acl'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'regionId' + '}', CGI.escape(region_id.to_s)).sub('{' + 'bucket' + '}', CGI.escape(bucket.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = name

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetObjectStorageBucketAcl200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.get_object_storage_bucket_acl",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#get_object_storage_bucket_acl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_object_storage_bucket_content(api_version, region_id, bucket, opts = {}) ⇒ GetObjectStorageBucketContent200Response

List Object Storage bucket contents Returns the contents of a bucket. The contents are paginated using a ‘marker`, that’s the name of the last object on the previous page. Objects can also be filtered by ‘prefix` and `delimiter`. See [Filtering and sorting](techdocs.akamai.com/linode-api/reference/filtering-and-sorting) for more information. > 📘 > > The [S3 API](docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object) equivalent operation offers more detail. <<LB>> — - __OAuth scopes__. “` object_storage:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :marker (String) —

    The &quot;marker&quot; for this request, which can be used to paginate through large buckets. Its value should be the value of the &#x60;next_marker&#x60; property returned with the last page. Listing bucket contents _does not_ support arbitrary page access. See the &#x60;next_marker&#x60; property in the responses section for more details.

  • :delimiter (String) —

    The delimiter for object names; if given, object names will be returned up to the first occurrence of this character. This is most commonly used with the &#x60;/&#x60; character to allow bucket transversal in a manner similar to a filesystem, however any delimiter may be used. Use in conjunction with &#x60;prefix&#x60; to see object names past the first occurrence of the delimiter.

  • :prefix (String) —

    Filters objects returned to only those whose name start with the given prefix. Commonly used in conjunction with &#x60;delimiter&#x60; to allow transversal of bucket contents in a manner similar to a filesystem.

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



434
435
436
437
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 434

def get_object_storage_bucket_content(api_version, region_id, bucket, opts = {})
  data, _status_code, _headers = get_object_storage_bucket_content_with_http_info(api_version, region_id, bucket, opts)
  data
end

#get_object_storage_bucket_content_with_http_info(api_version, region_id, bucket, opts = {}) ⇒ Array<(GetObjectStorageBucketContent200Response, Integer, Hash)>

List Object Storage bucket contents Returns the contents of a bucket. The contents are paginated using a &#x60;marker&#x60;, that&#39;s the name of the last object on the previous page. Objects can also be filtered by &#x60;prefix&#x60; and &#x60;delimiter&#x60;. See [Filtering and sorting](techdocs.akamai.com/linode-api/reference/filtering-and-sorting) for more information. &gt; 📘 &gt; &gt; The [S3 API](docs.ceph.com/en/latest/radosgw/s3/objectops/#get-object) equivalent operation offers more detail. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :marker (String) —

    The &quot;marker&quot; for this request, which can be used to paginate through large buckets. Its value should be the value of the &#x60;next_marker&#x60; property returned with the last page. Listing bucket contents _does not_ support arbitrary page access. See the &#x60;next_marker&#x60; property in the responses section for more details.

  • :delimiter (String) —

    The delimiter for object names; if given, object names will be returned up to the first occurrence of this character. This is most commonly used with the &#x60;/&#x60; character to allow bucket transversal in a manner similar to a filesystem, however any delimiter may be used. Use in conjunction with &#x60;prefix&#x60; to see object names past the first occurrence of the delimiter.

  • :prefix (String) —

    Filters objects returned to only those whose name start with the given prefix. Commonly used in conjunction with &#x60;delimiter&#x60; to allow transversal of bucket contents in a manner similar to a filesystem.

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 450

def get_object_storage_bucket_content_with_http_info(api_version, region_id, bucket, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.get_object_storage_bucket_content ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.get_object_storage_bucket_content"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling ObjectStorageApi.get_object_storage_bucket_content"
  end
  # verify the required parameter 'bucket' is set
  if @api_client.config.client_side_validation && bucket.nil?
    fail ArgumentError, "Missing the required parameter 'bucket' when calling ObjectStorageApi.get_object_storage_bucket_content"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ObjectStorageApi.get_object_storage_bucket_content, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ObjectStorageApi.get_object_storage_bucket_content, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/object-storage/buckets/{regionId}/{bucket}/object-list'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'regionId' + '}', CGI.escape(region_id.to_s)).sub('{' + 'bucket' + '}', CGI.escape(bucket.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'marker'] = opts[:'marker'] if !opts[:'marker'].nil?
  query_params[:'delimiter'] = opts[:'delimiter'] if !opts[:'delimiter'].nil?
  query_params[:'prefix'] = opts[:'prefix'] if !opts[:'prefix'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetObjectStorageBucketContent200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.get_object_storage_bucket_content",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#get_object_storage_bucket_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_object_storage_bucket_with_http_info(api_version, region_id, bucket, opts = {}) ⇒ Array<(GetObjectStorageBucket200Response, Integer, Hash)>

Get an Object Storage bucket Returns a single Object Storage bucket. &gt; 📘 &gt; &gt; The [S3 API](docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) equivalent operation offers more detail. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 275

def get_object_storage_bucket_with_http_info(api_version, region_id, bucket, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.get_object_storage_bucket ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.get_object_storage_bucket"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling ObjectStorageApi.get_object_storage_bucket"
  end
  # verify the required parameter 'bucket' is set
  if @api_client.config.client_side_validation && bucket.nil?
    fail ArgumentError, "Missing the required parameter 'bucket' when calling ObjectStorageApi.get_object_storage_bucket"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/buckets/{regionId}/{bucket}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'regionId' + '}', CGI.escape(region_id.to_s)).sub('{' + 'bucket' + '}', CGI.escape(bucket.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetObjectStorageBucket200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.get_object_storage_bucket",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#get_object_storage_bucket\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_object_storage_bucketin_cluster(api_version, region_id, opts = {}) ⇒ GetObjectStorageBucketinCluster200Response

List Object Storage buckets per region Returns a list of buckets on your account, in the specified region. > 📘 > > The [S3 API](docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) equivalent operation offers more detail. <<LB>> — - __OAuth scopes__. “‘ object_storage:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



529
530
531
532
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 529

def get_object_storage_bucketin_cluster(api_version, region_id, opts = {})
  data, _status_code, _headers = get_object_storage_bucketin_cluster_with_http_info(api_version, region_id, opts)
  data
end

#get_object_storage_bucketin_cluster_with_http_info(api_version, region_id, opts = {}) ⇒ Array<(GetObjectStorageBucketinCluster200Response, Integer, Hash)>

List Object Storage buckets per region Returns a list of buckets on your account, in the specified region. &gt; 📘 &gt; &gt; The [S3 API](docs.ceph.com/en/latest/radosgw/s3/bucketops/#get-bucket) equivalent operation offers more detail. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 540

def get_object_storage_bucketin_cluster_with_http_info(api_version, region_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.get_object_storage_bucketin_cluster ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.get_object_storage_bucketin_cluster"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling ObjectStorageApi.get_object_storage_bucketin_cluster"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/buckets/{regionId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'regionId' + '}', CGI.escape(region_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetObjectStorageBucketinCluster200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.get_object_storage_bucketin_cluster",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#get_object_storage_bucketin_cluster\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_object_storage_buckets(api_version, opts = {}) ⇒ GetObjectStorageBuckets200Response

List Object Storage buckets Returns a paginated list of all Object Storage buckets available in your account. > 📘 > > The [S3 API](docs.ceph.com/en/latest/radosgw/s3/serviceops/#list-buckets) equivalent operation offers more detail. <<LB>> — - __OAuth scopes__. “‘ object_storage:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



602
603
604
605
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 602

def get_object_storage_buckets(api_version, opts = {})
  data, _status_code, _headers = get_object_storage_buckets_with_http_info(api_version, opts)
  data
end

#get_object_storage_buckets_with_http_info(api_version, opts = {}) ⇒ Array<(GetObjectStorageBuckets200Response, Integer, Hash)>

List Object Storage buckets Returns a paginated list of all Object Storage buckets available in your account. &gt; 📘 &gt; &gt; The [S3 API](docs.ceph.com/en/latest/radosgw/s3/serviceops/#list-buckets) equivalent operation offers more detail. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 612

def get_object_storage_buckets_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.get_object_storage_buckets ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.get_object_storage_buckets"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/buckets'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetObjectStorageBuckets200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.get_object_storage_buckets",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#get_object_storage_buckets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_object_storage_cluster(api_version, cluster_id, opts = {}) ⇒ GetObjectStorageCluster200Response

Get a cluster __Deprecated__ Returns a single Object Storage cluster. > 📘 > > This displays deprecated ‘clusterId` values that represent regions used with older versions of the API. It’s maintained for backward compatibility. Run [Get a region](techdocs.akamai.com/linode-api/reference/get-region), instead. <<LB>> — - __CLI__. “‘ linode-cli object-storage clusters-view us-east-1 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • cluster_id (String) —

    Identifies a cluster where this bucket lives. For backward compatibility with Object Storage in this API. &gt; 📘 &gt; &gt; You can use the applicable &#x60;regionId&#x60;, for example &#x60;us-west&#x60;, in place of the &#x60;clusterId&#x60;, for example, &#x60;us-west-1&#x60;. Run [List regions](techdocs.akamai.com/linode-api/reference/get-regions) to see all regions.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



671
672
673
674
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 671

def get_object_storage_cluster(api_version, cluster_id, opts = {})
  data, _status_code, _headers = get_object_storage_cluster_with_http_info(api_version, cluster_id, opts)
  data
end

#get_object_storage_cluster_with_http_info(api_version, cluster_id, opts = {}) ⇒ Array<(GetObjectStorageCluster200Response, Integer, Hash)>

Get a cluster __Deprecated__ Returns a single Object Storage cluster. &gt; 📘 &gt; &gt; This displays deprecated &#x60;clusterId&#x60; values that represent regions used with older versions of the API. It&#39;s maintained for backward compatibility. Run [Get a region](techdocs.akamai.com/linode-api/reference/get-region), instead. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli object-storage clusters-view us-east-1 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • cluster_id (String) —

    Identifies a cluster where this bucket lives. For backward compatibility with Object Storage in this API. &gt; 📘 &gt; &gt; You can use the applicable &#x60;regionId&#x60;, for example &#x60;us-west&#x60;, in place of the &#x60;clusterId&#x60;, for example, &#x60;us-west-1&#x60;. Run [List regions](techdocs.akamai.com/linode-api/reference/get-regions) to see all regions.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 682

def get_object_storage_cluster_with_http_info(api_version, cluster_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.get_object_storage_cluster ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.get_object_storage_cluster"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'cluster_id' is set
  if @api_client.config.client_side_validation && cluster_id.nil?
    fail ArgumentError, "Missing the required parameter 'cluster_id' when calling ObjectStorageApi.get_object_storage_cluster"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/clusters/{clusterId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'clusterId' + '}', CGI.escape(cluster_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetObjectStorageCluster200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.get_object_storage_cluster",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#get_object_storage_cluster\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_object_storage_clusters(api_version, opts = {}) ⇒ GetObjectStorageClusters200Response

List clusters Returns a paginated list of available Object Storage legacy clusters. > 📘 > > This displays deprecated ‘clusterId` values that represent regions used with older versions of the API. It’s maintained for backward compatibility. Run [Get a region](techdocs.akamai.com/linode-api/reference/get-region), instead. <<LB>> — - __CLI__. “‘ linode-cli object-storage clusters-list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



744
745
746
747
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 744

def get_object_storage_clusters(api_version, opts = {})
  data, _status_code, _headers = get_object_storage_clusters_with_http_info(api_version, opts)
  data
end

#get_object_storage_clusters_with_http_info(api_version, opts = {}) ⇒ Array<(GetObjectStorageClusters200Response, Integer, Hash)>

List clusters Returns a paginated list of available Object Storage legacy clusters. &gt; 📘 &gt; &gt; This displays deprecated &#x60;clusterId&#x60; values that represent regions used with older versions of the API. It&#39;s maintained for backward compatibility. Run [Get a region](techdocs.akamai.com/linode-api/reference/get-region), instead. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli object-storage clusters-list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 754

def get_object_storage_clusters_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.get_object_storage_clusters ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.get_object_storage_clusters"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/clusters'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetObjectStorageClusters200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.get_object_storage_clusters",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#get_object_storage_clusters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_object_storage_key(api_version, key_id, opts = {}) ⇒ GetObjectStorageKey200Response

Get an Object Storage key Returns a single Object Storage key provisioned for your account. <<LB>> — - __CLI__. “‘ linode-cli object-storage keys-view \ –keyId 12345 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` object_storage:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • key_id (Integer) —

    The key to look up.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



813
814
815
816
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 813

def get_object_storage_key(api_version, key_id, opts = {})
  data, _status_code, _headers = get_object_storage_key_with_http_info(api_version, key_id, opts)
  data
end

#get_object_storage_key_with_http_info(api_version, key_id, opts = {}) ⇒ Array<(GetObjectStorageKey200Response, Integer, Hash)>

Get an Object Storage key Returns a single Object Storage key provisioned for your account. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli object-storage keys-view \ –keyId 12345 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • key_id (Integer) —

    The key to look up.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 824

def get_object_storage_key_with_http_info(api_version, key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.get_object_storage_key ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.get_object_storage_key"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling ObjectStorageApi.get_object_storage_key"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/keys/{keyId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'keyId' + '}', CGI.escape(key_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetObjectStorageKey200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.get_object_storage_key",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#get_object_storage_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_object_storage_keys(api_version, opts = {}) ⇒ GetObjectStorageKeys200Response

List Object Storage keys Returns a paginated list of Object Storage keys for authenticating to the Object Storage S3 API. <<LB>> — - __CLI__. “‘ linode-cli object-storage keys-list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` object_storage:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



886
887
888
889
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 886

def get_object_storage_keys(api_version, opts = {})
  data, _status_code, _headers = get_object_storage_keys_with_http_info(api_version, opts)
  data
end

#get_object_storage_keys_with_http_info(api_version, opts = {}) ⇒ Array<(GetObjectStorageKeys200Response, Integer, Hash)>

List Object Storage keys Returns a paginated list of Object Storage keys for authenticating to the Object Storage S3 API. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli object-storage keys-list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 896

def get_object_storage_keys_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.get_object_storage_keys ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.get_object_storage_keys"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/keys'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetObjectStorageKeys200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.get_object_storage_keys",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#get_object_storage_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_object_storage_ssl(api_version, region_id, bucket, opts = {}) ⇒ GetObjectStorageSsl200Response

Get an Object Storage TLS/SSL certificate Returns a boolean value indicating if this bucket has a corresponding TLS/SSL certificate that was uploaded by an Account user. <<LB>> — - __CLI__. “‘ linode-cli object-storage ssl-view \ us-east-1 example-bucket “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` object_storage:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



956
957
958
959
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 956

def get_object_storage_ssl(api_version, region_id, bucket, opts = {})
  data, _status_code, _headers = get_object_storage_ssl_with_http_info(api_version, region_id, bucket, opts)
  data
end

#get_object_storage_ssl_with_http_info(api_version, region_id, bucket, opts = {}) ⇒ Array<(GetObjectStorageSsl200Response, Integer, Hash)>

Get an Object Storage TLS/SSL certificate Returns a boolean value indicating if this bucket has a corresponding TLS/SSL certificate that was uploaded by an Account user. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli object-storage ssl-view \ us-east-1 example-bucket &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 968

def get_object_storage_ssl_with_http_info(api_version, region_id, bucket, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.get_object_storage_ssl ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.get_object_storage_ssl"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling ObjectStorageApi.get_object_storage_ssl"
  end
  # verify the required parameter 'bucket' is set
  if @api_client.config.client_side_validation && bucket.nil?
    fail ArgumentError, "Missing the required parameter 'bucket' when calling ObjectStorageApi.get_object_storage_ssl"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/buckets/{regionId}/{bucket}/ssl'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'regionId' + '}', CGI.escape(region_id.to_s)).sub('{' + 'bucket' + '}', CGI.escape(bucket.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetObjectStorageSsl200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.get_object_storage_ssl",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#get_object_storage_ssl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_object_storage_transfer(api_version, opts = {}) ⇒ GetObjectStorageTransfer200Response

Get Object Storage transfer data The amount of outbound data transfer used by your account’s Object Storage buckets. Object Storage adds 1 terabyte of outbound data transfer to your data transfer pool. See the [Object Storage Overview](www.linode.com/docs/products/storage/object-storage/#pricing) guide for details on Object Storage transfer quotas. <<LB>> — - __OAuth scopes__. “‘ object_storage:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1034
1035
1036
1037
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1034

def get_object_storage_transfer(api_version, opts = {})
  data, _status_code, _headers = get_object_storage_transfer_with_http_info(api_version, opts)
  data
end

#get_object_storage_transfer_with_http_info(api_version, opts = {}) ⇒ Array<(GetObjectStorageTransfer200Response, Integer, Hash)>

Get Object Storage transfer data The amount of outbound data transfer used by your account&#39;s Object Storage buckets. Object Storage adds 1 terabyte of outbound data transfer to your data transfer pool. See the [Object Storage Overview](www.linode.com/docs/products/storage/object-storage/#pricing) guide for details on Object Storage transfer quotas. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1044

def get_object_storage_transfer_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.get_object_storage_transfer ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.get_object_storage_transfer"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/transfer'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetObjectStorageTransfer200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.get_object_storage_transfer",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#get_object_storage_transfer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_cancel_object_storage(api_version, opts = {}) ⇒ Object

Cancel Object Storage Cancel Object Storage on an Account. __Warning__. This removes all buckets and their contents from your Account. This data is irretrievable once removed. <<LB>> — - __CLI__. “‘ linode-cli object-storage cancel “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` object_storage:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


1102
1103
1104
1105
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1102

def post_cancel_object_storage(api_version, opts = {})
  data, _status_code, _headers = post_cancel_object_storage_with_http_info(api_version, opts)
  data
end

#post_cancel_object_storage_with_http_info(api_version, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Cancel Object Storage Cancel Object Storage on an Account. __Warning__. This removes all buckets and their contents from your Account. This data is irretrievable once removed. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli object-storage cancel &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1112

def post_cancel_object_storage_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.post_cancel_object_storage ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.post_cancel_object_storage"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/cancel'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.post_cancel_object_storage",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#post_cancel_object_storage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_object_storage_bucket(api_version, opts = {}) ⇒ PostObjectStorageBucket200Response

Create an Object Storage bucket Creates an Object Storage bucket in the specified data center ([region](techdocs.akamai.com/linode-api/reference/get-regions)). If the bucket already exists on your account, this operation returns a 200 response with that bucket as if the API just created it. > 📘 > > - Accounts with negative balances can’t access this operation. > > - The [S3 API](docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket) equivalent operation offers more detail. > > - The API still supports the ‘clusterId` equivalent (`us-west-1`) when setting a `region` for a new bucket, but you should use the `regionId` (`us-west`), instead. <<LB>> — - __OAuth scopes__. “` object_storage:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1171
1172
1173
1174
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1171

def post_object_storage_bucket(api_version, opts = {})
  data, _status_code, _headers = post_object_storage_bucket_with_http_info(api_version, opts)
  data
end

#post_object_storage_bucket_access(api_version, region_id, bucket, opts = {}) ⇒ Object

Modify access to an Object Storage bucket Apply basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings. You can configure CORS for all origins and set canned ACL settings. > 📘 > > For more fine-grained control of both systems, use the [S3 API](docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket-acl). <<LB>> — - __OAuth scopes__. “‘ object_storage:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


1248
1249
1250
1251
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1248

def post_object_storage_bucket_access(api_version, region_id, bucket, opts = {})
  data, _status_code, _headers = post_object_storage_bucket_access_with_http_info(api_version, region_id, bucket, opts)
  data
end

#post_object_storage_bucket_access_with_http_info(api_version, region_id, bucket, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Modify access to an Object Storage bucket Apply basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings. You can configure CORS for all origins and set canned ACL settings. &gt; 📘 &gt; &gt; For more fine-grained control of both systems, use the [S3 API](docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket-acl). &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1261

def post_object_storage_bucket_access_with_http_info(api_version, region_id, bucket, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.post_object_storage_bucket_access ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.post_object_storage_bucket_access"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling ObjectStorageApi.post_object_storage_bucket_access"
  end
  # verify the required parameter 'bucket' is set
  if @api_client.config.client_side_validation && bucket.nil?
    fail ArgumentError, "Missing the required parameter 'bucket' when calling ObjectStorageApi.post_object_storage_bucket_access"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/buckets/{regionId}/{bucket}/access'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'regionId' + '}', CGI.escape(region_id.to_s)).sub('{' + 'bucket' + '}', CGI.escape(bucket.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'post_object_storage_bucket_access_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.post_object_storage_bucket_access",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#post_object_storage_bucket_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_object_storage_bucket_with_http_info(api_version, opts = {}) ⇒ Array<(PostObjectStorageBucket200Response, Integer, Hash)>

Create an Object Storage bucket Creates an Object Storage bucket in the specified data center ([region](techdocs.akamai.com/linode-api/reference/get-regions)). If the bucket already exists on your account, this operation returns a 200 response with that bucket as if the API just created it. &gt; 📘 &gt; &gt; - Accounts with negative balances can&#39;t access this operation. &gt; &gt; - The [S3 API](docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket) equivalent operation offers more detail. &gt; &gt; - The API still supports the &#x60;clusterId&#x60; equivalent (&#x60;us-west-1&#x60;) when setting a &#x60;region&#x60; for a new bucket, but you should use the &#x60;regionId&#x60; (&#x60;us-west&#x60;), instead. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1182

def post_object_storage_bucket_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.post_object_storage_bucket ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.post_object_storage_bucket"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/buckets'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'post_object_storage_bucket_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'PostObjectStorageBucket200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.post_object_storage_bucket",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#post_object_storage_bucket\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_object_storage_keys(api_version, opts = {}) ⇒ PostObjectStorageKeys200Response

Create an Object Storage key Provisions a new Object Storage key for authenticating to the Object Storage S3 API. A successful request triggers an ‘obj_access_key_create` [event](techdocs.akamai.com/linode-api/reference/get-events). > 📘 > > Accounts with negative balances can’t access this operation. **The ‘regions` and `region` parameters** When creating an Object Storage key, specify one or more data centers ([regions](techdocs.akamai.com/linode-api/reference/get-regions)) where you want to create and manage Object Storage buckets. - **The `regions` array**. Populate it with `regionId` values. The resulting Object Storage key grants access to list and create new buckets in these regions. This *doesn’t* give access to manage content in these buckets. To address this, you can: - Use the ‘bucket_access` array instead to grant management access, per bucket. - Use [bucket policies](www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/) to change the access for this key. - **The `bucket_access` array**. This optional array lets you set up limited keys. Include individual objects naming a `regionId`, the target `bucket_name`, and the `permissions` for the Object Storage key. Use the resulting key to manage content in the `bucket_name`, based on the permission level set. You can also use the key to create new buckets in the named region. However, the key doesn’t have access to manage content in the newly created bucket. You can grant it this access using [bucket policies](www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/). - **Combine the two to apply varying levels of access in the key**. For example, set ‘regions` to `us-west` to give the key bucket list and create access in that region. Then, set up the `bucket_access` array to give access to a specific `bucket_name` in the `us-east` region. The key has access to manage content in that `bucket_name` and list and create buckets in the `us-east` region, too. If you include the same region in both, the settings applied in the `bucket_access` array take precedence. For example, assume you include `us-east` in the `regions` array, expecting to only give bucket list and creation access to that region. If you also set `us-east` as a `region` in the `bucket_access` array, the Object Storage key gives access to manage content in the specified `bucket_name`, and lets you list and create buckets in that region. **The `cluster` parameter (legacy)** For backward compatibility, include the `cluster` parameter to create an Object Storage key. Use the `clusterId` equivalent (us-west-1) instead of the `regionId` (us-west). Leave the `regions` array out. If including the `bucket_access` array to limit access, omit `region` from each object. Use the resulting key in clusters in all supported regions. > 📘 > > While the API supports this method, you should use the `regions` parameters, instead. - **Unlimited access**. Omit the `bucket_access` array. The Object Storage key has unlimited cluster access to all buckets, with all permissions. - **Limited access**. Include the `bucket_access` array. Set the target `bucket_name` and the level of `permissions` for access to that bucket. Use the resulting key to manage content in the named bucket. A limited Object Storage key can [list all buckets](techdocs.akamai.com/linode-api/reference/get-object-storage-buckets) and [create a new bucket](techdocs.akamai.com/linode-api/reference/post-object-storage-bucket). However, you can’t use the key to perform any actions on a bucket, unless the key has access to it. You can use [bucket policies](www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/) to modify a key’s access. <<LB>> — - __CLI__. “‘ linode-cli object-storage keys-create \ –label "my-object-storage-key" \ –bucket_access ’[{"region": "ap-south", "bucket_name": "bucket-example-1", "permissions": "read_write" }]‘ “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` object_storage:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1333
1334
1335
1336
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1333

def post_object_storage_keys(api_version, opts = {})
  data, _status_code, _headers = post_object_storage_keys_with_http_info(api_version, opts)
  data
end

#post_object_storage_keys_with_http_info(api_version, opts = {}) ⇒ Array<(PostObjectStorageKeys200Response, Integer, Hash)>

Create an Object Storage key Provisions a new Object Storage key for authenticating to the Object Storage S3 API. A successful request triggers an &#x60;obj_access_key_create&#x60; [event](techdocs.akamai.com/linode-api/reference/get-events). &gt; 📘 &gt; &gt; Accounts with negative balances can&#39;t access this operation. **The &#x60;regions&#x60; and &#x60;region&#x60; parameters** When creating an Object Storage key, specify one or more data centers ([regions](techdocs.akamai.com/linode-api/reference/get-regions)) where you want to create and manage Object Storage buckets. - **The &#x60;regions&#x60; array**. Populate it with &#x60;regionId&#x60; values. The resulting Object Storage key grants access to list and create new buckets in these regions. This *doesn&#39;t* give access to manage content in these buckets. To address this, you can: - Use the &#x60;bucket_access&#x60; array instead to grant management access, per bucket. - Use [bucket policies](www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/) to change the access for this key. - **The &#x60;bucket_access&#x60; array**. This optional array lets you set up limited keys. Include individual objects naming a &#x60;regionId&#x60;, the target &#x60;bucket_name&#x60;, and the &#x60;permissions&#x60; for the Object Storage key. Use the resulting key to manage content in the &#x60;bucket_name&#x60;, based on the permission level set. You can also use the key to create new buckets in the named region. However, the key doesn&#39;t have access to manage content in the newly created bucket. You can grant it this access using [bucket policies](www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/). - **Combine the two to apply varying levels of access in the key**. For example, set &#x60;regions&#x60; to &#x60;us-west&#x60; to give the key bucket list and create access in that region. Then, set up the &#x60;bucket_access&#x60; array to give access to a specific &#x60;bucket_name&#x60; in the &#x60;us-east&#x60; region. The key has access to manage content in that &#x60;bucket_name&#x60; and list and create buckets in the &#x60;us-east&#x60; region, too. If you include the same region in both, the settings applied in the &#x60;bucket_access&#x60; array take precedence. For example, assume you include &#x60;us-east&#x60; in the &#x60;regions&#x60; array, expecting to only give bucket list and creation access to that region. If you also set &#x60;us-east&#x60; as a &#x60;region&#x60; in the &#x60;bucket_access&#x60; array, the Object Storage key gives access to manage content in the specified &#x60;bucket_name&#x60;, and lets you list and create buckets in that region. **The &#x60;cluster&#x60; parameter (legacy)** For backward compatibility, include the &#x60;cluster&#x60; parameter to create an Object Storage key. Use the &#x60;clusterId&#x60; equivalent (us-west-1) instead of the &#x60;regionId&#x60; (us-west). Leave the &#x60;regions&#x60; array out. If including the &#x60;bucket_access&#x60; array to limit access, omit &#x60;region&#x60; from each object. Use the resulting key in clusters in all supported regions. &gt; 📘 &gt; &gt; While the API supports this method, you should use the &#x60;regions&#x60; parameters, instead. - **Unlimited access**. Omit the &#x60;bucket_access&#x60; array. The Object Storage key has unlimited cluster access to all buckets, with all permissions. - **Limited access**. Include the &#x60;bucket_access&#x60; array. Set the target &#x60;bucket_name&#x60; and the level of &#x60;permissions&#x60; for access to that bucket. Use the resulting key to manage content in the named bucket. A limited Object Storage key can [list all buckets](techdocs.akamai.com/linode-api/reference/get-object-storage-buckets) and [create a new bucket](techdocs.akamai.com/linode-api/reference/post-object-storage-bucket). However, you can&#39;t use the key to perform any actions on a bucket, unless the key has access to it. You can use [bucket policies](www.linode.com/docs/products/storage/object-storage/guides/bucket-policies/) to modify a key&#39;s access. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli object-storage keys-create \ –label &quot;my-object-storage-key&quot; \ –bucket_access &#39;[{&quot;region&quot;: &quot;ap-south&quot;, &quot;bucket_name&quot;: &quot;bucket-example-1&quot;, &quot;permissions&quot;: &quot;read_write&quot; }]&#39; &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1344

def post_object_storage_keys_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.post_object_storage_keys ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.post_object_storage_keys"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/keys'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'post_object_storage_keys_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'PostObjectStorageKeys200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.post_object_storage_keys",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#post_object_storage_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_object_storage_object_url(api_version, region_id, bucket, opts = {}) ⇒ PostObjectStorageObjectUrl200Response

Create a URL for an object Creates a pre-signed URL to access a single object in a bucket. Use it to share, create, or delete objects by using the appropriate HTTP method in your request body’s ‘method` parameter. > 📘 > > The [S3 API](docs.ceph.com/en/latest/radosgw/s3/) equivalent operation offers more detail. <<LB>> — - __OAuth scopes__. “` object_storage:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1410
1411
1412
1413
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1410

def post_object_storage_object_url(api_version, region_id, bucket, opts = {})
  data, _status_code, _headers = post_object_storage_object_url_with_http_info(api_version, region_id, bucket, opts)
  data
end

#post_object_storage_object_url_with_http_info(api_version, region_id, bucket, opts = {}) ⇒ Array<(PostObjectStorageObjectUrl200Response, Integer, Hash)>

Create a URL for an object Creates a pre-signed URL to access a single object in a bucket. Use it to share, create, or delete objects by using the appropriate HTTP method in your request body&#39;s &#x60;method&#x60; parameter. &gt; 📘 &gt; &gt; The [S3 API](docs.ceph.com/en/latest/radosgw/s3/) equivalent operation offers more detail. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1423

def post_object_storage_object_url_with_http_info(api_version, region_id, bucket, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.post_object_storage_object_url ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.post_object_storage_object_url"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling ObjectStorageApi.post_object_storage_object_url"
  end
  # verify the required parameter 'bucket' is set
  if @api_client.config.client_side_validation && bucket.nil?
    fail ArgumentError, "Missing the required parameter 'bucket' when calling ObjectStorageApi.post_object_storage_object_url"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/buckets/{regionId}/{bucket}/object-url'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'regionId' + '}', CGI.escape(region_id.to_s)).sub('{' + 'bucket' + '}', CGI.escape(bucket.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'post_object_storage_object_url_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'PostObjectStorageObjectUrl200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.post_object_storage_object_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#post_object_storage_object_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_object_storage_ssl(api_version, region_id, bucket, opts = {}) ⇒ GetObjectStorageSsl200Response

Upload an Object Storage TLS/SSL certificate Upload a TLS/SSL certificate and private key to be served when you visit your Object Storage bucket via HTTPS. Your TLS/SSL certificate and private key are stored encrypted at rest. To replace an expired certificate, [delete your current certificates](techdocs.akamai.com/linode-api/reference/delete-object-storage-ssl) and upload a new one. <<LB>> — - __CLI__. “‘ linode-cli object-storage ssl-upload \ us-east-1 example-bucket \ –certificate "—–BEGIN CERTIFICATE—– CERTIFICATE_INFORMATION —–END CERTIFICATE—–" \ –private_key "—–BEGIN PRIVATE KEY—– PRIVATE_KEY_INFORMATION —–END PRIVATE KEY—–" “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` object_storage:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :post_object_storage_ssl_request (PostObjectStorageSslRequest) —

    Upload this TLS/SSL certificate with its corresponding secret key.

Returns:



1497
1498
1499
1500
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1497

def post_object_storage_ssl(api_version, region_id, bucket, opts = {})
  data, _status_code, _headers = post_object_storage_ssl_with_http_info(api_version, region_id, bucket, opts)
  data
end

#post_object_storage_ssl_with_http_info(api_version, region_id, bucket, opts = {}) ⇒ Array<(GetObjectStorageSsl200Response, Integer, Hash)>

Upload an Object Storage TLS/SSL certificate Upload a TLS/SSL certificate and private key to be served when you visit your Object Storage bucket via HTTPS. Your TLS/SSL certificate and private key are stored encrypted at rest. To replace an expired certificate, [delete your current certificates](techdocs.akamai.com/linode-api/reference/delete-object-storage-ssl) and upload a new one. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli object-storage ssl-upload \ us-east-1 example-bucket \ –certificate &quot;—–BEGIN CERTIFICATE—– CERTIFICATE_INFORMATION —–END CERTIFICATE—–&quot; \ –private_key &quot;—–BEGIN PRIVATE KEY—– PRIVATE_KEY_INFORMATION —–END PRIVATE KEY—–&quot; &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :post_object_storage_ssl_request (PostObjectStorageSslRequest) —

    Upload this TLS/SSL certificate with its corresponding secret key.

Returns:



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1510

def post_object_storage_ssl_with_http_info(api_version, region_id, bucket, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.post_object_storage_ssl ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.post_object_storage_ssl"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling ObjectStorageApi.post_object_storage_ssl"
  end
  # verify the required parameter 'bucket' is set
  if @api_client.config.client_side_validation && bucket.nil?
    fail ArgumentError, "Missing the required parameter 'bucket' when calling ObjectStorageApi.post_object_storage_ssl"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/buckets/{regionId}/{bucket}/ssl'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'regionId' + '}', CGI.escape(region_id.to_s)).sub('{' + 'bucket' + '}', CGI.escape(bucket.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'post_object_storage_ssl_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'GetObjectStorageSsl200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.post_object_storage_ssl",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#post_object_storage_ssl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_object_storage_bucket_acl(api_version, region_id, bucket, opts = {}) ⇒ PutObjectStorageBucketAcl200Response

Update an object’s ACL config Update an object’s configured access control level (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. > 📘 > > The [S3 API](docs.ceph.com/en/latest/radosgw/s3/objectops/#set-object-acl) equivalent operation offers more detail. <<LB>> — - __OAuth scopes__. “‘ object_storage:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1584
1585
1586
1587
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1584

def put_object_storage_bucket_acl(api_version, region_id, bucket, opts = {})
  data, _status_code, _headers = put_object_storage_bucket_acl_with_http_info(api_version, region_id, bucket, opts)
  data
end

#put_object_storage_bucket_acl_with_http_info(api_version, region_id, bucket, opts = {}) ⇒ Array<(PutObjectStorageBucketAcl200Response, Integer, Hash)>

Update an object&#39;s ACL config Update an object&#39;s configured access control level (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. &gt; 📘 &gt; &gt; The [S3 API](docs.ceph.com/en/latest/radosgw/s3/objectops/#set-object-acl) equivalent operation offers more detail. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1597

def put_object_storage_bucket_acl_with_http_info(api_version, region_id, bucket, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.put_object_storage_bucket_acl ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.put_object_storage_bucket_acl"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling ObjectStorageApi.put_object_storage_bucket_acl"
  end
  # verify the required parameter 'bucket' is set
  if @api_client.config.client_side_validation && bucket.nil?
    fail ArgumentError, "Missing the required parameter 'bucket' when calling ObjectStorageApi.put_object_storage_bucket_acl"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/buckets/{regionId}/{bucket}/object-acl'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'regionId' + '}', CGI.escape(region_id.to_s)).sub('{' + 'bucket' + '}', CGI.escape(bucket.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'put_object_storage_bucket_acl_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'PutObjectStorageBucketAcl200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.put_object_storage_bucket_acl",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#put_object_storage_bucket_acl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_object_storage_key(api_version, key_id, opts = {}) ⇒ PutObjectStorageKey200Response

Update an Object Storage key Updates an Object Storage key on your account. A successful request triggers an ‘obj_access_key_update` [event](techdocs.akamai.com/linode-api/reference/get-events). <<LB>> — - __CLI__. “` linode-cli object-storage keys-update \ –keyId 12345 –label "my-object-storage-key" “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` object_storage:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • key_id (Integer) —

    The key to look up.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1670
1671
1672
1673
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1670

def put_object_storage_key(api_version, key_id, opts = {})
  data, _status_code, _headers = put_object_storage_key_with_http_info(api_version, key_id, opts)
  data
end

#put_object_storage_key_with_http_info(api_version, key_id, opts = {}) ⇒ Array<(PutObjectStorageKey200Response, Integer, Hash)>

Update an Object Storage key Updates an Object Storage key on your account. A successful request triggers an &#x60;obj_access_key_update&#x60; [event](techdocs.akamai.com/linode-api/reference/get-events). &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli object-storage keys-update \ –keyId 12345 –label &quot;my-object-storage-key&quot; &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • key_id (Integer) —

    The key to look up.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1682

def put_object_storage_key_with_http_info(api_version, key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.put_object_storage_key ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.put_object_storage_key"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling ObjectStorageApi.put_object_storage_key"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/keys/{keyId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'keyId' + '}', CGI.escape(key_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'put_object_storage_key_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'PutObjectStorageKey200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.put_object_storage_key",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#put_object_storage_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_storage_bucket_access(api_version, region_id, bucket, opts = {}) ⇒ Object

Update access to an Object Storage bucket Update basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings. You can configure CORS for all origins and set canned ACL settings. > 📘 > > For more fine-grained control of both systems, use the [S3 API](docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket-acl). <<LB>> — - __OAuth scopes__. “‘ object_storage:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


1752
1753
1754
1755
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1752

def put_storage_bucket_access(api_version, region_id, bucket, opts = {})
  data, _status_code, _headers = put_storage_bucket_access_with_http_info(api_version, region_id, bucket, opts)
  data
end

#put_storage_bucket_access_with_http_info(api_version, region_id, bucket, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Update access to an Object Storage bucket Update basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings. You can configure CORS for all origins and set canned ACL settings. &gt; 📘 &gt; &gt; For more fine-grained control of both systems, use the [S3 API](docs.ceph.com/en/latest/radosgw/s3/bucketops/#put-bucket-acl). &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; object_storage:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • region_id (String) —

    Identifies a region where this bucket lives. &gt; 📘 &gt; &gt; You can use a &#x60;clusterId&#x60; in place of &#x60;regionId&#x60; in requests for buckets that you created using the legacy version of the API. Run [List clusters](techdocs.akamai.com/linode-api/reference/get-object-storage-clusters) to see each cluster &#x60;id&#x60;.

  • bucket (String) —

    The bucket name.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
 
# File 'lib/linode_openapi_client/api/object_storage_api.rb', line 1765

def put_storage_bucket_access_with_http_info(api_version, region_id, bucket, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ObjectStorageApi.put_storage_bucket_access ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling ObjectStorageApi.put_storage_bucket_access"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling ObjectStorageApi.put_storage_bucket_access"
  end
  # verify the required parameter 'bucket' is set
  if @api_client.config.client_side_validation && bucket.nil?
    fail ArgumentError, "Missing the required parameter 'bucket' when calling ObjectStorageApi.put_storage_bucket_access"
  end
  # resource path
  local_var_path = '/{apiVersion}/object-storage/buckets/{regionId}/{bucket}/access'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'regionId' + '}', CGI.escape(region_id.to_s)).sub('{' + 'bucket' + '}', CGI.escape(bucket.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'put_storage_bucket_access_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

  new_options = opts.merge(
    :operation => :"ObjectStorageApi.put_storage_bucket_access",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ObjectStorageApi#put_storage_bucket_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end