Server Administration API

The ZSM Server supports a set of Management APIs used to manage the system, including organization management, application management, installation management, and consumer management. These are provided as REST APIs and secured through bearer tokens. They are available to customers for programmatic access.

Bearer Tokens

Server administration API endpoints are protected using bearer tokens. An "Authorization" request header with the "Bearer" authentication scheme along with the issued bearer token is added to the API request headers.

For example, assuming CURL is used and a valid bearer token is b8ad1fcc-9624-4c8c-a720-35294656964b, then the following would return a list of organizations:

$ curl -s -H "Authorization: Bearer b8ad1fcc-9624-4c8c-a720-35294656964b" $ZSM_HOST/api/organizations

For the following examples, 50563d0c-e487-4822-96d8-4af26ef35d38 is used as an example bearer token.

Server API Families

The ZSM Server provides APIs to manage: