REST API Calls

The ztC Edge system supports the following Representational State Transfer (REST) application program interface (API) calls:

login

Posts the login information for access to resource information. This authorization call prevents unauthorized users from accessing the system. Issue this call first, then copy the value of session-id from the response JSON string, and use this value as JSESSIONID in the header of future calls.
Header Value Required
Content-type application/json Yes
Request Value Required
Username The username for logging on to the ztC Console. Yes
Password The password for username. Yes

Endpoint

The following is the endpoint, given a base URL of /restapi:

POST /login

Example

Request URL:

https://{hostname or IP address}/restapi/login

overview

Gets system information, including physical machine properties, statistics, system performance, and current alert list. The response can be large (about 14KB).
Header Value Required
Locale de (German), en-US (English), ja (Japanese), zh-CN (Chinese), or pt-br (Portuguese). Default locale is en-US. No
Content-type application/json Yes

Endpoint

GET /system/overview

Example

Request URL:

https://{hostname or IP address}/restapi/system/overview

vms

Gets the list of VMs present in the system.

Header Value Required
JSESSIONID session-id value in the login call response Yes
Content-type application/json Yes

Endpoint

GET /v1/vms

Example

Request URL:

https://{hostname or IP address}/restapi/v1/vms