Create and manage connections

Stay organized with collections Save and categorize content based on your preferences.

You're viewing Apigee X documentation.
View Apigee Edge documentation.

This page describes how to create a connection, including how to view, modify, and delete a connection.

Connector vs connection

It is important to understand the difference between a connector and a connection. A connector provides connectivity to a specific datasource such as, Salesforce, BigQuery, Pub/Sub, or ServiceNow. Each datasource has a separate connector. But to access a datasource, you must create a connection to the datasource by using the corresponding connector. For example, to access a Salesforce instance, you must create a connection by using the Salesforce connector. Based on your requirement you can create multiple connections for a connector type.

Before you begin

Before creating a connection for the first time, complete the following steps:

  1. Create a new Apigee instance. New Apigee instances can be provisioned with the Provisioning UI.

    For the list of regions supporting connectors, see Supported connector regions.

  2. Confirm that the Apigee Integration and connectors features are entitled to your Apigee subscription.
  3. Enable the Apigee Integration and connectors features using the following command:
    curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H \
    "content-type:application/json" \
    "" -XPOST \
    -d '{"addonsConfig": {"integrationConfig": {"enabled": true}, "connectorsPlatformConfig": {"enabled": true}}}'

Supported connector regions

The following regions support Apigee connectors:

  • asia-east1
  • asia-northeast1
  • asia-south1
  • asia-southeast1
  • australia-southeast1
  • europe-west1
  • europe-west2
  • europe-west3
  • europe-west4
  • europe-west6
  • northamerica-northeast1
  • southamerica-east1
  • us-central1
  • us-east1
  • us-east4
  • us-west1
  • us-west2

Create a connection

To create a connection, in your Google Cloud project, go to the connections page and then click + CREATE NEW. For information on creating a connection for a specific data source, refer to the corresponding Create a CONNECTOR_NAME connection page. While most of the steps to create a connection are same for all the connectors, the authentication mechanism might vary from connector to connector.

The following connectors are supported:

  • Active Directory
  • Apache Cassandra
  • Apache Kafka
  • Apache CouchDB
  • BigQuery
  • Box
  • Pub/Sub
  • Cloud Spanner
  • Cloud SQL - MySQL
  • Cloud SQL - PostgreSQL
  • Cloud SQL - SQL Server
  • CockroachDB
  • Elasticsearch
  • Email
  • Jira Cloud
  • LDAP
  • MariaDB
  • MongoDB
  • Dynamics NAV
  • MySQL
  • PayPal
  • Oracle DB
  • PostgreSQL
  • Redis
  • Salesforce
  • ServiceNow
  • SFTP
  • Splunk
  • SQL Server
  • Twilio
  • Workday
  • Zendesk
  • Manage connections

    After you have created new connections, you can use the connectors UI to list, view, edit, or delete a connection, as described in the sections below.

    List all connections

    To view a complete list of all Connections available within your Google Cloud project, go to Apigee > Connectors in the Cloud console and select a Google Cloud project to open the Connections page.

    Go to the Connections page

    View connection details

    To view the details of a specific connection, you can click on a connection name in the table of existing connections. You can also filter the list of available connections by connection name (for example, my-connection-1) or connector type (for example, bigquery").

    Selecting an individual connection opens the Connection Details page, which displays the following information about the connection instance:

    • Connector type
    • Connector status
    • Authentication type
    • Location
    • Connection details specific to the connector type
    • Locked status

    Edit a connection

    Individual connections can be edited from the Connection Details page.

    • To edit the connection, click EDIT to open an editable Connection Details page. Once editing is complete, click Save to save the changes and close the editing page.
    • To copy the connection details, click DUPLICATE to open the Duplicate Connection pane. Enter the following details:
      • Connection Name: Enter a name for the new connection instance.

        Connection names must meet the following criteria:

        • Connection names can use letters, numbers, or hyphens.
        • Letters must be lower-case.
        • Connection names must begin with a letter and end with a letter or number.
        • Connection names cannot exceed 63 characters.
      • Optionally, add a Description of the connection instance.
      • Click DUPLICATE to copy the connection details and close the pane.
    • To prevent future editing of the connection, click LOCK on the Connection Details screen. Locking a connection allows you to prevent accidental deletion or modification of a live connection. Click CONFIRM to lock the connection and close the pane.

    Delete a connection

    To delete a connection:

    • Locate the row containing the connection to be deleted in the table of existing connections on the Connections page.
    • Click the Actions column for the specific connection to delete and then select DELETE from the list of available actions.
    • Click DELETE in the confirmation dialog.