planetscale · Schema

RoleCredentials

Role-based credentials for accessing a database branch.

Properties

Name	Type	Description
id	string	The unique identifier of the role credentials.
name	string	The name of the role.
role	string	The access level of the role.
username	string	The username for connecting.
password	string	The password for connecting. Only returned during creation.
hostname	string	The hostname for connecting.
created_at	string	The timestamp when the role was created.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RoleCredentials",
  "title": "RoleCredentials",
  "type": "object",
  "description": "Role-based credentials for accessing a database branch.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the role credentials."
    },
    "name": {
      "type": "string",
      "description": "The name of the role."
    },
    "role": {
      "type": "string",
      "description": "The access level of the role."
    },
    "username": {
      "type": "string",
      "description": "The username for connecting."
    },
    "password": {
      "type": "string",
      "description": "The password for connecting. Only returned during creation."
    },
    "hostname": {
      "type": "string",
      "description": "The hostname for connecting."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The timestamp when the role was created."
    }
  }
}