Description:
Creates an external database connections for that system. This is a developer only endpoint.
643 matches
100 actions
ClearBlade
100 actions
Other/ClearBlade
Creates an external database connections for that system. This is a developer only endpoint.
| Database Name | db_type |
|---|---|
| MONGO | mongodb |
| POSTGRES | postgres |
| MYSQL | mysql |
| MSSQL | mssql |
| COUCHDB | couchdb |
| Field | Type | Database | Description | Options | Default |
|---|---|---|---|---|---|
| user | string | All | The external database username | ||
| password | string | All | The external database password | ||
| address | string | All | The external database IP address | ||
| port | string | All | The port used to connect to the external database | 27017 (Mongo), 3306 (MySQL), 5432 (Postgres), 1433 (MSSQL) | |
| dbname | string | All | The name of the external database | ||
| connection_type | string | Mongo | The external database DNS connection type | srv and standard | standard |
| tls | boolean | Mongo and Postgres | Setting the tls to true allows for transport encryption. This field is optional | True and false | True (Mongo) False(Postgres) |
| authMechanism | string | Mongo | Database authentication method. This field is optional | SCRAM-SHA-256, SCRAM-SHA-1, MONGODB-CR, PLAIN, GSSAPI, MONGODB-X509 | SCRAM-SHA-1 |
| authSource | string | Mongo | Database authentication source. This field is optional | admin | |
| replicaSet | string | Mongo | Allows for use of Replication Methods such as rs.reconfig() .This field is optional | empty string | |
| encryption | string | MSSQL | Setting the encryption to true allows for secure encryption | disable and true |
{
"type": "object",
"properties": {
"ClearBlade-DevToken": {
"type": "string"
},
"systemKey": {
"type": "string"
}
},
"required": [
"ClearBlade-DevToken",
"systemKey"
],
"additionalProperties": false
}{
"type": "object",
"additionalProperties": true
}