Create Account

LLM-friendly URL

POST

https://api.luzmo.com/0.1.0/account

API call form

Examples

List of examples

Create a plugin connection
Athena connection creation.
BigQuery connection creation.
Clickhouse connection creation.
Databricks connection creation.
ElasticSearch connection creation.
MariaDB connection creation.
MongoDB connection creation.
MySQL connection creation.
Oracle connection creation.
PostgreSQL connection creation.
Presto connection creation.
Redshift connection creation.
SAP Hana connection creation.
Snowflake connection creation with key-pair authentication.
Snowflake connection creation with username-password authentication.
SQL Server connection creation.
Azure Synapse connection creation.
Trino connection creation.

Description

This will create a connection to a MySQL database. You'll need to provide a host, port, identifier, token and scope:

host: Specify the hostname or IP address of your MySQL database.
port: Specify the port number on which your MySQL database is listening.
scope: Enter the name of your MySQL database.
identifier: Provide the username associated with your MySQL database.
token: Enter the corresponding password for the specified MySQL user.

Notes : To ensure secure access to your MySQL database, it is recommended to whitelist Luzmo's range of IP addresses. You should whitelist Luzmo's range of IP addresses as described here .

Install

npm install @luzmo/nodejs-sdk

Example Request

Shell

Node

Java

.NET

Python

PHP

import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});


const response = await client.create('account',
  {
    provider: "mysql",
    host: "<your host url>",
    port: 3306,
    identifier: "<your username>",
    token: "<your password>",
    scope: "<your database>",
    name: "My MySQL connection"
  }
);

Example Response

200

400

500

{
  "properties": null,
  "date": "2024-08-08T13:19:32.411Z",
  "active": true,
  "invalid": false,
  "cache": 0,
  "synced": false,
  "datasets_meta_sync_interval": 1,
  "datasets_meta_sync_enabled": true,
  "provider": "mysql",
  "host": "<your host>",
  "port": "3306",
  "identifier": "<your username>",
  "scope": "<your database>",
  "name": "My MySQL connection",
  "id": "ee5e0ca7-89a7-442d-9ca3-1d1290e57213",
  "user_id": "abca9830-0dad-4b11-a6d4-23972c124020",
  "updated_at": "2024-08-08T13:19:32.483Z",
  "created_at": "2024-08-08T13:19:32.446Z",
  "expiry": null,
  "description": null,
  "version": null,
  "plugin_id": null,
  "shareable_id": "d9b4c3e7-9410-4688-9455-2a35c7d87c68"
}