REST API

Connections

Connections are a core part of Privacy Dynamics and are used to read from and write to different data sources. On this page, we'll dive into the different connection endpoints you can use to manage connections programmatically. We'll look at how to query, create, update, and delete connections.

The connection model

The connection model contains all the information needed to connect to a data source, such as data source type, location, and authentication credentials.

Properties

  • Name
    connection_name
    Type
    string
    Description

    A friendly name for the connection, i.e., the display name

  • Name
    database
    Type
    string
    Description

    The database containing the desired tables for documents

  • Name
    schema
    Type
    string
    Description

    The schema containing the desired tables

  • Name
    account
    Type
    string
    Description

    The account name. This is used in place of host for certain data warehouses

  • Name
    user
    Type
    string
    Description

    The user identity used to authenticate with the database

  • Name
    password
    Type
    timestamp
    Description

    The password corresponding to the user used to authenticate to the database

  • Name
    warehouse
    Type
    timestamp
    Description

    The warehouse name


POST/v1/connections

Create a connection

This endpoint allows you to add a new connection within Privacy Dynamics. Request payloads vary based on the type of database or data warehouse used for the connection.

Connection:

Request

Response


PUT/v1/connections/{connection_id}

Update a connection

This endpoint allows you to perform an update on a connection. Request payloads vary based on the type of database or data warehouse used for the connection.

Connection:

Request

Response

Next
What is Privacy Dynamics?