API Reference
  1. Database Optimizer
  2. DatabaseInstancesAPI

Update a database instance

patch
https://api.cast.ai/database-optimizer/database-instances/v1alpha/organizations//database-instances/

Update a database instance

Partially updates a manually created database instance. Only the fields
present in the request (name, endpoints) are updated; omitted fields are
left unchanged. Cloud-synced instances cannot be updated via this API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Organization identifier

string
required

Database instance identifier

Body Params

Request to update a database instance

string

New name of the database instance. Omitted leaves the name unchanged.
Must not be empty when provided.

endpoints
array of objects

New list of upstream database endpoints. Omitted or empty leaves the
endpoints unchanged; an instance cannot be left with no endpoints.

endpoints
Responses

Updated last month

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated last month

Did this page help you?