---
name: Db2onCloud-interfaces
title: Interfaces
description: 'You can work with your database in the following ways:'
last-updated: 2023-06-09
---

> ## Documentation Index
> The table of contents for this documentation set is at https://cloud.ibm.com/docs/Db2onCloud?format=markdown
> The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt
> Use these files to discover more information as needed.

{:external: target="_blank" .external}
{:shortdesc: .shortdesc}
{:codeblock: .codeblock}
{:screen: .screen}
{:tip: .tip}
{:important: .important}
{:note: .note}
{:deprecated: .deprecated}
{:pre: .pre}

# Interfaces
{: #interfaces}

You can work with your database in the following ways:
{: shortdesc}

   * From the web console
   * REST API
   * Connect applications or your favorite tools from your local computer
   * Use IBM Db2 SaaS as a data source for your IBM Cloud apps or services

## Web console
{: #web_console}

The web console provides a graphical interface for everything that you need to use your database, including: load facilities, an SQL editor, driver downloads, and more.
{: shortdesc}





You can access your web console in the following ways:
   * From your IBM Cloud dashboard - You can open the web console from the Service Details page for your IBM Db2 SaaS service.
   * Direct URL - You can bookmark the URL of the web console for your IBM Db2 SaaS service.

## REST API
{: #int_api}

With IBM Db2 SaaS service plans, you can do tasks that are related to file management, loading data, and resource scaling by using one of the following REST APIs:
- [Database management API (Standard and Enterprise)](https://cloud.ibm.com/apidocs/db2-on-cloud/db2-on-cloud-v4){: external}
- [Database resource scaling API](https://cloud.ibm.com/apidocs/db2-on-cloud/db2oc_scale_exp){:external}

## Connect applications or your favorite tools from your local computer
{: #connect_apps}

Configure your local environment to connect to your IBM Db2 SaaS database by completing the following steps:
{: shortdesc}

1. Download the [driver package](https://cloud.ibm.com/docs/Db2onCloud/connecting?topic=Db2onCloud-drvr_pkg&format=markdown) from the IBM Db2 SaaS web console.
2. Install the driver package on the computer where your apps or tools are running:
   - [Installing on Linux or PowerLinux](https://cloud.ibm.com/docs/Db2onCloud/connecting?topic=Db2onCloud-drvr_pkg&format=markdown#drvr_install_linux)
   - [Installing on Mac OS X](https://cloud.ibm.com/docs/Db2onCloud/connecting?topic=Db2onCloud-drvr_pkg&format=markdown#drvr_install_mac)
   - [Installing on Windows](https://cloud.ibm.com/docs/Db2onCloud/connecting?topic=Db2onCloud-drvr_pkg&format=markdown#drvr_install_windows)
3. [Configure the driver files](https://cloud.ibm.com/docs/Db2onCloud/connecting?topic=Db2onCloud-drvr_pkg&format=markdown#drvr_cfg_loc_env) for your IBM Db2 SaaS database.

## Use IBM Db2 SaaS  as a data source for your IBM Cloud apps or services
{: #data_src}

Apps that are hosted on IBM Cloud can connect to your IBM Db2 SaaS database the same way as your local applications connect to your IBM Db2 SaaS database.
{: shortdesc}

When your apps use the IBM Cloud platform, you can take advantage of the `VCAP _SERVICES` environment variable to simplify the task of specifying database details and credentials:
1. On your IBM Cloud dashboard, in the **Connections** tab of the Service Details page for your IBM Db2 SaaS service, click the **Create connection** button.
2. Select the IBM Cloud app to use with your IBM Db2 SaaS database as a data source, and then click the **Connect** button.
3. Update your application code to retrieve database details and credentials from the `VCAP_SERVICES` environment variable:

    **Example without `VCAP_SERVICES`**

    ```php
    <?php
    $driver      = "DRIVER={IBM DB2 ODBC DRIVER};";

    $database    = "BLUDB";         # Get these database details from
    $hostname    = "<Host-name>";   # the Connection info page of the
    $port        = 50001;           # web console.
    $user        = "<User-ID >";    #
    $password    = "<Password>";    #
    $dsn         = "DATABASE=$database;" .
                   "HOSTNAME=$hostname;" .
                   "PORT=$port;" .
                   "PROTOCOL=TCPIP;" .
                   "UID=$user;" .
                   "PWD=$password;";

    $conn_string = $driver . $dsn;

    $conn        = db2_connect( $conn_string, "", "" );
    ?>
    ```

    **Example with `VCAP_SERVICES`**

    ```php
    <?php
    $driver      = "DRIVER={IBM DB2 ODBC DRIVER};";

    $vcap        = json_decode( getenv( "VCAP_SERVICES" ), true );
    $dsn         = $vcap[ "dashDB" ][0][ "credentials" ][ "dsn" ];

    $conn_string = $driver . $dsn;
                                   
    $conn        = db2_connect( $conn_string, "", "" );
    ?>
    ```