Class: LinodeOpenapiClient::DatabasesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DatabasesApi

Returns a new instance of DatabasesApi.



19
20
21
 
# File 'lib/linode_openapi_client/api/databases_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/databases_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_database_mysql_instance_backup(api_version, instance_id, backup_id, opts = {}) ⇒ Object

Delete a managed MySQL database backup __This operation is currently only available for customers who already have an active Managed Database.__ Delete a single backup for an accessible Managed MySQL Database. Requires ‘read_write` access to the Database. The Database must not be provisioning to perform this operation. <<LB>> — - __CLI__. “` linode-cli databases mysql-backup-delete 123 456 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

  • backup_id (Integer) —

    The ID of the Managed MySQL Database backup.

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

    the optional parameters

Returns:

  • (Object) 


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

def delete_database_mysql_instance_backup(api_version, instance_id, backup_id, opts = {})
  data, _status_code, _headers = delete_database_mysql_instance_backup_with_http_info(api_version, instance_id, backup_id, opts)
  data
end

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

Delete a managed MySQL database backup __This operation is currently only available for customers who already have an active Managed Database.__ Delete a single backup for an accessible Managed MySQL Database. Requires &#x60;read_write&#x60; access to the Database. The Database must not be provisioning to perform this operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases mysql-backup-delete 123 456 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

  • backup_id (Integer) —

    The ID of the Managed MySQL Database backup.

  • 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/databases_api.rb', line 41

def delete_database_mysql_instance_backup_with_http_info(api_version, instance_id, backup_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.delete_database_mysql_instance_backup ...'
  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 DatabasesApi.delete_database_mysql_instance_backup"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.delete_database_mysql_instance_backup"
  end
  # verify the required parameter 'backup_id' is set
  if @api_client.config.client_side_validation && backup_id.nil?
    fail ArgumentError, "Missing the required parameter 'backup_id' when calling DatabasesApi.delete_database_mysql_instance_backup"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/mysql/instances/{instanceId}/backups/{backupId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_id.to_s)).sub('{' + 'backupId' + '}', CGI.escape(backup_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 => :"DatabasesApi.delete_database_mysql_instance_backup",
    :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: DatabasesApi#delete_database_mysql_instance_backup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_database_postgre_sql_instance_backup(api_version, instance_id, backup_id, opts = {}) ⇒ Object

Delete a managed PostgreSQL database backup __This operation is currently only available for customers who already have an active Managed Database.__ Delete a single backup for an accessible Managed PostgreSQL Database. Requires ‘read_write` access to the Database. The Database must not be provisioning to perform this operation. <<LB>> — - __CLI__. “` linode-cli databases postgresql-backup-delete 123 456 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

  • backup_id (Integer) —

    The ID of the Managed PostgreSQL Database backup.

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

    the optional parameters

Returns:

  • (Object) 


109
110
111
112
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 109

def delete_database_postgre_sql_instance_backup(api_version, instance_id, backup_id, opts = {})
  data, _status_code, _headers = delete_database_postgre_sql_instance_backup_with_http_info(api_version, instance_id, backup_id, opts)
  data
end

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

Delete a managed PostgreSQL database backup __This operation is currently only available for customers who already have an active Managed Database.__ Delete a single backup for an accessible Managed PostgreSQL Database. Requires &#x60;read_write&#x60; access to the Database. The Database must not be provisioning to perform this operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases postgresql-backup-delete 123 456 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

  • backup_id (Integer) —

    The ID of the Managed PostgreSQL Database backup.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
175
176
177
178
179
180
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 121

def delete_database_postgre_sql_instance_backup_with_http_info(api_version, instance_id, backup_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.delete_database_postgre_sql_instance_backup ...'
  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 DatabasesApi.delete_database_postgre_sql_instance_backup"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.delete_database_postgre_sql_instance_backup"
  end
  # verify the required parameter 'backup_id' is set
  if @api_client.config.client_side_validation && backup_id.nil?
    fail ArgumentError, "Missing the required parameter 'backup_id' when calling DatabasesApi.delete_database_postgre_sql_instance_backup"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/postgresql/instances/{instanceId}/backups/{backupId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_id.to_s)).sub('{' + 'backupId' + '}', CGI.escape(backup_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 => :"DatabasesApi.delete_database_postgre_sql_instance_backup",
    :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: DatabasesApi#delete_database_postgre_sql_instance_backup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_databases_mysql_instance(api_version, instance_id, opts = {}) ⇒ Object

Delete a managed MySQL database __This operation is currently only available for customers who already have an active Managed Database.__ Remove a Managed MySQL Database from your Account. Requires ‘read_write` access to the Database. The Database must have an `active`, `failed`, or `degraded` status to perform this operation. Only unrestricted Users can access this operation, and have access regardless of the acting token’s OAuth scopes. <<LB>> — - __CLI__. “‘ linode-cli databases mysql-delete 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:

  • (Object) 


188
189
190
191
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 188

def delete_databases_mysql_instance(api_version, instance_id, opts = {})
  data, _status_code, _headers = delete_databases_mysql_instance_with_http_info(api_version, instance_id, opts)
  data
end

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

Delete a managed MySQL database __This operation is currently only available for customers who already have an active Managed Database.__ Remove a Managed MySQL Database from your Account. Requires &#x60;read_write&#x60; access to the Database. The Database must have an &#x60;active&#x60;, &#x60;failed&#x60;, or &#x60;degraded&#x60; status to perform this operation. Only unrestricted Users can access this operation, and have access regardless of the acting token&#39;s OAuth scopes. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases mysql-delete 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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/databases_api.rb', line 199

def delete_databases_mysql_instance_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.delete_databases_mysql_instance ...'
  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 DatabasesApi.delete_databases_mysql_instance"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.delete_databases_mysql_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/mysql/instances/{instanceId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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 => :"DatabasesApi.delete_databases_mysql_instance",
    :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: DatabasesApi#delete_databases_mysql_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_databases_postgre_sql_instance(api_version, instance_id, opts = {}) ⇒ Object

Delete a managed PostgreSQL database __This operation is currently only available for customers who already have an active Managed Database.__ Remove a Managed PostgreSQL Database from your Account. Requires ‘read_write` access to the Database. The Database must have an `active`, `failed`, or `degraded` status to perform this operation. Only unrestricted Users can access this operation, and have access regardless of the acting token’s OAuth scopes. <<LB>> — - __CLI__. “‘ linode-cli databases postgresql-delete 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:

  • (Object) 


262
263
264
265
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 262

def delete_databases_postgre_sql_instance(api_version, instance_id, opts = {})
  data, _status_code, _headers = delete_databases_postgre_sql_instance_with_http_info(api_version, instance_id, opts)
  data
end

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

Delete a managed PostgreSQL database __This operation is currently only available for customers who already have an active Managed Database.__ Remove a Managed PostgreSQL Database from your Account. Requires &#x60;read_write&#x60; access to the Database. The Database must have an &#x60;active&#x60;, &#x60;failed&#x60;, or &#x60;degraded&#x60; status to perform this operation. Only unrestricted Users can access this operation, and have access regardless of the acting token&#39;s OAuth scopes. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases postgresql-delete 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



273
274
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
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 273

def delete_databases_postgre_sql_instance_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.delete_databases_postgre_sql_instance ...'
  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 DatabasesApi.delete_databases_postgre_sql_instance"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.delete_databases_postgre_sql_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/postgresql/instances/{instanceId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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 => :"DatabasesApi.delete_databases_postgre_sql_instance",
    :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: DatabasesApi#delete_databases_postgre_sql_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_engine(api_version, engine_id, opts = {}) ⇒ GetDatabasesEngine200Response

Get a managed database engine __This operation is currently only available for customers who already have an active Managed Database.__ Display information for a single Managed Database engine type and version. <<LB>> — - __CLI__. “‘ linode-cli databases engine-view “` [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.

  • engine_id (String) —

    The ID of the Managed Database engine.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



338
339
340
341
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 338

def get_databases_engine(api_version, engine_id, opts = {})
  data, _status_code, _headers = get_databases_engine_with_http_info(api_version, engine_id, opts)
  data
end

#get_databases_engine_with_http_info(api_version, engine_id, opts = {}) ⇒ Array<(GetDatabasesEngine200Response, Integer, Hash)>

Get a managed database engine __This operation is currently only available for customers who already have an active Managed Database.__ Display information for a single Managed Database engine type and version. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases engine-view &#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.

  • engine_id (String) —

    The ID of the Managed Database engine.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



351
352
353
354
355
356
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
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 351

def get_databases_engine_with_http_info(api_version, engine_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_engine ...'
  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 DatabasesApi.get_databases_engine"
  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 'engine_id' is set
  if @api_client.config.client_side_validation && engine_id.nil?
    fail ArgumentError, "Missing the required parameter 'engine_id' when calling DatabasesApi.get_databases_engine"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DatabasesApi.get_databases_engine, must be greater than or equal to 1.'
  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 DatabasesApi.get_databases_engine, 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 DatabasesApi.get_databases_engine, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/databases/engines/{engineId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'engineId' + '}', CGI.escape(engine_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || 'GetDatabasesEngine200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_engine",
    :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: DatabasesApi#get_databases_engine\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_engines(api_version, opts = {}) ⇒ GetDatabasesEngines200Response

List managed database engines __This operation is currently only available for customers who already have an active Managed Database.__ Display all available Managed Database engine types and versions. Engine IDs are used when creating new Managed Databases. <<LB>> — - __CLI__. “‘ linode-cli databases engines “` [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

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



429
430
431
432
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 429

def get_databases_engines(api_version, opts = {})
  data, _status_code, _headers = get_databases_engines_with_http_info(api_version, opts)
  data
end

#get_databases_engines_with_http_info(api_version, opts = {}) ⇒ Array<(GetDatabasesEngines200Response, Integer, Hash)>

List managed database engines __This operation is currently only available for customers who already have an active Managed Database.__ Display all available Managed Database engine types and versions. Engine IDs are used when creating new Managed Databases. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases engines &#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

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



441
442
443
444
445
446
447
448
449
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
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 441

def get_databases_engines_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_engines ...'
  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 DatabasesApi.get_databases_engines"
  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
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DatabasesApi.get_databases_engines, must be greater than or equal to 1.'
  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 DatabasesApi.get_databases_engines, 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 DatabasesApi.get_databases_engines, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/databases/engines'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || 'GetDatabasesEngines200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_engines",
    :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: DatabasesApi#get_databases_engines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_instances(api_version, opts = {}) ⇒ GetDatabasesInstances200Response

List managed databases __This operation is currently only available for customers who already have an active Managed Database.__ Display all Managed Databases that are accessible by your User, regardless of engine type. For more detailed information on a particular Database instance, make a request to its ‘instance_uri`. <<LB>> — - __CLI__. “` linode-cli databases list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



515
516
517
518
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 515

def get_databases_instances(api_version, opts = {})
  data, _status_code, _headers = get_databases_instances_with_http_info(api_version, opts)
  data
end

#get_databases_instances_with_http_info(api_version, opts = {}) ⇒ Array<(GetDatabasesInstances200Response, Integer, Hash)>

List managed databases __This operation is currently only available for customers who already have an active Managed Database.__ Display all Managed Databases that are accessible by your User, regardless of engine type. For more detailed information on a particular Database instance, make a request to its &#x60;instance_uri&#x60;. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



527
528
529
530
531
532
533
534
535
536
537
538
539
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
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 527

def get_databases_instances_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_instances ...'
  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 DatabasesApi.get_databases_instances"
  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
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DatabasesApi.get_databases_instances, must be greater than or equal to 1.'
  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 DatabasesApi.get_databases_instances, 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 DatabasesApi.get_databases_instances, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/databases/instances'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || 'GetDatabasesInstances200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_instances",
    :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: DatabasesApi#get_databases_instances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_mysql_instance(api_version, instance_id, opts = {}) ⇒ GetDatabasesMysqlInstance200Response

Get a managed MySQL database __This operation is currently only available for customers who already have an active Managed Database.__ Display information for a single, accessible Managed MySQL Database. <<LB>> — - __CLI__. “‘ linode-cli databases mysql-view 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:



600
601
602
603
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 600

def get_databases_mysql_instance(api_version, instance_id, opts = {})
  data, _status_code, _headers = get_databases_mysql_instance_with_http_info(api_version, instance_id, opts)
  data
end

#get_databases_mysql_instance_backup(api_version, instance_id, backup_id, opts = {}) ⇒ GetDatabasesMysqlInstanceBackup200Response

Get a managed MySQL database backup __This operation is currently only available for customers who already have an active Managed Database.__ Display information for a single backup for an accessible Managed MySQL Database. The Database must not be provisioning to perform this operation. <<LB>> — - __CLI__. “‘ linode-cli databases mysql-backup-view 123 456 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

  • backup_id (Integer) —

    The ID of the Managed MySQL Database backup.

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

    the optional parameters

Returns:



675
676
677
678
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 675

def get_databases_mysql_instance_backup(api_version, instance_id, backup_id, opts = {})
  data, _status_code, _headers = get_databases_mysql_instance_backup_with_http_info(api_version, instance_id, backup_id, opts)
  data
end

#get_databases_mysql_instance_backup_with_http_info(api_version, instance_id, backup_id, opts = {}) ⇒ Array<(GetDatabasesMysqlInstanceBackup200Response, Integer, Hash)>

Get a managed MySQL database backup __This operation is currently only available for customers who already have an active Managed Database.__ Display information for a single backup for an accessible Managed MySQL Database. The Database must not be provisioning to perform this operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases mysql-backup-view 123 456 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

  • backup_id (Integer) —

    The ID of the Managed MySQL Database backup.

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

    the optional parameters

Returns:



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
738
739
740
741
742
743
744
745
746
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 687

def get_databases_mysql_instance_backup_with_http_info(api_version, instance_id, backup_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_mysql_instance_backup ...'
  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 DatabasesApi.get_databases_mysql_instance_backup"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.get_databases_mysql_instance_backup"
  end
  # verify the required parameter 'backup_id' is set
  if @api_client.config.client_side_validation && backup_id.nil?
    fail ArgumentError, "Missing the required parameter 'backup_id' when calling DatabasesApi.get_databases_mysql_instance_backup"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/mysql/instances/{instanceId}/backups/{backupId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_id.to_s)).sub('{' + 'backupId' + '}', CGI.escape(backup_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] || 'GetDatabasesMysqlInstanceBackup200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_mysql_instance_backup",
    :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: DatabasesApi#get_databases_mysql_instance_backup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_mysql_instance_backups(api_version, instance_id, opts = {}) ⇒ GetDatabasesMysqlInstanceBackups200Response

List managed MySQL database backups __This operation is currently only available for customers who already have an active Managed Database.__ Display all backups for an accessible Managed MySQL Database. The Database must not be provisioning to perform this operation. Database ‘auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days. Database `snapshot` type backups are created by accessing the [Create a managed MySQL database backup snapshot](techdocs.akamai.com/linode-api/reference/post-databases-mysql-instance-backup) operation. <<LB>> — - __CLI__. “` linode-cli databases mysql-backups-list 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



756
757
758
759
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 756

def get_databases_mysql_instance_backups(api_version, instance_id, opts = {})
  data, _status_code, _headers = get_databases_mysql_instance_backups_with_http_info(api_version, instance_id, opts)
  data
end

#get_databases_mysql_instance_backups_with_http_info(api_version, instance_id, opts = {}) ⇒ Array<(GetDatabasesMysqlInstanceBackups200Response, Integer, Hash)>

List managed MySQL database backups __This operation is currently only available for customers who already have an active Managed Database.__ Display all backups for an accessible Managed MySQL Database. The Database must not be provisioning to perform this operation. Database &#x60;auto&#x60; type backups are created every 24 hours at 0:00 UTC. Each &#x60;auto&#x60; backup is retained for 7 days. Database &#x60;snapshot&#x60; type backups are created by accessing the [Create a managed MySQL database backup snapshot](techdocs.akamai.com/linode-api/reference/post-databases-mysql-instance-backup) operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases mysql-backups-list 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



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
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 769

def get_databases_mysql_instance_backups_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_mysql_instance_backups ...'
  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 DatabasesApi.get_databases_mysql_instance_backups"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.get_databases_mysql_instance_backups"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DatabasesApi.get_databases_mysql_instance_backups, must be greater than or equal to 1.'
  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 DatabasesApi.get_databases_mysql_instance_backups, 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 DatabasesApi.get_databases_mysql_instance_backups, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/databases/mysql/instances/{instanceId}/backups'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || 'GetDatabasesMysqlInstanceBackups200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_mysql_instance_backups",
    :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: DatabasesApi#get_databases_mysql_instance_backups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_mysql_instance_credentials(api_version, instance_id, opts = {}) ⇒ GetDatabasesPostgreSqlInstanceCredentials200Response

Get managed MySQL database credentials __This operation is currently only available for customers who already have an active Managed Database.__ Display the root username and password for an accessible Managed MySQL Database. The Database must have an ‘active` status to perform this operation. <<LB>> — - __CLI__. “` linode-cli databases mysql-creds-view 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:



846
847
848
849
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 846

def get_databases_mysql_instance_credentials(api_version, instance_id, opts = {})
  data, _status_code, _headers = get_databases_mysql_instance_credentials_with_http_info(api_version, instance_id, opts)
  data
end

#get_databases_mysql_instance_credentials_with_http_info(api_version, instance_id, opts = {}) ⇒ Array<(GetDatabasesPostgreSqlInstanceCredentials200Response, Integer, Hash)>

Get managed MySQL database credentials __This operation is currently only available for customers who already have an active Managed Database.__ Display the root username and password for an accessible Managed MySQL Database. The Database must have an &#x60;active&#x60; status to perform this operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases mysql-creds-view 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:



857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 857

def get_databases_mysql_instance_credentials_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_mysql_instance_credentials ...'
  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 DatabasesApi.get_databases_mysql_instance_credentials"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.get_databases_mysql_instance_credentials"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/mysql/instances/{instanceId}/credentials'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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] || 'GetDatabasesPostgreSqlInstanceCredentials200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_mysql_instance_credentials",
    :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: DatabasesApi#get_databases_mysql_instance_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_mysql_instance_ssl(api_version, instance_id, opts = {}) ⇒ GetDatabasesPostgresqlInstanceSsl200Response

Get a managed MySQL database SSL certificate __This operation is currently only available for customers who already have an active Managed Database.__ Display the SSL CA certificate for an accessible Managed MySQL Database. The Database must have an ‘active` status to perform this operation. <<LB>> — - __CLI__. “` linode-cli databases mysql-ssl-cert 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed MySQL Database.

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

    the optional parameters

Returns:



920
921
922
923
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 920

def get_databases_mysql_instance_ssl(api_version, instance_id, opts = {})
  data, _status_code, _headers = get_databases_mysql_instance_ssl_with_http_info(api_version, instance_id, opts)
  data
end

#get_databases_mysql_instance_ssl_with_http_info(api_version, instance_id, opts = {}) ⇒ Array<(GetDatabasesPostgresqlInstanceSsl200Response, Integer, Hash)>

Get a managed MySQL database SSL certificate __This operation is currently only available for customers who already have an active Managed Database.__ Display the SSL CA certificate for an accessible Managed MySQL Database. The Database must have an &#x60;active&#x60; status to perform this operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases mysql-ssl-cert 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed MySQL Database.

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

    the optional parameters

Returns:



931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 931

def get_databases_mysql_instance_ssl_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_mysql_instance_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 DatabasesApi.get_databases_mysql_instance_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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.get_databases_mysql_instance_ssl"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/mysql/instances/{instanceId}/ssl'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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] || 'GetDatabasesPostgresqlInstanceSsl200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_mysql_instance_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: DatabasesApi#get_databases_mysql_instance_ssl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_mysql_instance_with_http_info(api_version, instance_id, opts = {}) ⇒ Array<(GetDatabasesMysqlInstance200Response, Integer, Hash)>

Get a managed MySQL database __This operation is currently only available for customers who already have an active Managed Database.__ Display information for a single, accessible Managed MySQL Database. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases mysql-view 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:



611
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
664
665
666
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 611

def get_databases_mysql_instance_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_mysql_instance ...'
  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 DatabasesApi.get_databases_mysql_instance"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.get_databases_mysql_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/mysql/instances/{instanceId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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] || 'GetDatabasesMysqlInstance200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_mysql_instance",
    :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: DatabasesApi#get_databases_mysql_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_mysql_instances(api_version, opts = {}) ⇒ GetDatabasesMysqlInstances200Response

List managed MySQL databases __This operation is currently only available for customers who already have an active Managed Database.__ Display all accessible Managed MySQL Databases. <<LB>> — - __CLI__. “‘ linode-cli databases mysql-list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



995
996
997
998
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 995

def get_databases_mysql_instances(api_version, opts = {})
  data, _status_code, _headers = get_databases_mysql_instances_with_http_info(api_version, opts)
  data
end

#get_databases_mysql_instances_with_http_info(api_version, opts = {}) ⇒ Array<(GetDatabasesMysqlInstances200Response, Integer, Hash)>

List managed MySQL databases __This operation is currently only available for customers who already have an active Managed Database.__ Display all accessible Managed MySQL Databases. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases mysql-list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
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
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1007

def get_databases_mysql_instances_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_mysql_instances ...'
  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 DatabasesApi.get_databases_mysql_instances"
  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
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DatabasesApi.get_databases_mysql_instances, must be greater than or equal to 1.'
  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 DatabasesApi.get_databases_mysql_instances, 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 DatabasesApi.get_databases_mysql_instances, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/databases/mysql/instances'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || 'GetDatabasesMysqlInstances200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_mysql_instances",
    :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: DatabasesApi#get_databases_mysql_instances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_postgre_sql_instance(api_version, instance_id, opts = {}) ⇒ GetDatabasesPostgreSqlInstance200Response

Get a managed PostgreSQL database __This operation is currently only available for customers who already have an active Managed Database.__ Display information for a single, accessible Managed PostgreSQL Database. <<LB>> — - __CLI__. “‘ linode-cli databases postgresql-view 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:



1080
1081
1082
1083
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1080

def get_databases_postgre_sql_instance(api_version, instance_id, opts = {})
  data, _status_code, _headers = get_databases_postgre_sql_instance_with_http_info(api_version, instance_id, opts)
  data
end

#get_databases_postgre_sql_instance_backups(api_version, instance_id, opts = {}) ⇒ GetDatabasesPostgreSqlInstanceBackups200Response

List managed PostgreSQL database backups __This operation is currently only available for customers who already have an active Managed Database.__ Display all backups for an accessible Managed PostgreSQL Database. The Database must not be provisioning to perform this operation. Database ‘auto` type backups are created every 24 hours at 0:00 UTC. Each `auto` backup is retained for 7 days. Database `snapshot` type backups are created by accessing the [Create a managed PostgreSQL database backup snapshot](techdocs.akamai.com/linode-api/reference/post-databases-postgre-sql-instance-backup) operation. <<LB>> — - __CLI__. “` linode-cli databases postgresql-backups-list 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



1156
1157
1158
1159
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1156

def get_databases_postgre_sql_instance_backups(api_version, instance_id, opts = {})
  data, _status_code, _headers = get_databases_postgre_sql_instance_backups_with_http_info(api_version, instance_id, opts)
  data
end

#get_databases_postgre_sql_instance_backups_with_http_info(api_version, instance_id, opts = {}) ⇒ Array<(GetDatabasesPostgreSqlInstanceBackups200Response, Integer, Hash)>

List managed PostgreSQL database backups __This operation is currently only available for customers who already have an active Managed Database.__ Display all backups for an accessible Managed PostgreSQL Database. The Database must not be provisioning to perform this operation. Database &#x60;auto&#x60; type backups are created every 24 hours at 0:00 UTC. Each &#x60;auto&#x60; backup is retained for 7 days. Database &#x60;snapshot&#x60; type backups are created by accessing the [Create a managed PostgreSQL database backup snapshot](techdocs.akamai.com/linode-api/reference/post-databases-postgre-sql-instance-backup) operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases postgresql-backups-list 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
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/databases_api.rb', line 1169

def get_databases_postgre_sql_instance_backups_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_postgre_sql_instance_backups ...'
  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 DatabasesApi.get_databases_postgre_sql_instance_backups"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.get_databases_postgre_sql_instance_backups"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DatabasesApi.get_databases_postgre_sql_instance_backups, must be greater than or equal to 1.'
  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 DatabasesApi.get_databases_postgre_sql_instance_backups, 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 DatabasesApi.get_databases_postgre_sql_instance_backups, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/databases/postgresql/instances/{instanceId}/backups'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || 'GetDatabasesPostgreSqlInstanceBackups200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_postgre_sql_instance_backups",
    :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: DatabasesApi#get_databases_postgre_sql_instance_backups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_postgre_sql_instance_credentials(api_version, instance_id, opts = {}) ⇒ GetDatabasesPostgreSqlInstanceCredentials200Response

Get managed PostgreSQL database credentials __This operation is currently only available for customers who already have an active Managed Database.__ Display the root username and password for an accessible Managed PostgreSQL Database. The Database must have an ‘active` status to perform this operation. <<LB>> — - __CLI__. “` linode-cli databases postgresql-creds-view 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:



1246
1247
1248
1249
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1246

def get_databases_postgre_sql_instance_credentials(api_version, instance_id, opts = {})
  data, _status_code, _headers = get_databases_postgre_sql_instance_credentials_with_http_info(api_version, instance_id, opts)
  data
end

#get_databases_postgre_sql_instance_credentials_with_http_info(api_version, instance_id, opts = {}) ⇒ Array<(GetDatabasesPostgreSqlInstanceCredentials200Response, Integer, Hash)>

Get managed PostgreSQL database credentials __This operation is currently only available for customers who already have an active Managed Database.__ Display the root username and password for an accessible Managed PostgreSQL Database. The Database must have an &#x60;active&#x60; status to perform this operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases postgresql-creds-view 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:



1257
1258
1259
1260
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
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1257

def get_databases_postgre_sql_instance_credentials_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_postgre_sql_instance_credentials ...'
  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 DatabasesApi.get_databases_postgre_sql_instance_credentials"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.get_databases_postgre_sql_instance_credentials"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/postgresql/instances/{instanceId}/credentials'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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] || 'GetDatabasesPostgreSqlInstanceCredentials200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_postgre_sql_instance_credentials",
    :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: DatabasesApi#get_databases_postgre_sql_instance_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_postgre_sql_instance_with_http_info(api_version, instance_id, opts = {}) ⇒ Array<(GetDatabasesPostgreSqlInstance200Response, Integer, Hash)>

Get a managed PostgreSQL database __This operation is currently only available for customers who already have an active Managed Database.__ Display information for a single, accessible Managed PostgreSQL Database. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases postgresql-view 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:



1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
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
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1091

def get_databases_postgre_sql_instance_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_postgre_sql_instance ...'
  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 DatabasesApi.get_databases_postgre_sql_instance"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.get_databases_postgre_sql_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/postgresql/instances/{instanceId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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] || 'GetDatabasesPostgreSqlInstance200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_postgre_sql_instance",
    :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: DatabasesApi#get_databases_postgre_sql_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_postgre_sql_instances(api_version, opts = {}) ⇒ GetDatabasesPostgreSqlInstances200Response

List managed PostgreSQL databases __This operation is currently only available for customers who already have an active Managed Database.__ Display all accessible Managed PostgreSQL Databases. <<LB>> — - __CLI__. “‘ linode-cli databases postgresql-list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



1321
1322
1323
1324
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1321

def get_databases_postgre_sql_instances(api_version, opts = {})
  data, _status_code, _headers = get_databases_postgre_sql_instances_with_http_info(api_version, opts)
  data
end

#get_databases_postgre_sql_instances_with_http_info(api_version, opts = {}) ⇒ Array<(GetDatabasesPostgreSqlInstances200Response, Integer, Hash)>

List managed PostgreSQL databases __This operation is currently only available for customers who already have an active Managed Database.__ Display all accessible Managed PostgreSQL Databases. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases postgresql-list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
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
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1333

def get_databases_postgre_sql_instances_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_postgre_sql_instances ...'
  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 DatabasesApi.get_databases_postgre_sql_instances"
  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
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DatabasesApi.get_databases_postgre_sql_instances, must be greater than or equal to 1.'
  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 DatabasesApi.get_databases_postgre_sql_instances, 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 DatabasesApi.get_databases_postgre_sql_instances, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/databases/postgresql/instances'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || 'GetDatabasesPostgreSqlInstances200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_postgre_sql_instances",
    :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: DatabasesApi#get_databases_postgre_sql_instances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_postgresql_instance_backup(api_version, instance_id, backup_id, opts = {}) ⇒ GetDatabasesPostgresqlInstanceBackup200Response

Get a managed PostgreSQL database backup __This operation is currently only available for customers who already have an active Managed Database.__ Display information for a single backup for an accessible Managed PostgreSQL Database. The Database must not be provisioning to perform this operation. <<LB>> — - __CLI__. “‘ linode-cli databases postgresql-backup-view 123 456 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

  • backup_id (Integer) —

    The ID of the Managed PostgreSQL Database backup.

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

    the optional parameters

Returns:



1407
1408
1409
1410
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1407

def get_databases_postgresql_instance_backup(api_version, instance_id, backup_id, opts = {})
  data, _status_code, _headers = get_databases_postgresql_instance_backup_with_http_info(api_version, instance_id, backup_id, opts)
  data
end

#get_databases_postgresql_instance_backup_with_http_info(api_version, instance_id, backup_id, opts = {}) ⇒ Array<(GetDatabasesPostgresqlInstanceBackup200Response, Integer, Hash)>

Get a managed PostgreSQL database backup __This operation is currently only available for customers who already have an active Managed Database.__ Display information for a single backup for an accessible Managed PostgreSQL Database. The Database must not be provisioning to perform this operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases postgresql-backup-view 123 456 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

  • backup_id (Integer) —

    The ID of the Managed PostgreSQL Database backup.

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

    the optional parameters

Returns:



1419
1420
1421
1422
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
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1419

def get_databases_postgresql_instance_backup_with_http_info(api_version, instance_id, backup_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_postgresql_instance_backup ...'
  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 DatabasesApi.get_databases_postgresql_instance_backup"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.get_databases_postgresql_instance_backup"
  end
  # verify the required parameter 'backup_id' is set
  if @api_client.config.client_side_validation && backup_id.nil?
    fail ArgumentError, "Missing the required parameter 'backup_id' when calling DatabasesApi.get_databases_postgresql_instance_backup"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/postgresql/instances/{instanceId}/backups/{backupId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_id.to_s)).sub('{' + 'backupId' + '}', CGI.escape(backup_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] || 'GetDatabasesPostgresqlInstanceBackup200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_postgresql_instance_backup",
    :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: DatabasesApi#get_databases_postgresql_instance_backup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_postgresql_instance_ssl(api_version, instance_id, opts = {}) ⇒ GetDatabasesPostgresqlInstanceSsl200Response

Get a managed PostgreSQL database SSL certificate __This operation is currently only available for customers who already have an active Managed Database.__ Display the SSL CA certificate for an accessible Managed PostgreSQL Database. The Database must have an ‘active` status to perform this operation. <<LB>> — - __CLI__. “` linode-cli databases postgresql-ssl-cert 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:



1486
1487
1488
1489
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1486

def get_databases_postgresql_instance_ssl(api_version, instance_id, opts = {})
  data, _status_code, _headers = get_databases_postgresql_instance_ssl_with_http_info(api_version, instance_id, opts)
  data
end

#get_databases_postgresql_instance_ssl_with_http_info(api_version, instance_id, opts = {}) ⇒ Array<(GetDatabasesPostgresqlInstanceSsl200Response, Integer, Hash)>

Get a managed PostgreSQL database SSL certificate __This operation is currently only available for customers who already have an active Managed Database.__ Display the SSL CA certificate for an accessible Managed PostgreSQL Database. The Database must have an &#x60;active&#x60; status to perform this operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases postgresql-ssl-cert 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:



1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
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
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1497

def get_databases_postgresql_instance_ssl_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_postgresql_instance_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 DatabasesApi.get_databases_postgresql_instance_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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.get_databases_postgresql_instance_ssl"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/postgresql/instances/{instanceId}/ssl'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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] || 'GetDatabasesPostgresqlInstanceSsl200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_postgresql_instance_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: DatabasesApi#get_databases_postgresql_instance_ssl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_type(api_version, type_id, opts = {}) ⇒ GetDatabasesType200Response

Get a managed database type __This operation is currently only available for customers who already have an active Managed Database.__ Display the details of a single Managed Database type. The type and number of nodes determine the resources and price of a Managed Database instance. <<LB>> — - __CLI__. “‘ linode-cli databases type-view “` [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.

  • type_id (String) —

    The ID of the Managed Database type.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



1562
1563
1564
1565
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1562

def get_databases_type(api_version, type_id, opts = {})
  data, _status_code, _headers = get_databases_type_with_http_info(api_version, type_id, opts)
  data
end

#get_databases_type_with_http_info(api_version, type_id, opts = {}) ⇒ Array<(GetDatabasesType200Response, Integer, Hash)>

Get a managed database type __This operation is currently only available for customers who already have an active Managed Database.__ Display the details of a single Managed Database type. The type and number of nodes determine the resources and price of a Managed Database instance. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases type-view &#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.

  • type_id (String) —

    The ID of the Managed Database type.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:

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

    GetDatabasesType200Response data, response status code and response headers



1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
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
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1575

def get_databases_type_with_http_info(api_version, type_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_type ...'
  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 DatabasesApi.get_databases_type"
  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 'type_id' is set
  if @api_client.config.client_side_validation && type_id.nil?
    fail ArgumentError, "Missing the required parameter 'type_id' when calling DatabasesApi.get_databases_type"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DatabasesApi.get_databases_type, must be greater than or equal to 1.'
  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 DatabasesApi.get_databases_type, 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 DatabasesApi.get_databases_type, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/databases/types/{typeId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'typeId' + '}', CGI.escape(type_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || 'GetDatabasesType200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_type",
    :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: DatabasesApi#get_databases_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_databases_types(api_version, opts = {}) ⇒ GetDatabasesTypes200Response

List managed database types __This operation is currently only available for customers who already have an active Managed Database.__ Display all Managed Database node types. The type and number of nodes determine the resources and price of a Managed Database instance. Each Managed Database can have one node type. In the case of a high availability Database, all nodes are provisioned according to the chosen type. <<LB>> — - __CLI__. “‘ linode-cli databases types “` [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

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



1653
1654
1655
1656
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1653

def get_databases_types(api_version, opts = {})
  data, _status_code, _headers = get_databases_types_with_http_info(api_version, opts)
  data
end

#get_databases_types_with_http_info(api_version, opts = {}) ⇒ Array<(GetDatabasesTypes200Response, Integer, Hash)>

List managed database types __This operation is currently only available for customers who already have an active Managed Database.__ Display all Managed Database node types. The type and number of nodes determine the resources and price of a Managed Database instance. Each Managed Database can have one node type. In the case of a high availability Database, all nodes are provisioned according to the chosen type. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases types &#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

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

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

Returns:



1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
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
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1665

def get_databases_types_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.get_databases_types ...'
  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 DatabasesApi.get_databases_types"
  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
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DatabasesApi.get_databases_types, must be greater than or equal to 1.'
  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 DatabasesApi.get_databases_types, 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 DatabasesApi.get_databases_types, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/databases/types'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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] || 'GetDatabasesTypes200Response'

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.get_databases_types",
    :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: DatabasesApi#get_databases_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_databases_mysql_instance_backup(api_version, instance_id, opts = {}) ⇒ Object

Create a managed MySQL database backup snapshot __This operation is currently only available for customers who already have an active Managed Database.__ Creates a snapshot backup of a Managed MySQL Database. Requires ‘read_write` access to the Database. Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made. Backups generated by this operation have the type `snapshot`. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore. The Database must have an `active` status to perform this operation. If another backup is in progress, it must complete before a new backup can be initiated. <<LB>> — - __CLI__. “` linode-cli databases mysql-backup-snapshot 123 \ –label snapshot1 \ –target primary “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


1739
1740
1741
1742
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1739

def post_databases_mysql_instance_backup(api_version, instance_id, opts = {})
  data, _status_code, _headers = post_databases_mysql_instance_backup_with_http_info(api_version, instance_id, opts)
  data
end

#post_databases_mysql_instance_backup_restore(api_version, instance_id, backup_id, opts = {}) ⇒ Object

Restore a managed MySQL database backup __This operation is currently only available for customers who already have an active Managed Database.__ Restore a backup to a Managed MySQL Database on your Account. Requires ‘read_write` access to the Database. The Database must have an `active`, `degraded`, or `failed` status to perform this operation. __Note__. Restoring from a backup will erase all existing data on the database instance and replace it with backup data. __Note__. Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs. <<LB>> — - __CLI__. “` linode-cli databases mysql-backup-restore 123 456 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed MySQL Database.

  • backup_id (Integer) —

    The ID of the Managed MySQL Database backup.

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

    the optional parameters

Returns:

  • (Object) 


1820
1821
1822
1823
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1820

def post_databases_mysql_instance_backup_restore(api_version, instance_id, backup_id, opts = {})
  data, _status_code, _headers = post_databases_mysql_instance_backup_restore_with_http_info(api_version, instance_id, backup_id, opts)
  data
end

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

Restore a managed MySQL database backup __This operation is currently only available for customers who already have an active Managed Database.__ Restore a backup to a Managed MySQL Database on your Account. Requires &#x60;read_write&#x60; access to the Database. The Database must have an &#x60;active&#x60;, &#x60;degraded&#x60;, or &#x60;failed&#x60; status to perform this operation. __Note__. Restoring from a backup will erase all existing data on the database instance and replace it with backup data. __Note__. Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases mysql-backup-restore 123 456 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed MySQL Database.

  • backup_id (Integer) —

    The ID of the Managed MySQL Database backup.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1832

def post_databases_mysql_instance_backup_restore_with_http_info(api_version, instance_id, backup_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.post_databases_mysql_instance_backup_restore ...'
  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 DatabasesApi.post_databases_mysql_instance_backup_restore"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.post_databases_mysql_instance_backup_restore"
  end
  # verify the required parameter 'backup_id' is set
  if @api_client.config.client_side_validation && backup_id.nil?
    fail ArgumentError, "Missing the required parameter 'backup_id' when calling DatabasesApi.post_databases_mysql_instance_backup_restore"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/mysql/instances/{instanceId}/backups/{backupId}/restore'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_id.to_s)).sub('{' + 'backupId' + '}', CGI.escape(backup_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 => :"DatabasesApi.post_databases_mysql_instance_backup_restore",
    :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: DatabasesApi#post_databases_mysql_instance_backup_restore\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create a managed MySQL database backup snapshot __This operation is currently only available for customers who already have an active Managed Database.__ Creates a snapshot backup of a Managed MySQL Database. Requires &#x60;read_write&#x60; access to the Database. Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made. Backups generated by this operation have the type &#x60;snapshot&#x60;. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore. The Database must have an &#x60;active&#x60; status to perform this operation. If another backup is in progress, it must complete before a new backup can be initiated. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases mysql-backup-snapshot 123 \ –label snapshot1 \ –target primary &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object data, response status code and response headers



1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
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
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1751

def post_databases_mysql_instance_backup_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.post_databases_mysql_instance_backup ...'
  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 DatabasesApi.post_databases_mysql_instance_backup"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.post_databases_mysql_instance_backup"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/mysql/instances/{instanceId}/backups'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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[:'post_databases_mysql_instance_backup_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 => :"DatabasesApi.post_databases_mysql_instance_backup",
    :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: DatabasesApi#post_databases_mysql_instance_backup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_databases_mysql_instance_credentials_reset(api_version, instance_id, opts = {}) ⇒ Object

Reset managed MySQL database credentials __This operation is currently only available for customers who already have an active Managed Database.__ Reset the root password for a Managed MySQL Database. Requires ‘read_write` access to the Database. A new root password is randomly generated and accessible with the [Get managed MySQL database credentials](techdocs.akamai.com/linode-api/reference/get-databases-mysql-instance-credentials) operation. Only unrestricted Users can access this operation, and have access regardless of the acting token’s OAuth scopes. __Note__. It may take several seconds for credentials to reset. <<LB>> — - __CLI__. “‘ linode-cli databases mysql-creds-reset 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed MySQL Database.

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

    the optional parameters

Returns:

  • (Object) 


1899
1900
1901
1902
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1899

def post_databases_mysql_instance_credentials_reset(api_version, instance_id, opts = {})
  data, _status_code, _headers = post_databases_mysql_instance_credentials_reset_with_http_info(api_version, instance_id, opts)
  data
end

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

Reset managed MySQL database credentials __This operation is currently only available for customers who already have an active Managed Database.__ Reset the root password for a Managed MySQL Database. Requires &#x60;read_write&#x60; access to the Database. A new root password is randomly generated and accessible with the [Get managed MySQL database credentials](techdocs.akamai.com/linode-api/reference/get-databases-mysql-instance-credentials) operation. Only unrestricted Users can access this operation, and have access regardless of the acting token&#39;s OAuth scopes. __Note__. It may take several seconds for credentials to reset. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases mysql-creds-reset 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed MySQL Database.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1910

def post_databases_mysql_instance_credentials_reset_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.post_databases_mysql_instance_credentials_reset ...'
  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 DatabasesApi.post_databases_mysql_instance_credentials_reset"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.post_databases_mysql_instance_credentials_reset"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/mysql/instances/{instanceId}/credentials/reset'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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 => :"DatabasesApi.post_databases_mysql_instance_credentials_reset",
    :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: DatabasesApi#post_databases_mysql_instance_credentials_reset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_databases_mysql_instance_patch(api_version, instance_id, opts = {}) ⇒ Object

Patch a managed MySQL database __This operation is currently only available for customers who already have an active Managed Database.__ Apply security patches and updates to the underlying operating system of the Managed MySQL Database. This function runs during regular maintenance windows, which are configurable with the [Update a managed MySQL database](techdocs.akamai.com/linode-api/reference/put-databases-mysql-instance) operation. Requires ‘read_write` access to the Database. The Database must have an `active` status to perform this operation. __Note__ - If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance. - __The database software is not updated automatically.__ To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](www.linode.com/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one. <<LB>> — - __CLI__. “` linode-cli databases mysql-patch 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:

  • (Object) 


1973
1974
1975
1976
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1973

def post_databases_mysql_instance_patch(api_version, instance_id, opts = {})
  data, _status_code, _headers = post_databases_mysql_instance_patch_with_http_info(api_version, instance_id, opts)
  data
end

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

Patch a managed MySQL database __This operation is currently only available for customers who already have an active Managed Database.__ Apply security patches and updates to the underlying operating system of the Managed MySQL Database. This function runs during regular maintenance windows, which are configurable with the [Update a managed MySQL database](techdocs.akamai.com/linode-api/reference/put-databases-mysql-instance) operation. Requires &#x60;read_write&#x60; access to the Database. The Database must have an &#x60;active&#x60; status to perform this operation. __Note__ - If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance. - __The database software is not updated automatically.__ To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](www.linode.com/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases mysql-patch 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 1984

def post_databases_mysql_instance_patch_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.post_databases_mysql_instance_patch ...'
  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 DatabasesApi.post_databases_mysql_instance_patch"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.post_databases_mysql_instance_patch"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/mysql/instances/{instanceId}/patch'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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 => :"DatabasesApi.post_databases_mysql_instance_patch",
    :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: DatabasesApi#post_databases_mysql_instance_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_databases_mysql_instances(api_version, post_databases_mysql_instances_request, opts = {}) ⇒ PostDatabasesMysqlInstances200Response

Create a managed MySQL database __This operation is currently only available for customers who already have an active Managed Database.__ Provision a Managed MySQL Database. Restricted Users must have the ‘add_databases` grant to use this operation. New instances can take approximately 15 to 30 minutes to provision. The `allow_list` is used to control access to the Managed Database. - IP addresses and ranges in this list can access the Managed Database. All other sources are blocked. - If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database. - Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database. All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week. All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MySQL Database during configurable maintenance windows. - If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It’s recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance. - __The database software is not updated automatically.__ To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](www.linode.com/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one. - To modify update the maintenance window for a Database, run the [Update a managed MySQL database](techdocs.akamai.com/linode-api/reference/put-databases-mysql-instance) operation. <<LB>> — - __CLI__. “‘ linode-cli databases mysql-create \ –label example-db1 \ –region us-east \ –type g6-dedicated-2 \ –cluster_size 3 \ –engine mysql/8.0.26 \ –encrypted false \ –ssl_connection false \ –replication_type semi_synch \ –allow_list 203.0.113.1 \ –allow_list 192.0.1.0/24 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • post_databases_mysql_instances_request (PostDatabasesMysqlInstancesRequest) —

    Information about the Managed MySQL Database you are creating.

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

    the optional parameters

Returns:



2047
2048
2049
2050
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2047

def post_databases_mysql_instances(api_version, post_databases_mysql_instances_request, opts = {})
  data, _status_code, _headers = post_databases_mysql_instances_with_http_info(api_version, post_databases_mysql_instances_request, opts)
  data
end

#post_databases_mysql_instances_with_http_info(api_version, post_databases_mysql_instances_request, opts = {}) ⇒ Array<(PostDatabasesMysqlInstances200Response, Integer, Hash)>

Create a managed MySQL database __This operation is currently only available for customers who already have an active Managed Database.__ Provision a Managed MySQL Database. Restricted Users must have the &#x60;add_databases&#x60; grant to use this operation. New instances can take approximately 15 to 30 minutes to provision. The &#x60;allow_list&#x60; is used to control access to the Managed Database. - IP addresses and ranges in this list can access the Managed Database. All other sources are blocked. - If &#x60;0.0.0.0/0&#x60; is a value in this list, then all IP addresses can access the Managed Database. - Entering an empty array (&#x60;[]&#x60;) blocks all connections (both public and private) to the Managed Database. All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week. All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MySQL Database during configurable maintenance windows. - If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It&#39;s recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance. - __The database software is not updated automatically.__ To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](www.linode.com/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one. - To modify update the maintenance window for a Database, run the [Update a managed MySQL database](techdocs.akamai.com/linode-api/reference/put-databases-mysql-instance) operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases mysql-create \ –label example-db1 \ –region us-east \ –type g6-dedicated-2 \ –cluster_size 3 \ –engine mysql/8.0.26 \ –encrypted false \ –ssl_connection false \ –replication_type semi_synch \ –allow_list 203.0.113.1 \ –allow_list 192.0.1.0/24 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • post_databases_mysql_instances_request (PostDatabasesMysqlInstancesRequest) —

    Information about the Managed MySQL Database you are creating.

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

    the optional parameters

Returns:



2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2058

def post_databases_mysql_instances_with_http_info(api_version, post_databases_mysql_instances_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.post_databases_mysql_instances ...'
  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 DatabasesApi.post_databases_mysql_instances"
  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 'post_databases_mysql_instances_request' is set
  if @api_client.config.client_side_validation && post_databases_mysql_instances_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_databases_mysql_instances_request' when calling DatabasesApi.post_databases_mysql_instances"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/mysql/instances'.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(post_databases_mysql_instances_request)

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

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.post_databases_mysql_instances",
    :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: DatabasesApi#post_databases_mysql_instances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_databases_postgre_sql_instance_backup(api_version, instance_id, opts = {}) ⇒ Object

Create a managed PostgreSQL database backup snapshot __This operation is currently only available for customers who already have an active Managed Database.__ Creates a snapshot backup of a Managed PostgreSQL Database. Requires ‘read_write` access to the Database. Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made. Backups generated by this operation have the type `snapshot`. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore. The Database must have an `active` status to perform this operation. If another backup is in progress, it must complete before a new backup can be initiated. <<LB>> — - __CLI__. “` linode-cli databases postgresql-backup-snapshot 123 \ –label snapshot1 \ –target primary “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


2127
2128
2129
2130
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2127

def post_databases_postgre_sql_instance_backup(api_version, instance_id, opts = {})
  data, _status_code, _headers = post_databases_postgre_sql_instance_backup_with_http_info(api_version, instance_id, opts)
  data
end

#post_databases_postgre_sql_instance_backup_restore(api_version, instance_id, backup_id, opts = {}) ⇒ Object

Restore a managed PostgreSQL database backup __This operation is currently only available for customers who already have an active Managed Database.__ Restore a backup to a Managed PostgreSQL Database on your Account. Requires ‘read_write` access to the Database. The Database must have an `active`, `degraded`, or `failed` status to perform this operation. __Note__. Restoring from a backup will erase all existing data on the database instance and replace it with backup data. __Note__. Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs. <<LB>> — - __CLI__. “` linode-cli databases postgresql-backup-restore 123 456 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

  • backup_id (Integer) —

    The ID of the Managed PostgreSQL Database backup.

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

    the optional parameters

Returns:

  • (Object) 


2208
2209
2210
2211
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2208

def post_databases_postgre_sql_instance_backup_restore(api_version, instance_id, backup_id, opts = {})
  data, _status_code, _headers = post_databases_postgre_sql_instance_backup_restore_with_http_info(api_version, instance_id, backup_id, opts)
  data
end

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

Restore a managed PostgreSQL database backup __This operation is currently only available for customers who already have an active Managed Database.__ Restore a backup to a Managed PostgreSQL Database on your Account. Requires &#x60;read_write&#x60; access to the Database. The Database must have an &#x60;active&#x60;, &#x60;degraded&#x60;, or &#x60;failed&#x60; status to perform this operation. __Note__. Restoring from a backup will erase all existing data on the database instance and replace it with backup data. __Note__. Currently, restoring a backup after resetting Managed Database credentials results in a failed cluster. Please contact Customer Support if this occurs. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases postgresql-backup-restore 123 456 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

  • backup_id (Integer) —

    The ID of the Managed PostgreSQL Database backup.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2220

def post_databases_postgre_sql_instance_backup_restore_with_http_info(api_version, instance_id, backup_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.post_databases_postgre_sql_instance_backup_restore ...'
  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 DatabasesApi.post_databases_postgre_sql_instance_backup_restore"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.post_databases_postgre_sql_instance_backup_restore"
  end
  # verify the required parameter 'backup_id' is set
  if @api_client.config.client_side_validation && backup_id.nil?
    fail ArgumentError, "Missing the required parameter 'backup_id' when calling DatabasesApi.post_databases_postgre_sql_instance_backup_restore"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/postgresql/instances/{instanceId}/backups/{backupId}/restore'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_id.to_s)).sub('{' + 'backupId' + '}', CGI.escape(backup_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 => :"DatabasesApi.post_databases_postgre_sql_instance_backup_restore",
    :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: DatabasesApi#post_databases_postgre_sql_instance_backup_restore\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create a managed PostgreSQL database backup snapshot __This operation is currently only available for customers who already have an active Managed Database.__ Creates a snapshot backup of a Managed PostgreSQL Database. Requires &#x60;read_write&#x60; access to the Database. Up to 3 snapshot backups for each Database can be stored at a time. If 3 snapshots have been created for a Database, one must be deleted before another can be made. Backups generated by this operation have the type &#x60;snapshot&#x60;. Snapshot backups may take several minutes to complete, after which they will be accessible to view or restore. The Database must have an &#x60;active&#x60; status to perform this operation. If another backup is in progress, it must complete before a new backup can be initiated. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases postgresql-backup-snapshot 123 \ –label snapshot1 \ –target primary &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object data, response status code and response headers



2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2139

def post_databases_postgre_sql_instance_backup_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.post_databases_postgre_sql_instance_backup ...'
  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 DatabasesApi.post_databases_postgre_sql_instance_backup"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.post_databases_postgre_sql_instance_backup"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/postgresql/instances/{instanceId}/backups'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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[:'post_databases_postgre_sql_instance_backup_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 => :"DatabasesApi.post_databases_postgre_sql_instance_backup",
    :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: DatabasesApi#post_databases_postgre_sql_instance_backup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_databases_postgre_sql_instance_credentials_reset(api_version, instance_id, opts = {}) ⇒ Object

Reset managed PostgreSQL database credentials __This operation is currently only available for customers who already have an active Managed Database.__ Reset the root password for a Managed PostgreSQL Database. Requires ‘read_write` access to the Database. A new root password is randomly generated and accessible with the [Get managed PostgreSQL database credentials](techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-instance-credentials) operation. Only unrestricted Users can access this operation, and have access regardless of the acting token’s OAuth scopes. __Note__. It may take several seconds for credentials to reset. <<LB>> — - __CLI__. “‘ linode-cli databases postgresql-creds-reset 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:

  • (Object) 


2287
2288
2289
2290
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2287

def post_databases_postgre_sql_instance_credentials_reset(api_version, instance_id, opts = {})
  data, _status_code, _headers = post_databases_postgre_sql_instance_credentials_reset_with_http_info(api_version, instance_id, opts)
  data
end

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

Reset managed PostgreSQL database credentials __This operation is currently only available for customers who already have an active Managed Database.__ Reset the root password for a Managed PostgreSQL Database. Requires &#x60;read_write&#x60; access to the Database. A new root password is randomly generated and accessible with the [Get managed PostgreSQL database credentials](techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-instance-credentials) operation. Only unrestricted Users can access this operation, and have access regardless of the acting token&#39;s OAuth scopes. __Note__. It may take several seconds for credentials to reset. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases postgresql-creds-reset 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2298

def post_databases_postgre_sql_instance_credentials_reset_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.post_databases_postgre_sql_instance_credentials_reset ...'
  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 DatabasesApi.post_databases_postgre_sql_instance_credentials_reset"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.post_databases_postgre_sql_instance_credentials_reset"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/postgresql/instances/{instanceId}/credentials/reset'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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 => :"DatabasesApi.post_databases_postgre_sql_instance_credentials_reset",
    :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: DatabasesApi#post_databases_postgre_sql_instance_credentials_reset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_databases_postgre_sql_instance_patch(api_version, instance_id, opts = {}) ⇒ Object

Patch a managed PostgreSQL database __This operation is currently only available for customers who already have an active Managed Database.__ Apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database. This function runs during regular maintenance windows, which are configurable with the [Update a managed PostgreSQL database](techdocs.akamai.com/linode-api/reference/put-databases-postgre-sql-instance) operation. Requires ‘read_write` access to the Database. The Database must have an `active` status to perform this operation. __Note__ - If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance. - __The database software is not updated automatically.__ To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one. <<LB>> — - __CLI__. “` linode-cli databases postgresql-patch 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:

  • (Object) 


2361
2362
2363
2364
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2361

def post_databases_postgre_sql_instance_patch(api_version, instance_id, opts = {})
  data, _status_code, _headers = post_databases_postgre_sql_instance_patch_with_http_info(api_version, instance_id, opts)
  data
end

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

Patch a managed PostgreSQL database __This operation is currently only available for customers who already have an active Managed Database.__ Apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database. This function runs during regular maintenance windows, which are configurable with the [Update a managed PostgreSQL database](techdocs.akamai.com/linode-api/reference/put-databases-postgre-sql-instance) operation. Requires &#x60;read_write&#x60; access to the Database. The Database must have an &#x60;active&#x60; status to perform this operation. __Note__ - If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance. - __The database software is not updated automatically.__ To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases postgresql-patch 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2372

def post_databases_postgre_sql_instance_patch_with_http_info(api_version, instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.post_databases_postgre_sql_instance_patch ...'
  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 DatabasesApi.post_databases_postgre_sql_instance_patch"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.post_databases_postgre_sql_instance_patch"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/postgresql/instances/{instanceId}/patch'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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 => :"DatabasesApi.post_databases_postgre_sql_instance_patch",
    :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: DatabasesApi#post_databases_postgre_sql_instance_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_databases_postgre_sql_instances(api_version, post_databases_postgre_sql_instances_request, opts = {}) ⇒ PostDatabasesPostgreSqlInstances200Response

Create a managed PostgreSQL database __This operation is currently only available for customers who already have an active Managed Database.__ Provision a Managed PostgreSQL Database. Restricted Users must have the ‘add_databases` grant to use this operation. New instances can take approximately 15 to 30 minutes to provision. The `allow_list` is used to control access to the Managed Database. - IP addresses and ranges in this list can access the Managed Database. All other sources are blocked. - If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database. - Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database. All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week. All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database during configurable maintenance windows. - If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It’s recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance. - __The database software is not updated automatically.__ To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one. - To modify update the maintenance window for a Database, run the [Update a managed PostgreSQL database](techdocs.akamai.com/linode-api/reference/put-databases-postgre-sql-instance) operation. <<LB>> — - __CLI__. “‘ linode-cli databases postgresql-create \ –label example-db \ –region us-east \ –type g6-dedicated-2 \ –cluster_size 3 \ –engine postgresql/13.2 \ –encrypted false \ –ssl_connection false \ –replication_type asynch \ –replication_commit_type local \ –allow_list 203.0.113.1 \ –allow_list 192.0.1.0/24 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • post_databases_postgre_sql_instances_request (PostDatabasesPostgreSqlInstancesRequest) —

    Information about the Managed PostgreSQL Database you are creating.

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

    the optional parameters

Returns:



2435
2436
2437
2438
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2435

def post_databases_postgre_sql_instances(api_version, post_databases_postgre_sql_instances_request, opts = {})
  data, _status_code, _headers = post_databases_postgre_sql_instances_with_http_info(api_version, post_databases_postgre_sql_instances_request, opts)
  data
end

#post_databases_postgre_sql_instances_with_http_info(api_version, post_databases_postgre_sql_instances_request, opts = {}) ⇒ Array<(PostDatabasesPostgreSqlInstances200Response, Integer, Hash)>

Create a managed PostgreSQL database __This operation is currently only available for customers who already have an active Managed Database.__ Provision a Managed PostgreSQL Database. Restricted Users must have the &#x60;add_databases&#x60; grant to use this operation. New instances can take approximately 15 to 30 minutes to provision. The &#x60;allow_list&#x60; is used to control access to the Managed Database. - IP addresses and ranges in this list can access the Managed Database. All other sources are blocked. - If &#x60;0.0.0.0/0&#x60; is a value in this list, then all IP addresses can access the Managed Database. - Entering an empty array (&#x60;[]&#x60;) blocks all connections (both public and private) to the Managed Database. All Managed Databases include automatic, daily backups. Up to seven backups are automatically stored for each Managed Database, providing restore points for each day of the past week. All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database during configurable maintenance windows. - If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It&#39;s recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance. - __The database software is not updated automatically.__ To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one. - To modify update the maintenance window for a Database, run the [Update a managed PostgreSQL database](techdocs.akamai.com/linode-api/reference/put-databases-postgre-sql-instance) operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases postgresql-create \ –label example-db \ –region us-east \ –type g6-dedicated-2 \ –cluster_size 3 \ –engine postgresql/13.2 \ –encrypted false \ –ssl_connection false \ –replication_type asynch \ –replication_commit_type local \ –allow_list 203.0.113.1 \ –allow_list 192.0.1.0/24 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • post_databases_postgre_sql_instances_request (PostDatabasesPostgreSqlInstancesRequest) —

    Information about the Managed PostgreSQL Database you are creating.

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

    the optional parameters

Returns:



2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2446

def post_databases_postgre_sql_instances_with_http_info(api_version, post_databases_postgre_sql_instances_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.post_databases_postgre_sql_instances ...'
  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 DatabasesApi.post_databases_postgre_sql_instances"
  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 'post_databases_postgre_sql_instances_request' is set
  if @api_client.config.client_side_validation && post_databases_postgre_sql_instances_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_databases_postgre_sql_instances_request' when calling DatabasesApi.post_databases_postgre_sql_instances"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/postgresql/instances'.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(post_databases_postgre_sql_instances_request)

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

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.post_databases_postgre_sql_instances",
    :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: DatabasesApi#post_databases_postgre_sql_instances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_databases_mysql_instance(api_version, instance_id, put_databases_mysql_instance_request, opts = {}) ⇒ PutDatabasesMysqlInstance200Response

Update a managed MySQL database __This operation is currently only available for customers who already have an active Managed Database.__ Update a Managed MySQL Database. Requires ‘read_write` access to the Database. The Database must have an `active` status to perform this operation. Updating addresses in the `allow_list` overwrites any existing addresses. - IP addresses and ranges in this list can access the Managed Database. All other sources are blocked. - If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database. - Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database. - __Note__. Updates to the `allow_list` may take a short period of time to complete, making this operation inappropriate for rapid successive updates to this property. All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MySQL Database. The maintenance window for these updates is configured with the Managed Database’s ‘updates` property. - If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It’s recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance. - __The database software is not updated automatically.__ To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](www.linode.com/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one. <<LB>> — - __CLI__. “‘ linode-cli databases mysql-update 123 \ –label example-db \ –allow_list 203.0.113.1 \ –allow_list 192.0.1.0/24 \ –type g6-standard-1 \ –updates.frequency monthly \ –updates.duration 3 \ –updates.hour_of_day 12 \ –updates.day_of_week 4 \ –updates.week_of_month 3 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

  • put_databases_mysql_instance_request (PutDatabasesMysqlInstanceRequest) —

    Updated information for the Managed MySQL Database.

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

    the optional parameters

Returns:



2515
2516
2517
2518
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2515

def put_databases_mysql_instance(api_version, instance_id, put_databases_mysql_instance_request, opts = {})
  data, _status_code, _headers = put_databases_mysql_instance_with_http_info(api_version, instance_id, put_databases_mysql_instance_request, opts)
  data
end

#put_databases_mysql_instance_with_http_info(api_version, instance_id, put_databases_mysql_instance_request, opts = {}) ⇒ Array<(PutDatabasesMysqlInstance200Response, Integer, Hash)>

Update a managed MySQL database __This operation is currently only available for customers who already have an active Managed Database.__ Update a Managed MySQL Database. Requires &#x60;read_write&#x60; access to the Database. The Database must have an &#x60;active&#x60; status to perform this operation. Updating addresses in the &#x60;allow_list&#x60; overwrites any existing addresses. - IP addresses and ranges in this list can access the Managed Database. All other sources are blocked. - If &#x60;0.0.0.0/0&#x60; is a value in this list, then all IP addresses can access the Managed Database. - Entering an empty array (&#x60;[]&#x60;) blocks all connections (both public and private) to the Managed Database. - __Note__. Updates to the &#x60;allow_list&#x60; may take a short period of time to complete, making this operation inappropriate for rapid successive updates to this property. All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MySQL Database. The maintenance window for these updates is configured with the Managed Database&#39;s &#x60;updates&#x60; property. - If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It&#39;s recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance. - __The database software is not updated automatically.__ To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then [migrate your databases](www.linode.com/docs/products/databases/managed-databases/guides/migrate-mysql/) from the original Managed Database cluster to the new one. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases mysql-update 123 \ –label example-db \ –allow_list 203.0.113.1 \ –allow_list 192.0.1.0/24 \ –type g6-standard-1 \ –updates.frequency monthly \ –updates.duration 3 \ –updates.hour_of_day 12 \ –updates.day_of_week 4 \ –updates.week_of_month 3 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

  • put_databases_mysql_instance_request (PutDatabasesMysqlInstanceRequest) —

    Updated information for the Managed MySQL Database.

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

    the optional parameters

Returns:



2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2527

def put_databases_mysql_instance_with_http_info(api_version, instance_id, put_databases_mysql_instance_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.put_databases_mysql_instance ...'
  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 DatabasesApi.put_databases_mysql_instance"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.put_databases_mysql_instance"
  end
  # verify the required parameter 'put_databases_mysql_instance_request' is set
  if @api_client.config.client_side_validation && put_databases_mysql_instance_request.nil?
    fail ArgumentError, "Missing the required parameter 'put_databases_mysql_instance_request' when calling DatabasesApi.put_databases_mysql_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/mysql/instances/{instanceId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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(put_databases_mysql_instance_request)

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

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.put_databases_mysql_instance",
    :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: DatabasesApi#put_databases_mysql_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_databases_postgre_sql_instance(api_version, instance_id, put_databases_postgre_sql_instance_request, opts = {}) ⇒ PutDatabasesPostgreSqlInstance200Response

Update a managed PostgreSQL database __This operation is currently only available for customers who already have an active Managed Database.__ Update a Managed PostgreSQL Database. Requires ‘read_write` access to the Database. The Database must have an `active` status to perform this operation. Updating addresses in the `allow_list` overwrites any existing addresses. - IP addresses and ranges in this list can access the Managed Database. All other sources are blocked. - If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database. - Entering an empty array (`[]`) blocks all connections (both public and private) to the Managed Database. - __Note__. Updates to the `allow_list` may take a short period of time to complete, making this operation inappropriate for rapid successive updates to this property. All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database. The maintenance window for these updates is configured with the Managed Database’s ‘updates` property. - If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It’s recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance. - __The database software is not updated automatically.__ To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one. <<LB>> — - __CLI__. “‘ linode-cli databases postgresql-update 123 \ –label example-db \ –allow_list 203.0.113.1 \ –allow_list 192.0.1.0/24 \ –type g6-standard-1 \ –updates.frequency monthly \ –updates.duration 3 \ –updates.hour_of_day 12 \ –updates.day_of_week 4 \ –updates.week_of_month 3 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

  • put_databases_postgre_sql_instance_request (PutDatabasesPostgreSqlInstanceRequest) —

    Updated information for the Managed PostgreSQL Database.

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

    the optional parameters

Returns:



2600
2601
2602
2603
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2600

def put_databases_postgre_sql_instance(api_version, instance_id, put_databases_postgre_sql_instance_request, opts = {})
  data, _status_code, _headers = put_databases_postgre_sql_instance_with_http_info(api_version, instance_id, put_databases_postgre_sql_instance_request, opts)
  data
end

#put_databases_postgre_sql_instance_with_http_info(api_version, instance_id, put_databases_postgre_sql_instance_request, opts = {}) ⇒ Array<(PutDatabasesPostgreSqlInstance200Response, Integer, Hash)>

Update a managed PostgreSQL database __This operation is currently only available for customers who already have an active Managed Database.__ Update a Managed PostgreSQL Database. Requires &#x60;read_write&#x60; access to the Database. The Database must have an &#x60;active&#x60; status to perform this operation. Updating addresses in the &#x60;allow_list&#x60; overwrites any existing addresses. - IP addresses and ranges in this list can access the Managed Database. All other sources are blocked. - If &#x60;0.0.0.0/0&#x60; is a value in this list, then all IP addresses can access the Managed Database. - Entering an empty array (&#x60;[]&#x60;) blocks all connections (both public and private) to the Managed Database. - __Note__. Updates to the &#x60;allow_list&#x60; may take a short period of time to complete, making this operation inappropriate for rapid successive updates to this property. All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed PostgreSQL Database. The maintenance window for these updates is configured with the Managed Database&#39;s &#x60;updates&#x60; property. - If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It&#39;s recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance. - __The database software is not updated automatically.__ To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli databases postgresql-update 123 \ –label example-db \ –allow_list 203.0.113.1 \ –allow_list 192.0.1.0/24 \ –type g6-standard-1 \ –updates.frequency monthly \ –updates.duration 3 \ –updates.hour_of_day 12 \ –updates.day_of_week 4 \ –updates.week_of_month 3 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; databases: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.

  • instance_id (Integer) —

    The ID of the Managed PostgreSQL Database.

  • put_databases_postgre_sql_instance_request (PutDatabasesPostgreSqlInstanceRequest) —

    Updated information for the Managed PostgreSQL Database.

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

    the optional parameters

Returns:



2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
 
# File 'lib/linode_openapi_client/api/databases_api.rb', line 2612

def put_databases_postgre_sql_instance_with_http_info(api_version, instance_id, put_databases_postgre_sql_instance_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesApi.put_databases_postgre_sql_instance ...'
  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 DatabasesApi.put_databases_postgre_sql_instance"
  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 'instance_id' is set
  if @api_client.config.client_side_validation && instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'instance_id' when calling DatabasesApi.put_databases_postgre_sql_instance"
  end
  # verify the required parameter 'put_databases_postgre_sql_instance_request' is set
  if @api_client.config.client_side_validation && put_databases_postgre_sql_instance_request.nil?
    fail ArgumentError, "Missing the required parameter 'put_databases_postgre_sql_instance_request' when calling DatabasesApi.put_databases_postgre_sql_instance"
  end
  # resource path
  local_var_path = '/{apiVersion}/databases/postgresql/instances/{instanceId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'instanceId' + '}', CGI.escape(instance_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(put_databases_postgre_sql_instance_request)

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

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

  new_options = opts.merge(
    :operation => :"DatabasesApi.put_databases_postgre_sql_instance",
    :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: DatabasesApi#put_databases_postgre_sql_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end