Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The UDMG Server REST API is implemented by a customized version of the waarp-gatewayd server (UDMG-Client)provided by the udmg-server daemon and provides all the operations that can be performed with the UDMG Client or with the UDMG Client.

Authentication

Only Local User Account authentication is supported for the REST API.

SSO and LDAP authentication is only used for the Graphical User Interface.


Authentication of REST requests is done using basic HTTP authentication.

...


Description

URI

http://host_name:port/api/sb_pgp

HTTP Method

POST

Description

Adds a new pgp PGP key

Example URI

http://localhost:808018080/api/sb_pgp

Authentication

HTTP Basic

Consume Content-Typeapplication/json

Response Header

Location – The path to the newly created key

Example

See Add Key: JSON Example.

Properties

See Add Key: JSON Properties.

...


Description

URI

http://host_name:port/api/sb_pgp

HTTP Method

GET

Description

Displays a list of all keys meeting matching with the criteria below. The private key value is not returned.

Example URI

http://localhost:808018080/api/sb_pgp

Authentication

HTTP Basic

Produce Content-Typeapplication/json

URI Parameters

See List Keys: URI Parameters.

Example

See List Keys: JSON Example.

...


Description

URI

http://host_name:port/api/sb_pgp/key_name

HTTP Method

GET

Description

Retrieves a PGP key details

Example URI

http://localhost:808018080/api/sb_pgp/test1.pub

Authentication

HTTP Basic

Produce Content-Typeapplication/json

Example

See Get a Key: JSON Example.

...


Description

URI

http://host_name:port/api/sb_pgp/key_name

HTTP Method

DELETE

Description

Deletes the given key.

Example URI

http://localhost:808018080/api/sb_pgp/test1.pub

Authentication

HTTP Basic


Audit Management

...