hyperdrive_hyperdrive-origin

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
access_client_id	string	The Client ID of the Access token to use when connecting to the origin database
database	string	The name of your origin database.
host	string	The host (hostname or IP) of your origin database.
port	integer	The port (default: 5432 for Postgres) of your origin database.
scheme	object
user	string	The user of your origin database.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/hyperdrive_hyperdrive-origin",
  "title": "hyperdrive_hyperdrive-origin",
  "properties": {
    "access_client_id": {
      "description": "The Client ID of the Access token to use when connecting to the origin database",
      "example": "0123456789abcdef0123456789abcdef.access",
      "type": "string"
    },
    "database": {
      "description": "The name of your origin database.",
      "example": "postgres",
      "type": "string"
    },
    "host": {
      "description": "The host (hostname or IP) of your origin database.",
      "example": "database.example.com",
      "type": "string"
    },
    "port": {
      "description": "The port (default: 5432 for Postgres) of your origin database.",
      "example": "5432",
      "type": "integer"
    },
    "scheme": {
      "$ref": "#/components/schemas/hyperdrive_hyperdrive-scheme"
    },
    "user": {
      "description": "The user of your origin database.",
      "example": "postgres",
      "type": "string"
    }
  },
  "required": [
    "host",
    "scheme",
    "database",
    "user"
  ],
  "type": "object"
}