Sign inGet started
Docs
Get started

MySQL API Authentication

How to authenticate MySQL API requests: one Bearer API key plus a connectionId. MindCloud handles MySQL's custom auth scheme for you.

Every MySQL API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your MySQL account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

  1. Create a MindCloud account at app.mindcloud.co if you do not already have one.
  2. Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
  3. Create a MySQL connection in Connections. MySQL uses its own authentication scheme. You provide whatever it requires when you create the connection — MindCloud handles the provider-specific details for you.
  4. Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected MySQL account that should run the action. MindCloud stores and refreshes the MySQL credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling with an MySQL connection looks like this:

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which MySQL account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Set up your MySQL connection

You need the MySQL host name, database name, username, and password for the database account MindCloud should use. If the server is remote, make sure it accepts TCP/IP connections from your allowed network path.

  1. Collect the MySQL connection details

    Get the Host, Database, User, and Password values for the MySQL database you want MindCloud to access.

  2. Choose the port

    If your administrator did not provide a custom port, use the standard MySQL TCP port 3306.

  3. Enter the connection fields in MindCloud

    In the MindCloud MySQL connection form, enter the Host, Port, Database, User, Password, Timeout, and Use ODBC values that match your MySQL environment.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.