API v1 - Driver

The Driver API endpoint provides the list of Drivers available within the Matillion ETL instance. You can only use this API endpoint if you're running a Matillion ETL instance, and you have been assigned the Admin role.

Driver API provides the resource data, meaning the information returned by an API. These resources usually have various endpoints which are combined with multiple HTTP methods for each endpoint. The Driver API has one PATH /driver to retrieve the data available in a Matillion ETL instance.

Prerequisites

• To use Matillion ETL API services, you must know how to make REST API calls, either by employing a REST API GUI client such as Postman, or employing a command line interface (CLI) like cURL.
• If you are new to Matillion ETL's API, read our Matillion API introduction and explore the v1 API map.
• Matillion ETL API endpoints require authorization to make any REST API call, so ensure a username and password for the Matillion ETL instance is configured before making any API call.

---

Using the API

Returns a list of drivers in a Matillion ETL instance by making a GET call with the form:

<InstanceAddress>/rest/v1/driver/<endpoint>

Note

<InstanceAddress>/rest/v1/driver is the base URI for the API driver endpoints. Add the specific <endpoint> information for the following function, documented below.

Where:

• <instanceAddress> is the URI of your Matillion ETL instance in the form http://host:port.
• <endpoint> is the name of the API endpoint that accomplishes the task you want to perform. The endpoint is documented in the following section.

---

GET driver

Returns the drivers available in this Matillion ETL instance.

To return a list of drivers, make the following GET call:

<InstanceAddress>/rest/v1/driver

A successful GET call to the endpoint will return the following response from the server, in JSON format:

[
    {
        "driverName": "Oracle",
        "files": [
            {
                "group": "<groupname>",
                "fullFilePath": "<file path>",
                "fileName": "<file name>"
              }
            ]
    },
    {
        "driverName": "SAPHana",
        "files": []
    },
    {
        "driverName": "SQL Server (Microsoft Driver)",
        "files": []
    },
    {
        "driverName": "MySQL",
        "files": []
    }
]

• driverName: The name of the driver.
• group: The group that contains the driver.
• fullFilePath: The absolute path of the file or directory.
• fileName: The name of the file.