Connection profile samples for supported databases

Edit online

This topic provides some sample JSON payloads for creating connection profiles using the IBM® Optim Archive API.

Not all supported databases have corresponding samples in this topic. For the full list of supported connection types, see Supported data sources and targets.

Some connection types have limitations. For more information, see Known issues and limitations.

Tech preview Some connections are provided as technical previews. Technical preview connections are not fully supported by IBM and should not be used in production environments. Use technical previews to evaluate and test new connectivity options in your development environment while IBM completes end-to-end validation.

Connection profile structure

All connection profiles follow a common structure:

{
  "connection": {
    "name": "<connectionName>",
    "ref": "<optionalReference>",
    "properties": {
      "type": "<databaseType>",
      "host": "<hostname>",
      "port": "<port>",
      "database": "<databaseName>",
      "username": "<username>",
      "password": "<password>",
      "ssl": "<true|false>",
      "description": "<optionalDescription>",
      "ssl_certificate": "<base64EncodedCert>",
      "ssl_certificate_validation": "<true|false>",
      "account_name": "<SnowflakeOnly>",
      "warehouse": "<SnowflakeOnly>",
      "auth_database": "<MongoDBOnly>"
    }
  }
}
Note:
  • ssl_certificate must be a base64-encoded PEM string.
  • ssl_certificate_validation is optional and depends on the client SSL mode.
  • Some fields like warehouse, account_name, and auth_database are specific to certain databases, such as Snowflake and MongoDB.

The following examples show how to construct connection profiles for a selection of the supported database types. The examples include both SSL and non-SSL configurations to guide you in adapting the payload to your environment.

IBM Db2

SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "db2",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl": "true",
      "ssl_certificate": "string"
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "db2",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "ssl": "false",
      "description": "string"
    }
  }
}

PostgreSQL

SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "postgresql",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl": "true",
      "ssl_certificate": "string",
      "ssl_certificate_validation": "string" 
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "postgresql",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "ssl": "false",
      "description": "string"
    }
  }
}

Oracle database

SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "oracle",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl": "true",
      "ssl_certificate": "string",
      "ssl_certificate_validation": "string" 
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "oracle",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "ssl": "false",
      "description": "string"
    }
  }
}

Snowflake

SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "snowflake",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "warehouse": "warehouse",
      "account_name": "account_name",
      "ssl": "true",
      "ssl_certificate": "string"
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "snowflake",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "warehouse": "warehouse",
      "account_name": "account_name"
    }
  }
}

MongoDB

SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "mongodb",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "auth_database": "admin",
      "ssl": "true",
      "ssl_certificate_validation": "true", 
      "ssl_certificate": "string"
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "mongodb",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl": "false",
      "auth_database": "admin"
    }
  }
}

Microsoft SQL Server

SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "sqlserver",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl": "true",
      "ssl_certificate": "string"
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "sqlserver",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "ssl": "false",
      "description": "string"
    }
  }
}

IBM Netezza® Performance Server

SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "netezza",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl": "true",
      "ssl_certificate": "string"
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "netezza",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "ssl": "false",
      "description": "string"
    }
  }
}

Teradata

SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "teradata",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "authentication_method":"td2",
      "description": "string",
      "ssl": "true",
      "ssl_certificate": "string"
    }
  }
}
Note: The authentication_method parameter is optional.
Non-SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "teradata",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "authentication_method":"td2",
      "password": "password",
      "ssl": "false",
      "description": "string"
    }
  }
}
Note: The authentication_method parameter is optional.

SAP Adaptive Server Enterprise

SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "sybase",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl": "true",
      "ssl_certificate": "string"
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "sybase",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "username": "dbadmin-user",
      "password": "password",
      "ssl": "false",
      "description": "string"
    }
  }
}

IBM Informix®

SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "informix",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "server": "testServer",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl": "true",
      "ssl_certificate": "string"
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "sampleDb",
    "ref": "string",
    "properties": {
      "type": "informix",
      "host": "db.example.com",
      "port": "95249",
      "database": "testDb123",
      "server": "testServer",
      "username": "dbadmin-user",
      "password": "password",
      "ssl": "false",
      "description": "string"
    }
  }
}

AlloyDB for PostgreSQL

Tech preview

The connection type for AlloyDB for PostgreSQL instances is postgresql-alloydb.

SSL must be defined as true by default.

SSL example
{
  "connection": {
    "name": "postgresql-alloydb-connection-example",
    "ref": "string",
    "properties": {
      "database": "database-name",
      "host": "db.example.com",
      "port": "5432",
      "type": "postgresql-alloydb",
      "ssl": "true",
      "username": "dbadmin-user",
      "password": "password"
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "postgresql-alloydb-connection-example",
    "ref": "string",
    "properties": {
      "database": "database-name",
      "host": "db.example.com",
      "port": "5432",
      "type": "postgresql-alloydb",
      "ssl": "false",
      "username": "dbadmin-user",
      "password": "password"
    }
  }
}

Amazon Aurora for MySQL

Tech preview

SSL example
{
  "connection": {
    "name": "test-aurora-mysql",
    "ref": "string",
    "properties": {
      "type": "mysql-aurora",
      "host": "aurora-mysql.cluster-example.region.rds.amazonaws.com",
      "port": "3306",
      "database": "test_db",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl": "true",
      "ssl_certificate": "certificate"
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "test-aurora-mysql",
    "ref": "string",
    "properties": {
      "type": "mysql-aurora",
      "host": "aurora-mysql.cluster-example.region.rds.amazonaws.com",
      "port": "3306",
      "database": "test_db",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl": "false"
    }
  }
}

Amazon Aurora for PostgreSQL

Tech preview

SSL example

The connector supports SSL-enabled connections (ssl=true) without requiring users to provide an SSL certificate.

{
  "connection": {
    "name": "test-aurora-postgresql",
    "ref": "string",
    "properties": {
      "type": "postgresql-aurora",
      "host": "aurora-postgrsql.cluster-example.region.rds.amazonaws.com",
      "port": "5432",
      "database": "test_db",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl": "true",
      "ssl_certificate": "certificate"
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "test-aurora-postgresql",
    "ref": "string",
    "properties": {
      "type": "postgresql-aurora",
      "host": "aurora-postgrsql.cluster-example.region.rds.amazonaws.com",
      "port": "5432",
      "database": "test_db",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl": "false",
      "ssl_certificate": ""
    }
  }
}

Amazon RDS for MySQL

Tech preview

The connection type for Amazon RDS MySQL instances is mysql-amazon.

Example
{
  "connection": {
    "name": "mysql-rds-connection-example",
    "ref": "string",
    "properties": {
      "host": "your-rds-instance.example.us-east-1.rds.amazonaws.com",
      "port": "3306",
      "type": "mysql-amazon",
      "database": "your_database_name",
      "username": "dbadmin-user",
      "password": "password"
    }
  }
}

Amazon RDS for Oracle

Tech preview

The connection type for Amazon RDS Oracle instances is oracle-amazon.

The connection_mode property specifies whether to use a SID or service name, and determines whether the corresponding sid or service_name property should be provided.

SID example
{
  "connection": {
    "name": "oracle-rds-connection-example",
    "ref": "string",
    "properties": {
      "host": "your-rds-instance.xxxxxxxxxxxx.us-east-1.rds.amazonaws.com",
      "port": "1521",
      "type": "oracle-amazon",
      "connection_mode": "sid",
      "sid": "your_sid",
      "username": "dbadmin-user",
      "password": "password"
    }
  }
}

Microsoft Azure SQL

Tech preview

In the Microsoft Azure SQL connection JSON, the auth_method parameter is optional. If not provided, the default value is "user_credentials".
  • For Azure Active Directory user authentication, set the following auth_method, then provide the user name and password.
    "auth_method":
      "entra_id_user"
  • For Entra ID Service Principal authentication, set the following auth_method, then provide the client_id and client_secret.
    "auth_method":
      "entra_id_service"
SSL example
{
  "connection": {
    "name": "azure-sql-src",
    "ref": "string",
    "properties": {
      "type": "azuresql",
      "host": "db.example.windows.net",
      "port": "1433",
      "database": "dbName",
      "username": "dbadmin-user",
      "password": "password",
      "auth_method": "user_credentials",
      "description": "string",
      "ssl": "true",
      "ssl_certificate": "certificate",
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "azure-sql-src",
    "ref": "string",
    "properties": {
      "type": "azuresql",
      "host": "db.example.windows.net",
      "port": "1433",
      "database": "dbName",
      "username": "dbadmin-user",
      "password": "password",
      "auth_method": "user_credentials",
      "description": "string",
      "ssl": "false",
      "ssl_certificate": "",
    }
  }
}

IBM Cloud® Databases for PostgreSQL

Tech preview

SSL example
{
  "connection": {
    "name": "ibm-pgsql-src",
    "ref": "string",
    "properties": {
      "type": "postgresql-ibmcloud",
      "host": "db.example.appdomain.cloud",
      "port": "31705",
      "database": "dbName",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl": "true",
      "ssl_certificate": "<certificate>"
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "ibm-pgsql-src",
    "ref": "string",
    "properties": {
      "type": "postgresql-ibmcloud",
      "host": "db.example.appdomain.cloud",
      "port": "31705",
      "database": "dbName",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl": "false",
      "ssl_certificate": ""
    }
  }
}

IBM Db2 for i

Tech preview

The IBM Db2® for i connector uses the JT400 JDBC driver for connectivity to IBM Db2 for i systems.

Restriction: Source tables with lowercase or mixed-case names, such as employee_test or FinancialInfo2_test, are not supported. Jobs that include such a table fail. Rename the source table to use an uppercase name before you run a job.
SSL example
Important: When SSL certificate validation is enabled, the JT400 driver requires CA-signed certificates. Self-signed certificates are not supported.
{
  "connection": {
    "name": "IBM_Db2_i_Connection",
    "properties": {
      "db2i_driver": "jt400",
      "host": "db.example.com",
      "port": "8471",
      "database": "dbName",
      "type": "db2iseries",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl" : "true",
      "ssl_certificate": "certificate"
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "IBM_Db2_i_Connection",
    "properties": {
      "db2i_driver": "jt400",
      "host": "db.example.com",
      "port": "8471",
      "database": "dbName",
      "type": "db2iseries",
      "username": "dbadmin-user",
      "password": "password",
      "description": "string",
      "ssl" : "false"
    }
  }
}

IBM Db2 on Cloud

Tech preview

The connection type for IBM Db2 on Cloud is db2cloud. The IBM Db2 for Cloud connector provides support for IBM Db2 on Cloud as both a source and target.

You can enable SSL by setting ssl=true. Db2 on Cloud typically uses port 50000 for standard connections and port 50001 for SSL connections, but you can configure custom ports.

SSL example
{
  "connection": {
    "name": "db2-cloud-connection-example",
    "ref": "string",
    "properties": {
      "database": "database-name",
      "host": "db.example.db2.ibmappdomain.cloud",
      "port": "50000",
      "type": "db2cloud",
      "ssl": "true",
      "username": "dbadmin-user",
      "password": "password"
    }
  }
}
Non-SSL example
{
  "connection": {
    "name": "db2-cloud-connection-example",
    "ref": "string",
    "properties": {
      "database": "database-name",
      "host": "db.example.db2.ibmappdomain.cloud",
      "port": "50000",
      "type": "db2cloud",
      "ssl": "false",
      "username": "dbadmin-user",
      "password": "password"
    }
  }
}