cURL
curl --request POST \
--url https://us.infisical.com/api/v1/app-connections/mysql \
--header 'Content-Type: application/json' \
--data '
{
"method": "username-and-password",
"credentials": {
"host": "<string>",
"port": 123,
"database": "<string>",
"username": "<string>",
"password": "<string>",
"sslEnabled": true,
"sslRejectUnauthorized": true,
"sslCertificate": "<string>"
},
"name": "<string>",
"description": "<string>",
"projectId": "<string>",
"isPlatformManagedCredentials": false,
"gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"gatewayPoolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isAutoRotationEnabled": false,
"rotation": "<unknown>"
}
'import requests
url = "https://us.infisical.com/api/v1/app-connections/mysql"
payload = {
"method": "username-and-password",
"credentials": {
"host": "<string>",
"port": 123,
"database": "<string>",
"username": "<string>",
"password": "<string>",
"sslEnabled": True,
"sslRejectUnauthorized": True,
"sslCertificate": "<string>"
},
"name": "<string>",
"description": "<string>",
"projectId": "<string>",
"isPlatformManagedCredentials": False,
"gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"gatewayPoolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isAutoRotationEnabled": False,
"rotation": "<unknown>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'username-and-password',
credentials: {
host: '<string>',
port: 123,
database: '<string>',
username: '<string>',
password: '<string>',
sslEnabled: true,
sslRejectUnauthorized: true,
sslCertificate: '<string>'
},
name: '<string>',
description: '<string>',
projectId: '<string>',
isPlatformManagedCredentials: false,
gatewayId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
gatewayPoolId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
isAutoRotationEnabled: false,
rotation: '<unknown>'
})
};
fetch('https://us.infisical.com/api/v1/app-connections/mysql', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://us.infisical.com/api/v1/app-connections/mysql",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'username-and-password',
'credentials' => [
'host' => '<string>',
'port' => 123,
'database' => '<string>',
'username' => '<string>',
'password' => '<string>',
'sslEnabled' => true,
'sslRejectUnauthorized' => true,
'sslCertificate' => '<string>'
],
'name' => '<string>',
'description' => '<string>',
'projectId' => '<string>',
'isPlatformManagedCredentials' => false,
'gatewayId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'gatewayPoolId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'isAutoRotationEnabled' => false,
'rotation' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://us.infisical.com/api/v1/app-connections/mysql"
payload := strings.NewReader("{\n \"method\": \"username-and-password\",\n \"credentials\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"database\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"sslEnabled\": true,\n \"sslRejectUnauthorized\": true,\n \"sslCertificate\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"projectId\": \"<string>\",\n \"isPlatformManagedCredentials\": false,\n \"gatewayId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"gatewayPoolId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"isAutoRotationEnabled\": false,\n \"rotation\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://us.infisical.com/api/v1/app-connections/mysql")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"username-and-password\",\n \"credentials\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"database\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"sslEnabled\": true,\n \"sslRejectUnauthorized\": true,\n \"sslCertificate\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"projectId\": \"<string>\",\n \"isPlatformManagedCredentials\": false,\n \"gatewayId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"gatewayPoolId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"isAutoRotationEnabled\": false,\n \"rotation\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.infisical.com/api/v1/app-connections/mysql")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"username-and-password\",\n \"credentials\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"database\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"sslEnabled\": true,\n \"sslRejectUnauthorized\": true,\n \"sslCertificate\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"projectId\": \"<string>\",\n \"isPlatformManagedCredentials\": false,\n \"gatewayId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"gatewayPoolId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"isAutoRotationEnabled\": false,\n \"rotation\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"appConnection": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"app": "mysql",
"method": "username-and-password",
"credentials": {
"host": "<string>",
"database": "<string>",
"port": 123,
"username": "<string>",
"sslEnabled": true,
"sslRejectUnauthorized": true,
"sslCertificate": "<string>"
},
"description": "<string>",
"version": 1,
"isPlatformManagedCredentials": false,
"gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "<string>",
"isAutoRotationEnabled": false,
"gatewayPoolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rotation": {
"rotationInterval": 123,
"rotateAtUtc": {
"hours": 123,
"minutes": 123
},
"lastRotationMessage": "<string>",
"nextRotationAt": "2023-11-07T05:31:56Z"
},
"credentialsHash": "<string>",
"project": {
"name": "<string>",
"id": "<string>",
"type": "<string>",
"slug": "<string>"
}
}
}{
"reqId": "<string>",
"statusCode": 400,
"message": "<string>",
"error": "<string>",
"details": "<unknown>"
}{
"reqId": "<string>",
"statusCode": 401,
"message": "<string>",
"error": "<string>"
}{
"reqId": "<string>",
"statusCode": 403,
"message": "<string>",
"error": "<string>",
"details": "<unknown>"
}{
"reqId": "<string>",
"statusCode": 404,
"message": "<string>",
"error": "<string>"
}{
"reqId": "<string>",
"statusCode": 422,
"error": "<string>",
"message": "<unknown>"
}{
"reqId": "<string>",
"statusCode": 500,
"message": "<string>",
"error": "<string>"
}MySQL
Create
Create a MySQL Connection.
POST
/
api
/
v1
/
app-connections
/
mysql
cURL
curl --request POST \
--url https://us.infisical.com/api/v1/app-connections/mysql \
--header 'Content-Type: application/json' \
--data '
{
"method": "username-and-password",
"credentials": {
"host": "<string>",
"port": 123,
"database": "<string>",
"username": "<string>",
"password": "<string>",
"sslEnabled": true,
"sslRejectUnauthorized": true,
"sslCertificate": "<string>"
},
"name": "<string>",
"description": "<string>",
"projectId": "<string>",
"isPlatformManagedCredentials": false,
"gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"gatewayPoolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isAutoRotationEnabled": false,
"rotation": "<unknown>"
}
'import requests
url = "https://us.infisical.com/api/v1/app-connections/mysql"
payload = {
"method": "username-and-password",
"credentials": {
"host": "<string>",
"port": 123,
"database": "<string>",
"username": "<string>",
"password": "<string>",
"sslEnabled": True,
"sslRejectUnauthorized": True,
"sslCertificate": "<string>"
},
"name": "<string>",
"description": "<string>",
"projectId": "<string>",
"isPlatformManagedCredentials": False,
"gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"gatewayPoolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isAutoRotationEnabled": False,
"rotation": "<unknown>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'username-and-password',
credentials: {
host: '<string>',
port: 123,
database: '<string>',
username: '<string>',
password: '<string>',
sslEnabled: true,
sslRejectUnauthorized: true,
sslCertificate: '<string>'
},
name: '<string>',
description: '<string>',
projectId: '<string>',
isPlatformManagedCredentials: false,
gatewayId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
gatewayPoolId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
isAutoRotationEnabled: false,
rotation: '<unknown>'
})
};
fetch('https://us.infisical.com/api/v1/app-connections/mysql', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://us.infisical.com/api/v1/app-connections/mysql",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'username-and-password',
'credentials' => [
'host' => '<string>',
'port' => 123,
'database' => '<string>',
'username' => '<string>',
'password' => '<string>',
'sslEnabled' => true,
'sslRejectUnauthorized' => true,
'sslCertificate' => '<string>'
],
'name' => '<string>',
'description' => '<string>',
'projectId' => '<string>',
'isPlatformManagedCredentials' => false,
'gatewayId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'gatewayPoolId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'isAutoRotationEnabled' => false,
'rotation' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://us.infisical.com/api/v1/app-connections/mysql"
payload := strings.NewReader("{\n \"method\": \"username-and-password\",\n \"credentials\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"database\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"sslEnabled\": true,\n \"sslRejectUnauthorized\": true,\n \"sslCertificate\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"projectId\": \"<string>\",\n \"isPlatformManagedCredentials\": false,\n \"gatewayId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"gatewayPoolId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"isAutoRotationEnabled\": false,\n \"rotation\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://us.infisical.com/api/v1/app-connections/mysql")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"username-and-password\",\n \"credentials\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"database\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"sslEnabled\": true,\n \"sslRejectUnauthorized\": true,\n \"sslCertificate\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"projectId\": \"<string>\",\n \"isPlatformManagedCredentials\": false,\n \"gatewayId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"gatewayPoolId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"isAutoRotationEnabled\": false,\n \"rotation\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.infisical.com/api/v1/app-connections/mysql")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"username-and-password\",\n \"credentials\": {\n \"host\": \"<string>\",\n \"port\": 123,\n \"database\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"sslEnabled\": true,\n \"sslRejectUnauthorized\": true,\n \"sslCertificate\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"projectId\": \"<string>\",\n \"isPlatformManagedCredentials\": false,\n \"gatewayId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"gatewayPoolId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"isAutoRotationEnabled\": false,\n \"rotation\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"appConnection": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"app": "mysql",
"method": "username-and-password",
"credentials": {
"host": "<string>",
"database": "<string>",
"port": 123,
"username": "<string>",
"sslEnabled": true,
"sslRejectUnauthorized": true,
"sslCertificate": "<string>"
},
"description": "<string>",
"version": 1,
"isPlatformManagedCredentials": false,
"gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "<string>",
"isAutoRotationEnabled": false,
"gatewayPoolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rotation": {
"rotationInterval": 123,
"rotateAtUtc": {
"hours": 123,
"minutes": 123
},
"lastRotationMessage": "<string>",
"nextRotationAt": "2023-11-07T05:31:56Z"
},
"credentialsHash": "<string>",
"project": {
"name": "<string>",
"id": "<string>",
"type": "<string>",
"slug": "<string>"
}
}
}{
"reqId": "<string>",
"statusCode": 400,
"message": "<string>",
"error": "<string>",
"details": "<unknown>"
}{
"reqId": "<string>",
"statusCode": 401,
"message": "<string>",
"error": "<string>"
}{
"reqId": "<string>",
"statusCode": 403,
"message": "<string>",
"error": "<string>",
"details": "<unknown>"
}{
"reqId": "<string>",
"statusCode": 404,
"message": "<string>",
"error": "<string>"
}{
"reqId": "<string>",
"statusCode": 422,
"error": "<string>",
"message": "<unknown>"
}{
"reqId": "<string>",
"statusCode": 500,
"message": "<string>",
"error": "<string>"
}Check out the configuration docs for MySQL Connections to learn how to obtain the required credentials.
Body
application/json
The method used to authenticate with MySQL.
Available options:
username-and-password The credentials used to connect with MySQL.
Show child attributes
Show child attributes
The name of the MySQL Connection to create. Must be slug-friendly.
Required string length:
1 - 64An optional description for the MySQL Connection.
Maximum string length:
256The ID of the project to create the MySQL Connection in.
Whether or not the MySQL Connection credentials should be managed by Infisical. Once enabled this cannot be reversed.
The Gateway ID to use for this connection.
The Gateway Pool ID to use for this connection.
Not supported for MySQL Connections.
Available options:
false Not supported for MySQL Connections.
Response
Default Response
Show child attributes
Show child attributes
Was this page helpful?
⌘I