pydo.databases.add()
Generated on 25 November 2024
from pydo
version v0.6.0
Description
To add a new database to an existing cluster, send a POST request to
/v2/databases/$DATABASE_ID/dbs
.
Note: Database management is not supported for Redis clusters.
The response will be a JSON object with a key called db
. The value of this will be
an object that contains the standard attributes associated with a database.
Parameters
Name
Type
Required
Description
Default Value
database_cluster_uuid
string
True
A unique identifier for a database cluster.
body
JSON or IO[bytes]
True
Request Sample
import os
from pydo import Client
client = Client ( token = os . environ . get ( "DIGITALOCEAN_TOKEN" ))
add_resp = client . databases . add ( database_cluster_uuid = "9cc10173" , body = { "name" : "alpha" })
Responses
See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.
A JSON object with a key of db
.
Click to expand an example response.
{
"db" : {
"name" : "alpha"
}
}
Unauthorized
Click to expand an example response.
{
"id" : "unauthorized" ,
"message" : "Unable to authenticate you."
}
The resource was not found.
Click to expand an example response.
{
"id" : "not_found" ,
"message" : "The resource you requested could not be found."
}
API Rate limit exceeded
Click to expand an example response.
{
"id" : "too_many_requests" ,
"message" : "API Rate limit exceeded."
}
Server error.
Click to expand an example response.
{
"id" : "server_error" ,
"message" : "Unexpected server-side error"
}
Unexpected error
Click to expand an example response.
{
"id" : "example_error" ,
"message" : "some error message"
}