Communication between clients and the Management API

There are 2 options when a client connects to the Management API:

• In deployments where there are limited concerns about the security of traffic between the client and the Management API machine, the client can connect using only basic authentication. For example:

  curl -k -u username:password https://10.82.5.74:15873/ web/api/v1/categories

• In deployments where there is more concern about securing traffic between client and server:
  1. Copy the server certificate to a directory on the client system that can be accessed by the administrator communicating with the API.
  2. Specify both the certificate name and the basic authentication account when connecting to the Management API server. For example:

     curl --cacert cert_name.crt -u username:password https://10.203.30.40:15873/web/api/v1/categories

In either case, if the connection account password is not specified in the request, the administrator is prompted to provide it.

Instructions for defining the account used for basic authentication, as well as instructions for creating the server certificate, can be found in the Management API Deployment & Installation Guide.