Databases can be used to store and manage sets of structured information, or data. The interaction between the user and a database is done using a Database Engine, which provides a structured query language to add, modify or delete information from the database.
List databases in a Database Instance
List all databases of a given Database Instance. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as name, managed and owner.
path Parameters
regionThe region you want to target
instance_idUUID of the Database Instance to list the databases of.
query Parameters
nameName of the database.
managedDefines whether or not the database is managed.
ownerUser that owns this database.
order_byCriteria to use when ordering database listing.
skip_size_retrievalWhether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
pagepage_sizeList databases in a Database Instance › Responses
List of the databases.
total_countTotal count of databases present on a Database Instance.
Create a database in a Database Instance
Create a new database. You must define the name parameter in the request.
path Parameters
regionThe region you want to target
instance_idUUID of the Database Instance where to create the database.
Create a database in a Database Instance › Responses
nameName of the database.
ownerName of the database owner.
managedDefines whether the database is managed or not.
sizeSize of the database. Set to 0 if the size retrieval is too time-consuming or skip_size_retrieval is set to true. (in bytes)
Delete a database in a Database Instance
Delete a given database on a Database Instance. You must specify, in the endpoint, the region, instance_id and name parameters of the database you want to delete.
path Parameters
regionThe region you want to target
instance_idUUID of the Database Instance where to delete the database.
nameName of the database to delete.