Create and manage connections

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

Connectors offers a number of ways to create, view, and manage Connectors that can then be used as connections in Apigee Integration. This page provides an overview of the process of creating a Connector and the options for managing connections in the Connectors UI.

Before you begin

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

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

    Supported regions for Connectors include:

    • us-central1
    • us-east1
    • us-west1
    • europe-west1
    • asia-east1
  • Confirm that the Apigee Integration and Connectors features are entitled to your Apigee subscription.
  • 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" \
    "https://apigee.googleapis.com/v1/organizations/PROJECT_ID:setAddons" -XPOST \
    -d '{"addonsConfig": {"integrationConfig": {"enabled": true}, "connectorsPlatformConfig": {"enabled": true}}}'

Enable required services

Connectors requires that you enable the following Google services:

Name Title
apigee.googleapis.com Apigee API
secretmanager.googleapis.com Secret Manager API
connectors.googleapis.com Connector Platform API

If these services have not been enabled for your project previously, you will be prompted to enable them before using the Connectors UI.

Create a connection

Connections are created using the Connectors UI in the Cloud Console.

To create a connection, follow these steps:

  1. In the Cloud console, go to the Apigee > Connectors and select or create a Cloud project.

    Go to the Connections page

  2. Click + CREATE NEW to open the Create Connection page.
  3. Configure the connection:
    1. In the Create Connection section, complete the following:
      • Connector: Select the Connector type from the drop down list of available Connector types.

        Available types include the following:

      • Connector version: Select the Connector version from the drop down list of available versions.
      • In the Connection Name field, enter a name for the 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.
      • The remaining configuration fields will vary depending upon the Connector type selected. Detailed descriptions of the configurations required for each type can be found in the Configure a connection documentation.
      • Click NEXT.
    2. Location: Choose the location for the connection.
      • Select a location where Apigee is available from the Region drop-down list.

        Supported regions for Connectors include:

        • us-central1
        • us-east1
        • us-west1
        • europe-west1
        • asia-east1
      • Click NEXT.
    3. Authentication: Provide authentication credentials for your connection instance, if required. Detailed descriptions of the authentication configurations required for each connection can be found in the Configure a connection documentation.
    4. Click NEXT.
    5. Review: Review your connections's configuration details. In this section, the Connection details and Authentication details of the new connection are displayed for your review.
  4. Click Create.

For more detail regarding the specific configuration requirements for connections, see the following configuration reference pages:

Manage connections

Once you have created new connections in the Connectors platform, 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 Cloud project, go to Apigee > Connectors in the Cloud console and select a 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.