16.20 - Overview of the Ecosystem Manager RESTful API - Teradata Ecosystem Manager

Teradata® Ecosystem Manager API Reference

prodname
Teradata Ecosystem Manager
vrm_release
16.20
created_date
December 2020
category
Programming Reference
featnum
B035-3204-107K

Ecosystem Manager RESTful APIs provide an interface to Ecosystem Manager features through HTTP requests. The RESTful APIs are accessed through REST client modules written in scripting languages, such as Python or any other REST client.

During installation of the EM-server package on the Ecosystem Manager Server, HTTPS is enabled by default for emrest service; you can switch to HTTP.

To access the RESTful API, include the Ecosystem Manager server on which the REST service is running, the port on which the service is listening, and the REST resource to reference. Swagger UI is available from one of the following:
Protocol Port Location Example
HTTPS 9443 https://host:port/swagger-ui.html#/ https://wario:9443/swagger-ui.html#/
HTTP 8090 http://host:port/swagger-ui.html#/ http://wario:8090/swagger-ui.html#/
The RESTful API service includes the following details:
  • Some calls to the RESTful service return information in JSON format in the Response body.
  • Calls made to Ecosystem Manager RESTful service may require input parameters. Some input parameters are provided in the URL path itself. Other input parameters may need to be specified in the request body in JSON format.
  • All calls made to the RESTful service return an HTTP status code showing success or failure.
  • Top-level endpoints can be obtained by issuing a GET request on root resource.

    For example: https://wario:9443