Maps of Matillion API v1
    • Dark
      Light

    Maps of Matillion API v1

    • Dark
      Light

    Article Summary

    Overview

    The Matillion ETL API is designed to make it easy to interact with Matillion ETL programmatically. Matillion can extract and load data from most JSON and XML-based REST APIs, and also from some SOAP APIs (those which behave RESTfully).

    This guide will give you a hierarchical map of all v1 API endpoints.HTTP Methods for each endpoint are given in hierarchical fashion with descriptions and examples where available, as exposed through the v1 API metadata.

    Important Information

    • If using a Bash or Python component to call the API on that same instance, use the instance's Private IP or local host (127.0.0.1:8080 for HTTP or 127.0.0.1:8443 for HTTPS) for the instance address.
    • In the examples , '<>' implies the name of a resource specific to your Matillion ETL instance such as the name of a project or job.
    • You are required to give the URL-encoded version of the resource name where appropriate. For example, if checking running tasks in project 'Up To Date' and group 'Test'.
    • For Example:

      http:// < instance address >/rest/v1/group/name/Test/project/name/Up To Date/task/running

      Must become

      http:// < instance address>/rest/v1/group/name/Test/project/name/Up%20To%Date/task/running
    • For detail description of the URL-encoded versions, please visit here.

    Base URL

    The REST API is available using the following URL pattern.

    http(s)://<Matillion Instance URL>/rest/<Version>/<Endpoint>

    Where:

    • Matillion ETL Instance URL – is the same as the URL you would normally access your instance on.
    • Version – is the API version (Not versions created in the tool).
    • Endpoint – is the part of the API used for this call. See below for the available endpoints.


    Parameters can then be added to the end of the URL in order to refine the API call, such as to narrow the returned data by specifying particular groups or projects. There should always be a '?' after the endpoint to mark the start of a parameter section.

    For example, checking projects (endpoint) in a certain group (parameter):

    http://matillion.server.com/rest/v0/projects?groupName=TestGroup

    API Extract Profile Endpoints (/apiextractprofile)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/<apiextractprofile>

    API Endpoints and Function

    MethodPathURLFunction
    GET/apiextractprofilehttps://<InstanceAddress>/rest/v1/apiextractprofileGet a list of API Extract profile connectors.
    GET/exporthttps://<InstanceAddress>/rest/v1/apiextractprofile/exportExport defined API extract connectors and details.
    POST/importhttps://<InstanceAddress>/rest/v1/apiextractprofile/importImport one or more API connector extracts.
    GET/name/<connectorName>/exporthttps://<InstanceAddress>/rest/v1/apiextractprofile/name/<ConnectorName>/exportExport the selected connector API extract.

    For deatiled information on API Extract Profile API, please refer API v1- API Extract Profile guide on Matillion documentation.


    Audit API Endpoints (/audit)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/<audit>

    API Endpoints and Function

    MethodPathURIFunction
    GET/audithttp://<InstanceAddress>/rest/v1/auditRetrieve the audit log available in the instance.
    GET/audit/exporthttp://<InstanceAddress>/rest/v1/audit/export?offset=0&limit=25To export the audit log.

    For deatiled information on Audit API, please refer API v1- Audit guide on Matillion documentation.


    API Profile API Endpoints (/apiprofile)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/<apiprofile>

    API Endpoints and Function

    MethodPathURLFunction
    GET/exporthttps://<InstanceAddress>/rest/v1/apiprofile/exportExport one of more API Profiles.
    POST/importhttps://<InstanceAddress>/rest/v1/apiprofile/importImport one or more API Profiles.
    GET/testhttps://<InstanceAddress>/rest/v1/apiprofile/name/<ProfileName>/testTest an API Profile.
    GET/filehttps://<InstanceAddress>/rest/v1/apiprofile/name/<ProfileName>/fileList all RSD files in an API Profile.
    POST/deletehttps://<InstanceAddress>/rest/v1/apiprofile/name/<ProfileName>/file/name/<RSDFile>/deleteDelete an RSD file.
    POST/reverthttps://<InstanceAddress>/rest/v1/apiprofile/name/<ProfileName>/file/name/<RSDFile>/revertRevert an RSD file.

    For deatiled information on API Profile, please refer API v1- APIProfile guide on Matillion documentation.


    Credential API Endpoints (/credential)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/<credential>

    API Endpoints and Function

    MethodPathURIFunction
    GET/credentialhttp://<InstanceAddress>/rest/v1/credentialGet the metadata of the credentials including PATH, GET POST and DELETE methods available.
    PATH/aws
    GET/awshttp://<InstanceAddress>/rest/v1/credential/awsTo get the list of aws credentials.
    GET/testhttp://<InstanceAddress>/rest/v1/credential/aws/name/<credentialName>/testTests the current credential
    GET/exporthttp://<InstanceAddress>/rest/v1/credential/aws/name/<credentialName>/exportExports the current credential.
    POST/deletehttp://<InstanceAddress>/rest/v1/credential/aws/name/<credentialName>/deleteDeletes the current credential via HTTP POST request.
    POST/updatehttp://<InstanceAddress>/rest/v1/credential/aws/name/<credentialName>/update WITH POST DATA arg0Takes a body containing name, access key and secret key and updates this credential.
    POST/updateFromExporthttp://<InstanceAddress>/rest/v1/credential/aws/name/<credentialName>/updateFromExport WITH POST DATA arg0Takes a body containing an exported credential and updates this credential.
    DELETE/credentialNamehttp://<instance address>/rest/v1/credential/aws/name/<credentialName>Remove the current credential using DELETE HTTP method.
    PATH/gcp
    GET/gcphttp://<InstanceAddress>/rest/v1/credential/gcpTo get the list of GCP credentials.
    GET/testhttp://<InstanceAddress>/rest/v1/credential/gcp/name/<credentialName>/testTests the current credential for GCP.
    GET/exporthttp://<InstanceAddress>/rest/v1/credential/gcp/name/<credentialName>/exportExports the current credential of the GCP.
    POST/deletehttp://<InstanceAddress>/rest/v1/credential/gcp/name/<credentialName>/deleteDeletes the current credential via HTTP POST request.
    POST/updatehttp://<InstanceAddress>/rest/v1/credential/gcp/name/<credentialName>/update WITH POST DATA arg0Takes a body containing name, access key and secret key and updates this credential.
    POST/updateFromExporthttp://<InstanceAddress>/rest/v1/credential/gcp/name/<credentialName>/updateFromExport WITH POST DATA arg0Takes a body containing an exported credential and updates this credential.
    POST/createhttp://<InstanceAddress>/rest/v1/credential/gcp/create WITH POST DATA arg0To create a new gcp credential supplying name and secret.
    POST/importhttp://<InstanceAddress>/rest/v1/credential/gcp/import WITH POST DATA arg0Import a credetial to the gcp credentials using exported details.
    DELETE/credentialnamehttp://<instance address>/rest/v1/credential/gcp/name/<credentialName>Remove the current credential using DELETE HTTP method.
    PATHPATH/instance?credentialName=<credentialName>http://<instance address>/rest/v1/credential/gcp/instance?credentialName=<credentialName>To get the metadata of the GCP credential from the instance.
    PATH/azure
    GET/azurehttp://<InstanceAddress>/rest/v1/credential/azureTo get the list of Azure credentials.
    GET/testhttp://<InstanceAddress>/rest/v1/credential/azure/name/<credentialName>/testTests the current credential for azure.
    GET/exporthttp://<InstanceAddress>/rest/v1/credential/azure/name/<credentialName>/exportExport the current credential of the azure.
    POST/deletehttp://<InstanceAddress>/rest/v1/credential/azure/name/<credentialName>/deleteDeletes the current credential via HTTP POST request.
    POST/updatehttp://<InstanceAddress>/rest/v1/credential/azure/name/<credentialName>/update WITH POST DATA arg0Takes a body containing name, clientID, tokenID, and secret key and updates this credential.
    POST/updateFromExporthttp://<InstanceAddress>/rest/v1/credential/azure/name/<credentialName>/updateFromExport WITH POST DATA arg0Takes a body containing an exported credential and updates this credential.
    POST/createhttp://<InstanceAddress>/rest/v1/credential/azure/create WITH POST DATA arg0To create a new azure credential supplying name, clientID, tokenID, and secret key.
    POST/importhttp://<InstanceAddress>/rest/v1/credential/azure/import WITH POST DATA arg0Import to the azure credentials using exported details.
    DELETE/credentialNamehttp://<instance address>/rest/v1/credential/azure/name/<credentialName>Remove the current credential using DELETE HTTP method.
    PATHPATH/name/credentialNamehttp://<instance address>/rest/v1/credential/azure/name/<credentialName>To get the metadata of the Azure credential using credentialname.
    PATHPATH/instance?credentialName=<credentialName>http://<instance address>/rest/v1/credential/azure/instance?credentialName=<credentialName>To get the metadata of the Azure credential from the instance.

    For deatiled information on Credential API, please refer API v1- Credentials guide on Matillion documentation.


    Driver API Endpoint (/driver)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/<driver>

    API Endpoints and Function

    MethodPathURIFunction
    GET/driverhttp://<InstanceAddress>/rest/v1/driverThe endpoint will retrieve the list of drivers within the instance.

    For deatiled information on Driver API, please refer API v1- Driver guide on Matillion documentation.


    Environment API Endpoints (/environment)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/environment

    API Endpoints and Function

    MethodPathURIFunction
    GET/namehttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/nameGet the name of the current environment.
    GET/idhttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/idGet the id of the selected environment.
    GET/testhttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/testTest the current environment.
    GET/exporthttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/exportTo export the data of the current environment within the project.
    POST/updatehttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/update WITH POST DATA arg0Update the current environment by importing updated environment.
    PATH/variable
    GET/valuehttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/variable/name/<variableName>/valueReturns default value for current environment variable.
    POST/deletehttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/variable/name/<variableName>/deleteDelete the current variable.
    POST/set/value/{variableValue}http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/variable/name/<variableName>/set/value/<variableValue>Set new value for current Environment Variable.
    POST/set/instancehttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/variable/name/<variableName>/set/instance?variableValue=<variableValue>Set new value for current Environment Variable.
    DELETE/variableNamehttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/variable/name/<variableName>Delete the current variable using DELETE HTTP method.
    GET/exporthttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/variable/exportImport variables into the current environment.
    POST/importhttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/variable/importImport variables into the current environment.

    For deatiled information on Environment API, please refer API v1- Environment guide on Matillion documentation.


    Notice API Endpoints (/notice)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/notice

    API Endpoints and Function

    MethodPathURIFunction
    PATH/notice
    GET/notice/http://<InstanceAddress>/rest/v1/notice/Get the list of notices.
    POST/notice/createhttp://<InstanceAddress>/rest/v1/notice/createTo create a notice in the instance.
    PATH/notice/id/{id}
    GET/notice/id/{id}/gethttp://<InstanceAddress>/rest/v1/notice/id/{id}/getGet a notice for the selected id.
    POST/notice/id/{id}/deletehttp://<InstanceAddress>/rest/v1/notice/id/{id}/deleteTo delete a notice via POST HTTP method.
    DELETE/notice/id/{id}http://<InstanceAddress>/rest/v1/notice/id/{id}To delete a notice with DELETE API request.

    For deatiled information on Notice API, please refer API v1- Notice guide on Matillion documentation.


    OAuth API Endpoints (/oauth)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/<oauth>

    API Endpoints and Function

    MethodPathURLFunction
    GET/propertieshttp://<InstanceAddress>/rest/v1/oauth/name/<oauthname>/propertiesGet the properties of the selected OAuth.
    GET/idhttp://<InstanceAddress>/rest/v1/oauth/name/<oauthName>/idGet the ID of the selected OAuth.
    GET/namehttp://<InstanceAddress>/rest/v1/oauth/name/<oauthName>/nameGet the name of the selected OAuth.
    GET/typehttp://<InstanceAddress>/rest/v1/oauth/name/<oauthName>/typeGet the type of the selected OAuth.
    GET/statushttp://<InstanceAddress>/rest/v1/oauth/name/<oauthName>/statusGet the status of the selected OAuth.
    GET/settingshttp://<InstanceAddress>/rest/v1/oauth/name/<oauthName>/settingsGet the settings of the selected OAuth.
    GET/exporthttp://<InstanceAddress>/rest/v1/oauth/name/<oauthName>/exportExport the current OAuth.
    POST/importhttp://<InstanceAddress>/rest/v1/oauth/importImport one or more OAuths.
    POST/deletehttp://<InstanceAddress>/rest/v1/oauth/name/<oauthName>/deleteDelete the selected OAuth.
    DELETE/oauthNamehttp://<InstanceAddress>/rest/v1/oauth/name/<oauthName>Delete the selected OAuth from the server.

    For deatiled information on OAuth API, please refer API v1- OAuth guide on Matillion documentation.


    Password API Endpoints (/password)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/group/name/<groupName>/password

    API Endpoints and Function

    MethodPathURIFunction
    GET/namehttp://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordName>/nameGet the name of the password.
    GET/idhttp://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordName>/idGets the ID of the password.
    GET/gethttp://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordName>/getReturns the password.
    GET/exporthttp://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordName>/exportExport the given password.
    POST/deletehttp://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordName>/deleteDelete the given password.
    POST/updateFromExporthttp://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordName>/updateFromExport WITH POST DATA arg0Supply password as already encoded since password will be created as is.
    POST/createhttp://<instance address>/rest/v1/group/name/<groupname>/password/createSupply password as plaintext to be Encoded by standard set in EncryptionType.
    POST/importhttp://<instance address>/rest/v1/group/name/<groupname>/password/importImport password via ExportContainer. Supply password as already encoded since password will be created as is.​
    POST/updatehttp://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordName>/update WITH POST DATA arg0Supply password as plaintext as it will encode via encryptionType provided.
    DELETE/passwordNamehttp://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordNameTo delete the selected version using DELETE HTTP method.

    For deatiled information on Password API, please refer API v1- Password guide on Matillion documentation.


    Permission API Endpoints (/permission)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/<permission>

    API Endpoints and Function

    MethodPathURIFunction
    PATH/user
    GET/userhttp://<InstanceAddress>/rest/v1/permission/userGet the list of users.
    GET/user/exporthttp://<InstanceAddress>/rest/v1/permission/user/exportExport all users for the specific permission.
    POST/user/importhttp://<InstanceAddress>/rest/v1/permission/user/importImport one or more permission users.
    POST/user/userName/deletehttp://<InstanceAddress>/rest/v1/permission/user/userName/deleteDelete the selected permission user.
    PATH/user/name/<userName>/groups
    GET/userName/groups/idshttp://<InstanceAddress>/rest/v1/permission/user/userName/groups/idsGet the set of group IDs assigned to the selected permission user.
    GET/userName/groups/gethttp://<InstanceAddress>/rest/v1/permission/user/userName/group/getGet the set of group names assigned to the selected permission user.
    POST/userName/groups/addhttp://<InstanceAddress>/rest/v1/permission/user/userName/group/addAdd a group to the selected permission user.
    POST/userName/groups/removehttp://<InstanceAddress>/rest/v1/permission/user/userName/group/removeRemove a group from selected permission user.
    PATH/group
    GET/exporthttp://<InstanceAddress>/rest/v1/permission/group/exportExport one or more permission group.
    POST/importhttp://<InstanceAddress>/rest/v1/permission/group/importImport one or more permission group.
    GET/parenthttp://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/parentGet the parent Group ID of the selected permission group.
    GET/groupname/exporthttp://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/exportExport the selected permission group.
    DELETE/groupNamehttp://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/Delete the selected permission group via a HTTP DELETE request.
    POST/updatehttp://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/update WITH POST DATA arg0Update the selected permission group.
    POST/deletehttp://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/deleteDelete the selected permission group via a HTTP POST request.
    PATH/<groupName>/roles
    GET/gethttp://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/roles/getGet the list of roles assigned to the selected permission group.
    POST/addhttp://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/roles/getAdd a role to the selected permission group.
    POST/removehttp://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/roles/remove WITH POST DATA arg0Remove a role from the selected permission group.
    PATH/global
    POST/importhttp://<InstanceAddress>/rest/v1/permission/global/import WITH POST DATA arg0Import one or more group permissions.
    GET/exporthttp://<InstanceAddress>/rest/v1/permission/global/exportExport all permissions for every group.
    GET/grouphttp://<InstanceAddress>/rest/v1/permission/global/groupList all group permission.
    PATH/instance
    PATH/grouphttp://<InstanceAddress>/rest/v1/permission/global/instance?groupName=<groupName>Get the permission of the selected instance using groupName.
    PATH/group/name/<groupName>
    GET/exporthttp://<InstanceAddress>/rest/v1/permission/global/group/name/<groupName>/exportExport all permissions for the selected group.
    GET/permissionhttp://<InstanceAddress>/rest/v1/permission/global/group/name/<groupName>/permissionList permission in the selected group.
    POST/clearhttp://<InstanceAddress>/rest/v1/permission/global/group/name/<groupName>/clearReset permissions for the selected group.
    PATH/permission/name/<permissionName>
    GET/gethttp://<InstanceAddress>/rest/v1/permission/global/group/name/<groupName>/permission/name/<permissionName>/getGet the selected permission.
    POST/updatehttp://<InstanceAddress>/rest/v1/permission/global/group/name/<groupName>/permission/name/<permissionName>/updateUpdate the selected permission. (DEFAULT, GRANTED, FORBIDDEN)

    For deatiled information on Permission API, please refer API v1- Permission guide on Matillion documentation.


    Queue API Endpoints (/queue)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/<queue>

    API Endpoints and Function

    FunctionMethodPathURL
    Export Queue configurationsGET/exporthttps://<InstanceURI>/rest/v1/queue/export
    Import Queue configurationsPOST/importhttps://<InstanceURI>/rest/v1/queue/import
    Test Queue configurationsGET/testhttps://<InstanceURI>/rest/v1/queue/test

    For deatiled information on Queue API, please refer API v1- Queue guide on Matillion documentation.


    Schedule API Endpoints (/schedule)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/schedule

    API Endpoints and Function

    MethodPathURIFunction
    GET/namehttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/schedule/name/<scheduleName>/nameGet the name of the selected schedule within the group.
    GET/idhttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/schedule/name/<scheduleName>/idGet the Queue Id of the schedule.
    GET/exporthttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/schedule/name/<scheduleName>/exportProduces an export container containing this schedule.
    POST/importhttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/schedule/importImport the resource data to the instance.
    POST/deletehttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/schedule/name/<scheduleName>/deleteDelete the selected schedule via a HTTP POST request.
    POST/updatehttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/schedule/name/<scheduleName>/update?ignoreUnresolved=false WITH POST DATA arg1Update the selected schedule within the project.
    DELETE/scheduleNamehttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/schedule/name/<scheduleName>Delete the selected schedule via a HTTP DELETE request.

    For deatiled information on Schedule API, please refer API v1- Schedule guide on Matillion documentation.


    Shared Job API Endpoints (/sharedjob)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/<sharedjob>

    API Endpoints and Function

    MethodPathURIFunction
    GET/exporthttp://<instance address>/rest/v1/sharedjob/exportTo export the metadata of the Shared Jobs within the instance.
    POST/importhttp://<instance address>/rest/v1/sharedjob/importTo import the data of the Shared Jobs within the instance.
    GET/packagehttp://<instance address>/rest/v1/sharedjob/packageTo get the package available within the Shared Job of the instance.
    PATH/package/name/>packageName>
    GET/packageName/exporthttp://<instance address>/rest/v1/sharedjob/package/name/<packageName>/exportTo export the specific package from the Shared Job within the instance.
    GET/packageName/jobhttp://<instance address>/rest/v1/sharedjob/package/name/<packageName>/jobTo get the list of Jobs available within the current package of the instance.
    POST/packageName/deletehttp://<instance address>/rest/v1/sharedjob/package/name/<packageName>/deleteTo delete the selected package from the list using HTTP POST request.
    DELETE/packageNamehttp://<instance address>/rest/v1/sharedjob/package/name/<packageName>Delete all jobs within a package.
    PATH/job/name/<jobName>
    GET/jobName/exporthttp://<instance address>/rest/v1/sharedjob/package/name/<packageName>/job/name/<jobName>/exportTo export the specific job available within the package.
    GET/jobName/revisionhttp://<instance address>/rest/v1/sharedjob/package/name/<packageName>/job/name/<jobName>/revisionTo get the revisions available within the selected job.
    POST/jobName/deletehttp://<instance address>/rest/v1/sharedjob/package/name/<packageName>/job/name/<jobname>/deleteDelete all revisions of a single job.
    DELETE/jobNamehttp://<instance address>/rest/v1/sharedjob/package/name/<packageName>/job/name/<jobName>Delete all revisions of a single job.
    PATH/revision/id/<revisionId>
    GET/revisionId/exporthttp://<instance address>/rest/v1/sharedjob/package/name/<packageName>/job/name/<jobName>/revision/id/<revisionId>/exportTo export the specific job available within the package.
    POST/revisionId/deletehttp://<instance address>/rest/v1/sharedjob/package/name/<packageName>/job/name/<jobname>/revision/id/<revisionId>/deleteTo delete the selected job from the list using HTTP POST request.
    DELETE/revisionIdhttp://<instance address>/rest/v1/sharedjob/package/name/<packageName>/job/name/<jobName>revision/id/<revisionId>/Delete a single revision.

    For deatiled information on Shared Job API, please refer API v1- Shared Job guide on Matillion documentation.


    Task API Endpoints (/task)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task

    API Endpoints and Function

    MethodPathURIFunction
    GET/runninghttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/runningGet the detail of the task running for the selected project.
    GET/historyhttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/historyTo export the metadata of the task history.
    PATH/id/<taskId>
    GET/id/<taskId>http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/id/<taskId>To get the detail of the task using taskid.
    POST/id/<taskId>/cancelhttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/id/<taskId>/cancelThis will cancel the selected running task within the project using taskId.
    PATH/instancehttp://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/task/instance/<taskId>To get the detail of task by instance.
    PATH/filter
    GET/by/nonehttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/filter/by/noneList all the entries in the task history.
    GETby/start/after/date/<date>http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/filter/by/start/after/date/<date>List all entries in the task history which started on or after the given date.
    GETby/start/before/date/<date>/time/<time>http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/filter/by/start/before/date/<date>/time/<time>List all entries in the task history which started before the given date/time.
    GETby/start/after/date/<date>/time/<time>http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/filter/by/start/after/date/<date>/time/<time>List all entries in the task history which started on or after the given date/time.
    GETby/job/name/<jobName>http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/filter/by/job/name/<jobName>List all entries in the task history with the given job name.
    GETby/type/<type>http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/filter/by/type/<type>List all entries in the task history with the given task type.
    GETby/state/<state>http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/filter/by/state/<state>List all entries in the task history with the given state.
    GETby/start/range/date/<startDate>/time/<startTime>/to/date/<endDate>/time/<endTime>http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/filter/by/start/range/date/<startDate>/time/<startTime>/to/date/<endDate>/time/<endTime>List all entries in the task history which started between the given date/time range.

    For deatiled information on Task API, please refer API v1- Task guide on Matillion documentation.


    Userconfig API Endpoints (/userconfig)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/<userconfig>

    API Endpoints and Function

    MethodPathURIFunction
    GETuserconfig/userhttp://<InstanceAddress>/rest/v1/userconfig/userRetrieve a list of all users.
    GETuserconfig/exporthttp://<InstanceAddress>/rest/v1/userconfig/exportTo export user configuration.
    POSTuserconfig/importhttp://<InstanceAddress>/rest/v1/userconfig/import WITH POST DATA arg0To import user configuration.
    PATHuser/instance{username}http://<InstanceAddress>/rest/v1/userconfig/user/instance?userName=<username>Get a user configuration by name

    For deatiled information on Userconfig API, please refer API v1- Userconfig guide on Matillion documentation.

    Version API Endpoints (/version)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version

    API Endpoints and Function

    MethodPathURIFunction
    GET/namehttp://<instanceaddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/nameGet the name of the current version.
    GET/idhttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/idGet the id of the selected version.
    GET/exporthttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/exportTo export the metadata of the current version within the project.
    GET/orchestrationhttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/orchestrationTo retrieve the details of the Orchestration within the selected project.
    GET/transformationhttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/transformationTo retrieve the details of the Transformation within the selected project.
    POST/deletehttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/deleteTo delete the selected version using POST HTTP method.
    DELETE/versionNamehttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>To delete the selected version using DELETE HTTP method.
    PATH/job
    GET/exporthttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/job/name/<jobName>/exportTo export the data of the job within the current version.
    POST/deletehttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/job/name/<jobName>/deleteTo delete the selected job using POST HTTP method.
    POST/runhttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/job/name/<jobName>/run?environmentName=<environmentName> WITH POST DATA arg0Run an Orchestration Job, where variable overrides can be passed in the body.
    When using Matillion ETL as part of a larger process, the best practice way to initiate an orchestration job is to use a message queuing service. Matillion ETL can integrate with the following:
    AWS — Simple Queue Service (SQS)
    Azure — Azure Queue Message
    GCP — Pub/Sub Service
    POST/validatehttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/job/name/<jobName>/validate?environmentName=<environmentName>To validate the Job by passing Environment name in the body.
    DELETE/jobNamehttp://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/job/name/<jobName>To delete the selected job using DELETE HTTP method.
    PATH/scm

    For deatiled information on Version API, please refer API v1- Version guide and, for SCM, please refer SCM Integration on Matillion documentation.


    Webhook Payload Profile Endpoint (/webhookpayloadprofile)

    API Base URL

    http(s)://<InstanceAddress>/rest/v1/<webhookpayloadprofile>

    API Endpoints and Function

    MethodPathURIFunction
    GET/webhookpayloadprofilehttp://<instanceaddress>/rest/v1/webhookpayloadprofileExport the list of webhookpayload profile.
    GET/exporthttp://<instanceaddress>/rest/v1/webhookpayloadprofile/exportExport all webhook profiles.
    POST/importhttp://<InstanceAddress>/rest/v1/webhookpayloadprofile/import WITH POST DATAImport one or more webhook.
    GET/name/<webhook>/exporthttp://<InstanceAddress>/rest/v1/webhookpayloadprofile/name/<webhook>/exportExport the selected webhook.
    DELETE/name/<webhook>/deletehttp://<InstanceAddress>/rest/v1/webhookpayloadprofile/name/<webhook>/deleteDelete the selected webhook via DELETE request.