Users are profiles to which you can attribute database-level permissions. They allow you to define permissions specific to each type of database usage. For example, users with an admin role can create new databases and users.
List users of a Database Instance
List all users of a given Database Instance. By default, the users returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
path Parameters
regionThe region you want to target
instance_idUUID of the Database Instance.
query Parameters
nameName of the user.
order_byCriteria to use when requesting user listing.
pagepage_sizeList users of a Database Instance › Responses
List of users in a Database Instance.
total_countTotal count of users present on a Database Instance.
Create a user for a Database Instance
Create a new user for a Database Instance. You must define the name, password and is_admin parameters.
path Parameters
regionThe region you want to target
instance_idUUID of the Database Instance in which you want to create a user.
Create a user for a Database Instance › Request Body
nameName of the user you want to create.
passwordPassword of the user you want to create. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
is_adminDefines whether the user will have administrative privileges.
Create a user for a Database Instance › Responses
nameName of the user (Length must be between 1 and 63 characters for PostgreSQL and between 1 and 32 characters for MySQL. First character must be an alphabet character (a-zA-Z). Your username cannot start with 'rdb' or in PostgreSQL, 'pg'. Only a-zA-Z0-9_$- characters are accepted).
is_adminDefines whether or not a user got administrative privileges on the Database Instance.
Delete a user on a Database Instance
Delete a given user on a Database Instance. You must specify, in the endpoint, the region, instance_id and name parameters of the user you want to delete.
path Parameters
regionThe region you want to target
instance_idUUID of the Database Instance to delete the user from.
nameName of the user.
Delete a user on a Database Instance › Responses
Update a user on a Database Instance
Update the parameters of a user on a Database Instance. You can update the password and is_admin parameters, but you cannot change the name of the user.
path Parameters
regionThe region you want to target
instance_idUUID of the Database Instance the user belongs to.
nameName of the database user.
Update a user on a Database Instance › Request Body
passwordPassword of the database user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
is_adminDefines whether or not this user got administrative privileges.
Update a user on a Database Instance › Responses
nameName of the user (Length must be between 1 and 63 characters for PostgreSQL and between 1 and 32 characters for MySQL. First character must be an alphabet character (a-zA-Z). Your username cannot start with 'rdb' or in PostgreSQL, 'pg'. Only a-zA-Z0-9_$- characters are accepted).
is_adminDefines whether or not a user got administrative privileges on the Database Instance.