GET
/
v1
/
instances
/
{instance}
/
roles
/
{role}
{
  "name": "<string>",
  "connectionLimit": 123,
  "validUntil": "<string>",
  "attribute": "<string>"
}

Path Parameters

instance
string
required

The instance id.

role
string
required

The role id.

Response

OK

InstanceRole is the API message for instance role.

name
string

The role name.

connectionLimit
integer

The connection count limit for this role.

validUntil
string

The expiration for the role's password.

attribute
string

The role attribute. For PostgreSQL, it containt super_user, no_inherit, create_role, create_db, can_login, replication and bypass_rls. Docs: https://www.postgresql.org/docs/current/role-attributes.html For MySQL, it's the global privileges as GRANT statements, which means it only contains "GRANT ... ON . TO ...". Docs: https://dev.mysql.com/doc/refman/8.0/en/grant.html