Overview
- Introduction
- Authentication
- Examples
Endpoints
- Identities
- Token Auth
- Universal Auth
- GCP Auth
- AWS Auth
- Azure Auth
- Kubernetes Auth
- OIDC Auth
- JWT Auth
- Groups
- Organizations
- Projects
- Project Users
- Project Groups
- Project Identities
- Project Roles
- Project Templates
- Environments
- Folders
- Secret Tags
- Secrets
- Dynamic Secrets
- Secret Imports
- Secret Rotations
- Identity Specific Privilege
- App Connections
- GETList
- GETOptions
- Auth0
- AWS
- Azure App Configuration
- Azure Client Secret
- Azure Key Vault
- Camunda
- Databricks
- GCP
- GitHub
- Hashicorp Vault
- Humanitec
- LDAP
- Microsoft SQL Server
- PostgreSQL
- TeamCity
- Terraform Cloud
- Vercel
- Windmill
- GET
- Secret Syncs
- Integrations
- Service Tokens
- Audit Logs
Infisical PKI
- Certificate Authorities
- Certificates
- Certificate Templates
- Certificate Collections
- PKI Alerting
Infisical SSH
- Hosts
- Host Groups
- Certificates
- Certificate Authorities
- Certificate Templates
Infisical KMS
- Keys
- Encryption
- Signing
Update
Update the specified Microsoft SQL Server Connection.
curl --request PATCH \
--url https://us.infisical.com/api/v1/app-connections/mssql/{connectionId} \
--header 'Content-Type: application/json' \
--data '{
"credentials": {
"host": "<string>",
"port": 123,
"database": "<string>",
"username": "<string>",
"password": "<string>",
"sslEnabled": true,
"sslRejectUnauthorized": true,
"sslCertificate": "<string>"
},
"name": "<string>",
"description": "<string>",
"isPlatformManagedCredentials": true
}'
{
"appConnection": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"version": 1,
"orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isPlatformManagedCredentials": false,
"credentialsHash": "<string>",
"app": "mssql",
"method": "username-and-password",
"credentials": {
"host": "<string>",
"database": "<string>",
"port": 123,
"username": "<string>",
"sslEnabled": true,
"sslRejectUnauthorized": true,
"sslCertificate": "<string>"
}
}
}
Check out the configuration docs for Microsoft SQL Server Connections to learn how to obtain the required credentials.
Path Parameters
The ID of the Microsoft SQL Server Connection to be updated.
Body
The credentials used to connect with Microsoft SQL Server.
The hostname of the database server.
1
The port number of the database.
The name of the database to connect to.
1
The username to connect to the database with.
1
The password to connect to the database with.
1
Whether or not to use SSL when connecting to the database.
Whether or not to reject unauthorized SSL certificates.
The SSL certificate to use for connection.
The updated name of the Microsoft SQL Server Connection. Must be slug-friendly.
1 - 32
The updated description of the Microsoft SQL Server Connection.
256
Whether or not the Microsoft SQL Server Connection credentials should be managed by Infisical. Once enabled this cannot be reversed.
Response
mssql
username-and-password
The hostname of the database server.
1
The name of the database to connect to.
1
The port number of the database.
The username to connect to the database with.
1
Whether or not to use SSL when connecting to the database.
Whether or not to reject unauthorized SSL certificates.
The SSL certificate to use for connection.
Was this page helpful?
curl --request PATCH \
--url https://us.infisical.com/api/v1/app-connections/mssql/{connectionId} \
--header 'Content-Type: application/json' \
--data '{
"credentials": {
"host": "<string>",
"port": 123,
"database": "<string>",
"username": "<string>",
"password": "<string>",
"sslEnabled": true,
"sslRejectUnauthorized": true,
"sslCertificate": "<string>"
},
"name": "<string>",
"description": "<string>",
"isPlatformManagedCredentials": true
}'
{
"appConnection": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"version": 1,
"orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isPlatformManagedCredentials": false,
"credentialsHash": "<string>",
"app": "mssql",
"method": "username-and-password",
"credentials": {
"host": "<string>",
"database": "<string>",
"port": 123,
"username": "<string>",
"sslEnabled": true,
"sslRejectUnauthorized": true,
"sslCertificate": "<string>"
}
}
}