Data products REST API#

The SEP REST API allows you to manage your data products automatically with the scripting and automation tool of your choice.

Authentication#

The REST API can be used for servers secured with the PASSWORD authentication type. API clients should authenticate by using Basic Authentication, and sending the authorization header with the Base 64 encoded user and password. For example, Basic + user:password (b64 encoded)

Authorization#

These APIs respect the data product privileges defined in built-in access control. To authorize their requests, users must send the X-Trino-Role header with the same value as the system role they want to enable. For example, X-Trino-Role : system=ROLE{roleName}

All user roles, except the sysadmin role, are enabled if the X-Trino-Role header is not set.

The following example displays a cURL command to retrieve a specific data product with the identifier 2f86c60f-2049-494f-8b26-6ce4a5bbb736 from the API with the necessary headers:

curl --location \
     --request GET 'https://sep.example.com/api/v1/dataProduct/products/2f86c60f-2049-494f-8b26-6ce4a5bbb736' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'X-Trino-Role: system=ROLE{sysadmin}' \
     --header 'Authorization: Basic dFHzdDp0ZXN0'

The result is a JSON document that represents the data product as an entity.

Entities and endpoints#

Use the detailed technical documentation for more information on all available endpoints and methods. Code options include cURL, Java, Android, Obj-C, JavaScript, C#, PHP, Perl, and Python.