Maps of Matillion API v1
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 detail description of the URL-encoded versions, please visit here.
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
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 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
| Method | Path | URL | Function |
|---|---|---|---|
| GET | /apiextractprofile | https://<InstanceAddress>/rest/v1/apiextractprofile | Get a list of API Extract profile connectors. |
| GET | /export | https://<InstanceAddress>/rest/v1/apiextractprofile/export | Export defined API extract connectors and details. |
| POST | /import | https://<InstanceAddress>/rest/v1/apiextractprofile/import | Import one or more API connector extracts. |
| GET | /name/<connectorName>/export | https://<InstanceAddress>/rest/v1/apiextractprofile/name/<ConnectorName>/export | Export 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
| Method | Path | URI | Function |
|---|---|---|---|
| GET | /audit | http://<InstanceAddress>/rest/v1/audit | Retrieve the audit log available in the instance. |
| GET | /audit/export | http://<InstanceAddress>/rest/v1/audit/export?offset=0&limit=25 | To 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
| Method | Path | URL | Function |
|---|---|---|---|
| GET | /export | https://<InstanceAddress>/rest/v1/apiprofile/export | Export one of more API Profiles. |
| POST | /import | https://<InstanceAddress>/rest/v1/apiprofile/import | Import one or more API Profiles. |
| GET | /test | https://<InstanceAddress>/rest/v1/apiprofile/name/<ProfileName>/test | Test an API Profile. |
| GET | /file | https://<InstanceAddress>/rest/v1/apiprofile/name/<ProfileName>/file | List all RSD files in an API Profile. |
| POST | /delete | https://<InstanceAddress>/rest/v1/apiprofile/name/<ProfileName>/file/name/<RSDFile>/delete | Delete an RSD file. |
| POST | /revert | https://<InstanceAddress>/rest/v1/apiprofile/name/<ProfileName>/file/name/<RSDFile>/revert | Revert 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
| Method | Path | URI | Function |
|---|---|---|---|
| GET | /credential | http://<InstanceAddress>/rest/v1/credential | Get the metadata of the credentials including PATH, GET POST and DELETE methods available. |
| PATH/aws | |||
| GET | /aws | http://<InstanceAddress>/rest/v1/credential/aws | To get the list of aws credentials. |
| GET | /test | http://<InstanceAddress>/rest/v1/credential/aws/name/<credentialName>/test | Tests the current credential |
| GET | /export | http://<InstanceAddress>/rest/v1/credential/aws/name/<credentialName>/export | Exports the current credential. |
| POST | /delete | http://<InstanceAddress>/rest/v1/credential/aws/name/<credentialName>/delete | Deletes the current credential via HTTP POST request. |
| POST | /update | http://<InstanceAddress>/rest/v1/credential/aws/name/<credentialName>/update WITH POST DATA arg0 | Takes a body containing name, access key and secret key and updates this credential. |
| POST | /updateFromExport | http://<InstanceAddress>/rest/v1/credential/aws/name/<credentialName>/updateFromExport WITH POST DATA arg0 | Takes a body containing an exported credential and updates this credential. |
| DELETE | /credentialName | http://<instance address>/rest/v1/credential/aws/name/<credentialName> | Remove the current credential using DELETE HTTP method. |
| PATH/gcp | |||
| GET | /gcp | http://<InstanceAddress>/rest/v1/credential/gcp | To get the list of GCP credentials. |
| GET | /test | http://<InstanceAddress>/rest/v1/credential/gcp/name/<credentialName>/test | Tests the current credential for GCP. |
| GET | /export | http://<InstanceAddress>/rest/v1/credential/gcp/name/<credentialName>/export | Exports the current credential of the GCP. |
| POST | /delete | http://<InstanceAddress>/rest/v1/credential/gcp/name/<credentialName>/delete | Deletes the current credential via HTTP POST request. |
| POST | /update | http://<InstanceAddress>/rest/v1/credential/gcp/name/<credentialName>/update WITH POST DATA arg0 | Takes a body containing name, access key and secret key and updates this credential. |
| POST | /updateFromExport | http://<InstanceAddress>/rest/v1/credential/gcp/name/<credentialName>/updateFromExport WITH POST DATA arg0 | Takes a body containing an exported credential and updates this credential. |
| POST | /create | http://<InstanceAddress>/rest/v1/credential/gcp/create WITH POST DATA arg0 | To create a new gcp credential supplying name and secret. |
| POST | /import | http://<InstanceAddress>/rest/v1/credential/gcp/import WITH POST DATA arg0 | Import a credetial to the gcp credentials using exported details. |
| DELETE | /credentialname | http://<instance address>/rest/v1/credential/gcp/name/<credentialName> | Remove the current credential using DELETE HTTP method. |
| PATH | PATH/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 | /azure | http://<InstanceAddress>/rest/v1/credential/azure | To get the list of Azure credentials. |
| GET | /test | http://<InstanceAddress>/rest/v1/credential/azure/name/<credentialName>/test | Tests the current credential for azure. |
| GET | /export | http://<InstanceAddress>/rest/v1/credential/azure/name/<credentialName>/export | Export the current credential of the azure. |
| POST | /delete | http://<InstanceAddress>/rest/v1/credential/azure/name/<credentialName>/delete | Deletes the current credential via HTTP POST request. |
| POST | /update | http://<InstanceAddress>/rest/v1/credential/azure/name/<credentialName>/update WITH POST DATA arg0 | Takes a body containing name, clientID, tokenID, and secret key and updates this credential. |
| POST | /updateFromExport | http://<InstanceAddress>/rest/v1/credential/azure/name/<credentialName>/updateFromExport WITH POST DATA arg0 | Takes a body containing an exported credential and updates this credential. |
| POST | /create | http://<InstanceAddress>/rest/v1/credential/azure/create WITH POST DATA arg0 | To create a new azure credential supplying name, clientID, tokenID, and secret key. |
| POST | /import | http://<InstanceAddress>/rest/v1/credential/azure/import WITH POST DATA arg0 | Import to the azure credentials using exported details. |
| DELETE | /credentialName | http://<instance address>/rest/v1/credential/azure/name/<credentialName> | Remove the current credential using DELETE HTTP method. |
| PATH | PATH/name/credentialName | http://<instance address>/rest/v1/credential/azure/name/<credentialName> | To get the metadata of the Azure credential using credentialname. |
| PATH | PATH/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
| Method | Path | URI | Function |
|---|---|---|---|
| GET | /driver | http://<InstanceAddress>/rest/v1/driver | The 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
| Method | Path | URI | Function |
|---|---|---|---|
| GET | /name | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/name | Get the name of the current environment. |
| GET | /id | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/id | Get the id of the selected environment. |
| GET | /test | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/test | Test the current environment. |
| GET | /export | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/export | To export the data of the current environment within the project. |
| POST | /update | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/update WITH POST DATA arg0 | Update the current environment by importing updated environment. |
| PATH/variable | |||
| GET | /value | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/variable/name/<variableName>/value | Returns default value for current environment variable. |
| POST | /delete | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/variable/name/<variableName>/delete | Delete 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/instance | http://<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 | /variableName | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/variable/name/<variableName> | Delete the current variable using DELETE HTTP method. |
| GET | /export | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/variable/export | Import variables into the current environment. |
| POST | /import | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/environment/name/<environmentName>/variable/import | Import 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
| Method | Path | URI | Function |
|---|---|---|---|
| PATH/notice | |||
| GET | /notice/ | http://<InstanceAddress>/rest/v1/notice/ | Get the list of notices. |
| POST | /notice/create | http://<InstanceAddress>/rest/v1/notice/create | To create a notice in the instance. |
| PATH/notice/id/{id} | |||
| GET | /notice/id/{id}/get | http://<InstanceAddress>/rest/v1/notice/id/{id}/get | Get a notice for the selected id. |
| POST | /notice/id/{id}/delete | http://<InstanceAddress>/rest/v1/notice/id/{id}/delete | To 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
| Method | Path | URL | Function |
|---|---|---|---|
| GET | /properties | http://<InstanceAddress>/rest/v1/oauth/name/<oauthname>/properties | Get the properties of the selected OAuth. |
| GET | /id | http://<InstanceAddress>/rest/v1/oauth/name/<oauthName>/id | Get the ID of the selected OAuth. |
| GET | /name | http://<InstanceAddress>/rest/v1/oauth/name/<oauthName>/name | Get the name of the selected OAuth. |
| GET | /type | http://<InstanceAddress>/rest/v1/oauth/name/<oauthName>/type | Get the type of the selected OAuth. |
| GET | /status | http://<InstanceAddress>/rest/v1/oauth/name/<oauthName>/status | Get the status of the selected OAuth. |
| GET | /settings | http://<InstanceAddress>/rest/v1/oauth/name/<oauthName>/settings | Get the settings of the selected OAuth. |
| GET | /export | http://<InstanceAddress>/rest/v1/oauth/name/<oauthName>/export | Export the current OAuth. |
| POST | /import | http://<InstanceAddress>/rest/v1/oauth/import | Import one or more OAuths. |
| POST | /delete | http://<InstanceAddress>/rest/v1/oauth/name/<oauthName>/delete | Delete the selected OAuth. |
| DELETE | /oauthName | http://<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
| Method | Path | URI | Function |
|---|---|---|---|
| GET | /name | http://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordName>/name | Get the name of the password. |
| GET | /id | http://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordName>/id | Gets the ID of the password. |
| GET | /get | http://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordName>/get | Returns the password. |
| GET | /export | http://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordName>/export | Export the given password. |
| POST | /delete | http://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordName>/delete | Delete the given password. |
| POST | /updateFromExport | http://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordName>/updateFromExport WITH POST DATA arg0 | Supply password as already encoded since password will be created as is. |
| POST | /create | http://<instance address>/rest/v1/group/name/<groupname>/password/create | Supply password as plaintext to be Encoded by standard set in EncryptionType. |
| POST | /import | http://<instance address>/rest/v1/group/name/<groupname>/password/import | Import password via ExportContainer. Supply password as already encoded since password will be created as is. |
| POST | /update | http://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordName>/update WITH POST DATA arg0 | Supply password as plaintext as it will encode via encryptionType provided. |
| DELETE | /passwordName | http://<instance address>/rest/v1/group/name/<groupname>/password/name/<passwordName | To 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
| Method | Path | URI | Function |
|---|---|---|---|
| PATH/user | |||
| GET | /user | http://<InstanceAddress>/rest/v1/permission/user | Get the list of users. |
| GET | /user/export | http://<InstanceAddress>/rest/v1/permission/user/export | Export all users for the specific permission. |
| POST | /user/import | http://<InstanceAddress>/rest/v1/permission/user/import | Import one or more permission users. |
| POST | /user/userName/delete | http://<InstanceAddress>/rest/v1/permission/user/userName/delete | Delete the selected permission user. |
| PATH/user/name/<userName>/groups | |||
| GET | /userName/groups/ids | http://<InstanceAddress>/rest/v1/permission/user/userName/groups/ids | Get the set of group IDs assigned to the selected permission user. |
| GET | /userName/groups/get | http://<InstanceAddress>/rest/v1/permission/user/userName/group/get | Get the set of group names assigned to the selected permission user. |
| POST | /userName/groups/add | http://<InstanceAddress>/rest/v1/permission/user/userName/group/add | Add a group to the selected permission user. |
| POST | /userName/groups/remove | http://<InstanceAddress>/rest/v1/permission/user/userName/group/remove | Remove a group from selected permission user. |
| PATH/group | |||
| GET | /export | http://<InstanceAddress>/rest/v1/permission/group/export | Export one or more permission group. |
| POST | /import | http://<InstanceAddress>/rest/v1/permission/group/import | Import one or more permission group. |
| GET | /parent | http://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/parent | Get the parent Group ID of the selected permission group. |
| GET | /groupname/export | http://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/export | Export the selected permission group. |
| DELETE | /groupName | http://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/ | Delete the selected permission group via a HTTP DELETE request. |
| POST | /update | http://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/update WITH POST DATA arg0 | Update the selected permission group. |
| POST | /delete | http://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/delete | Delete the selected permission group via a HTTP POST request. |
| PATH/<groupName>/roles | |||
| GET | /get | http://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/roles/get | Get the list of roles assigned to the selected permission group. |
| POST | /add | http://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/roles/get | Add a role to the selected permission group. |
| POST | /remove | http://<InstanceAddress>/rest/v1/permission/group/name/<groupName>/roles/remove WITH POST DATA arg0 | Remove a role from the selected permission group. |
| PATH/global | |||
| POST | /import | http://<InstanceAddress>/rest/v1/permission/global/import WITH POST DATA arg0 | Import one or more group permissions. |
| GET | /export | http://<InstanceAddress>/rest/v1/permission/global/export | Export all permissions for every group. |
| GET | /group | http://<InstanceAddress>/rest/v1/permission/global/group | List all group permission. |
| PATH/instance | |||
| PATH | /group | http://<InstanceAddress>/rest/v1/permission/global/instance?groupName=<groupName> | Get the permission of the selected instance using groupName. |
| PATH/group/name/<groupName> | |||
| GET | /export | http://<InstanceAddress>/rest/v1/permission/global/group/name/<groupName>/export | Export all permissions for the selected group. |
| GET | /permission | http://<InstanceAddress>/rest/v1/permission/global/group/name/<groupName>/permission | List permission in the selected group. |
| POST | /clear | http://<InstanceAddress>/rest/v1/permission/global/group/name/<groupName>/clear | Reset permissions for the selected group. |
| PATH/permission/name/<permissionName> | |||
| GET | /get | http://<InstanceAddress>/rest/v1/permission/global/group/name/<groupName>/permission/name/<permissionName>/get | Get the selected permission. |
| POST | /update | http://<InstanceAddress>/rest/v1/permission/global/group/name/<groupName>/permission/name/<permissionName>/update | Update 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
| Function | Method | Path | URL |
|---|---|---|---|
| Export Queue configurations | GET | /export | https://<InstanceURI>/rest/v1/queue/export |
| Import Queue configurations | POST | /import | https://<InstanceURI>/rest/v1/queue/import |
| Test Queue configurations | GET | /test | https://<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
| Method | Path | URI | Function |
|---|---|---|---|
| GET | /name | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/schedule/name/<scheduleName>/name | Get the name of the selected schedule within the group. |
| GET | /id | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/schedule/name/<scheduleName>/id | Get the Queue Id of the schedule. |
| GET | /export | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/schedule/name/<scheduleName>/export | Produces an export container containing this schedule. |
| POST | /import | http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/schedule/import | Import the resource data to the instance. |
| POST | /delete | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/schedule/name/<scheduleName>/delete | Delete the selected schedule via a HTTP POST request. |
| POST | /update | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/schedule/name/<scheduleName>/update?ignoreUnresolved=false WITH POST DATA arg1 | Update the selected schedule within the project. |
| DELETE | /scheduleName | http://<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
| Method | Path | URI | Function |
|---|---|---|---|
| GET | /export | http://<instance address>/rest/v1/sharedjob/export | To export the metadata of the Shared Jobs within the instance. |
| POST | /import | http://<instance address>/rest/v1/sharedjob/import | To import the data of the Shared Jobs within the instance. |
| GET | /package | http://<instance address>/rest/v1/sharedjob/package | To get the package available within the Shared Job of the instance. |
| PATH/package/name/>packageName> | |||
| GET | /packageName/export | http://<instance address>/rest/v1/sharedjob/package/name/<packageName>/export | To export the specific package from the Shared Job within the instance. |
| GET | /packageName/job | http://<instance address>/rest/v1/sharedjob/package/name/<packageName>/job | To get the list of Jobs available within the current package of the instance. |
| POST | /packageName/delete | http://<instance address>/rest/v1/sharedjob/package/name/<packageName>/delete | To delete the selected package from the list using HTTP POST request. |
| DELETE | /packageName | http://<instance address>/rest/v1/sharedjob/package/name/<packageName> | Delete all jobs within a package. |
| PATH/job/name/<jobName> | |||
| GET | /jobName/export | http://<instance address>/rest/v1/sharedjob/package/name/<packageName>/job/name/<jobName>/export | To export the specific job available within the package. |
| GET | /jobName/revision | http://<instance address>/rest/v1/sharedjob/package/name/<packageName>/job/name/<jobName>/revision | To get the revisions available within the selected job. |
| POST | /jobName/delete | http://<instance address>/rest/v1/sharedjob/package/name/<packageName>/job/name/<jobname>/delete | Delete all revisions of a single job. |
| DELETE | /jobName | http://<instance address>/rest/v1/sharedjob/package/name/<packageName>/job/name/<jobName> | Delete all revisions of a single job. |
| PATH/revision/id/<revisionId> | |||
| GET | /revisionId/export | http://<instance address>/rest/v1/sharedjob/package/name/<packageName>/job/name/<jobName>/revision/id/<revisionId>/export | To export the specific job available within the package. |
| POST | /revisionId/delete | http://<instance address>/rest/v1/sharedjob/package/name/<packageName>/job/name/<jobname>/revision/id/<revisionId>/delete | To delete the selected job from the list using HTTP POST request. |
| DELETE | /revisionId | http://<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
| Method | Path | URI | Function |
|---|---|---|---|
| GET | /running | http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/running | Get the detail of the task running for the selected project. |
| GET | /history | http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/history | To 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>/cancel | http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/id/<taskId>/cancel | This will cancel the selected running task within the project using taskId. |
| PATH | /instance | http://<InstanceAddress>/rest/v1/group/name/<groupname>/project/name/<projectName>/task/instance/<taskId> | To get the detail of task by instance. |
| PATH/filter | |||
| GET | /by/none | http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/task/filter/by/none | List all the entries in the task history. |
| GET | by/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. |
| GET | by/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. |
| GET | by/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. |
| GET | by/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. |
| GET | by/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. |
| GET | by/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. |
| GET | by/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
| Method | Path | URI | Function |
|---|---|---|---|
| GET | userconfig/user | http://<InstanceAddress>/rest/v1/userconfig/user | Retrieve a list of all users. |
| GET | userconfig/export | http://<InstanceAddress>/rest/v1/userconfig/export | To export user configuration. |
| POST | userconfig/import | http://<InstanceAddress>/rest/v1/userconfig/import WITH POST DATA arg0 | To import user configuration. |
| PATH | user/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
| Method | Path | URI | Function |
|---|---|---|---|
| GET | /name | http://<instanceaddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/name | Get the name of the current version. |
| GET | /id | http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/id | Get the id of the selected version. |
| GET | /export | http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/export | To export the metadata of the current version within the project. |
| GET | /orchestration | http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/orchestration | To retrieve the details of the Orchestration within the selected project. |
| GET | /transformation | http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/transformation | To retrieve the details of the Transformation within the selected project. |
| POST | /delete | http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/delete | To delete the selected version using POST HTTP method. |
| DELETE | /versionName | http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName> | To delete the selected version using DELETE HTTP method. |
| PATH/job | |||
| GET | /export | http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/job/name/<jobName>/export | To export the data of the job within the current version. |
| POST | /delete | http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/job/name/<jobName>/delete | To delete the selected job using POST HTTP method. |
| POST | /run | http://<InstanceAddress>/rest/v1/group/name/<groupName>/project/name/<projectName>/version/name/<versionName>/job/name/<jobName>/run?environmentName=<environmentName> WITH POST DATA arg0 | Run 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 | /validate | http://<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 | /jobName | http://<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
| Method | Path | URI | Function |
|---|---|---|---|
| GET | /webhookpayloadprofile | http://<instanceaddress>/rest/v1/webhookpayloadprofile | Export the list of webhookpayload profile. |
| GET | /export | http://<instanceaddress>/rest/v1/webhookpayloadprofile/export | Export all webhook profiles. |
| POST | /import | http://<InstanceAddress>/rest/v1/webhookpayloadprofile/import WITH POST DATA | Import one or more webhook. |
| GET | /name/<webhook>/export | http://<InstanceAddress>/rest/v1/webhookpayloadprofile/name/<webhook>/export | Export the selected webhook. |
| DELETE | /name/<webhook>/delete | http://<InstanceAddress>/rest/v1/webhookpayloadprofile/name/<webhook>/delete | Delete the selected webhook via DELETE request. |