API v1 - License

This article is a guide to using the License API in Matillion ETL. This lets you use the API to return the details of the active Matillion ETL license, or to set a new license.

Prerequisites

Users responsible for experimenting with Matillion ETL API services require access to the Matillion ETL instance and ought to know how to make REST API calls either employing a REST API GUI client such as Postman or employing a command-line interface 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.

Get active license details

To return details of the active license in this Matillion ETL instance, make the following GET request:

GET <InstanceAddress>/rest/v1/metadata/license

Where <instanceAddress> is the URI of your Matillion ETL instance in the form http://host:port.

A successful GET call to the endpoint will return the current active license details as a JSON response with the following form:

{
    "id":"Test License",
    "socket":10,
    "expiry":4102444800000,
    "properties":
    {
            "LIC_ENABLE_AUDIT":"true",
            "LIC_ENABLE_JOB_DOCUMENTATION":"true",
            "LIC_ENABLE_CLUSTERING":"true",
            "LIC_ENABLE_PERMISSIONS":"true",
            "LIC_ENABLE_LINEAGE":"true",
            "LIC_ENABLE_SCM":"true",
            "LIC_ENABLE_MULTIPLE_CONNECTIONS":"true",
            "LIC_ENABLE_ASSERT_COMPONENTS":"true",
            "LIC_ENABLE_DEPRECATED_COMPONENTS":"true",
            "LIC_ENABLE_TARGET_ACTIVITY_LOG_READ":"true",
            "LIC_ENABLE_CLONING":"true",
            "LIC_ENABLE_DATA_MASKING":"true"
        },
    "environment":10
}

Set new license

To set a new license file for the Matillion ETL instance, make the following POST request:

POST <InstanceAddress>/rest/v1/metadata/license

Where <instanceAddress> is the URI of your Matillion ETL instance in the form http://host:port.

In the body of the request, send a text file which contains the new license key (the Base64 part only).

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

{
    "success": true,
    "result": "License set successfully"
}

Contact us

If any help is needed navigating the License API in Matillion ETL, read Getting Support.