Home
›
Management API

Management API

The Hypori Management API is organized around REST. Our API authenticates requests with client certificates for a user with the Administrator role, has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and verbs.

The Hypori Management API provide programmatic access to the following core management functions:

  • Manage user accounts.
  • Manage virtual device lifecycles.
  • Manage client policy and virtual device policy assignments.
  • Manage virtual device template assignments.

Authentication

API requests are authenticated using a combination of client certificates and X-AUTH-TOKEN headers. To use the API, obtain the following information from your Hypori Site Administrator:

  • An administrator account for your use.
  • A “.p12” client certificate file and certificate file passphrase for your administrator account.
  • The management server hostname and port for your cluster, such as mgmt.example.com port 443.

If you are using a client that requires a “.pem” certificate file, you can convert the “.p12” file into a “.pem” file using a tool such as openssl.

openssl pkcs12 -in mycert.p12 -out mycert.pem -nodes

To start using the API, make a first HTTP POST request (without body) to the endpoint /api/v2/authenticate/adminuilogin to obtain an authentication token.

curl --cert mycert.p12:passphrase --request POST \
'https://mgmt.example.com:443/api/v2/authenticate/adminuilogin'
{ ... "token": "a1b2c3...", ... }

The response is a JSON document with a “token” field. Include the token in the “X-AUTH-TOKEN” HTTP header field in all subsequent requests.

curl --cert mycert.p12:passphrase --request POST \
--header "X-AUTH-TOKEN: a1b2c2..." \
'https://mgmt.example.com:443/api/v1/cloudconfigs'