...
The Agent Proxy client is exposing a REST API for the maintenance of the forwarding services. The port is configured with the '[client.api] port' parameter.
Below are the available endpoints and examples of requests and responses.
Authentication
Only one set of credentials is supported for the REST API. It is configured under the [client.api] section with the user and password parameters
| Code Block |
|---|
[client.api]
# UDMG Agent Client Admin API
port="2280"
# API basic authentication credentials, no default
username = "api_user"
password = "api_password" |
The authentication of REST requests is done using basic HTTP authentication.
This authentication scheme is done using the HTTP Authorization header. To authenticate, the client must:
Step 1 | Obtain user login and password. |
|---|---|
Step 2 | Build the user ID by concatenating the login, a colon (“:”) character ,and the password. |
| Step 3 | Encode the obtained identifier in Base64. |
| Step 4 | Prefix the encoded identifier with a declaration of the basic authentication scheme (“Basic”). |
For example, if the user enters the name "Aladdin" and the password "open sesame", then the client must send the following header:
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
If the authentication of a request fails, the server will respond with an HTTP code .401 - Unauthorized
Agent Administration
Agent Proxy Status
...