...
Refer to the original version of the waarp-gatewayd v0.7.1 5 server documentation for the common operations:
- Service Status
- User Management
- Transfer Management
- History Management
- Local Servers Management
- Remote Partners Management
- Rules Management
- Configuration Override
| Note | ||
|---|---|---|
| ||
UDMG Server is customized and the actual API request and response syntax may differ significantly from the original version. Please consult your Stonebranch contact or the Stonebranch Customer Portal for more comprehensive documentation. |
UDMG Specific Operations
In addition to what is supported by the original version of the waarpthe waarp-gatewayd v0.7.1 server, the following commands have been added for UDMG:
- PGP Key Management:
sb_pgp - Audit Management:
sb_audit - Business Service Management:
sb_businessservices - User Group Management:
sb_usergroups - High Availability monitoring
PGP Key Management
PGP key records can be stored in the UDMG database and retrieved with the CLI or the REST API to be used by scripts or by Universal Controller tasks without having to keep them in a local keyring.
...
Description | |
|---|---|
URI | http://host_name:port/api/sb_pgp |
HTTP Method | POST |
Description | Adds a new PGP key |
Example URI | http://localhost:18080/api/sb_pgp |
Authentication | HTTP Basic |
| Consume Content-Type | application/json |
Response Header | Location – The path to the newly created key |
Example | |
Properties |
| Anchor | ||||
|---|---|---|---|---|
|
Add Key: JSON Example
To create a public PGP key, the syntax is as follows:
| Example | JSON | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Example Request |
| ||||||||||
| Example Response |
|
| Anchor | ||||
|---|---|---|---|---|
|
Add Key: Properties
Property | UI Field Name | Description |
|---|---|---|
| name | Name | The name of the key, must be unique. |
| pgp-name | PGP Name | The key user name. |
| pgp-email | The associated email. | |
| pgp-algo | PGP Algorithm | The algorithm that was used for creating the key (free text, for reference). |
| valid-from | Start Date | The valid from date |
| valid-to | End Date | The expiration date |
| private-key | Private Key | The private key. It must be in ascii armored format. |
| public-key | Public Key | The public key. It must be in ascii armored format. |
| passphrase | Passphrase | The passphrase of the private key. |
| comment | Comment | An additional comment to describe the PGP key. |
...
Description | |
|---|---|
URI | http://host_name:port/api/sb_pgp |
HTTP Method | GET |
Description | Displays a list of all keys matching with the criteria below. The private key value is not returned. |
Example URI | http://localhost:18080/api/sb_pgp |
Authentication | HTTP Basic |
| Produce Content-Type | application/json |
URI ParametersExample | |
URI Parameters.Example | See List Keys: JSON Example.URI Parameters. |
| Anchor | ||||
|---|---|---|---|---|
|
List Keys: JSON Example
| Example | JSON | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Example Response |
|
| Anchor | ||||
|---|---|---|---|---|
|
List Keys: URI Parameters
...
Description | |
|---|---|
URI | http://host_name:port/api/sb_pgp/key_name |
HTTP Method | GET |
Description | Retrieves a PGP key details |
Example URI | http://localhost:18080/api/sb_pgp/test1.pub |
Authentication | HTTP Basic |
| Produce Content-Type | application/json |
Example |
| Anchor | ||||
|---|---|---|---|---|
|
Get a Key: JSON Example
| Example | JSON | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Example Response for a privatekey |
| ||||||||||
| Example Response for a public key |
|
...
| Code Block |
|---|
GET /api/sb_pgp?sort=id-&limit=2
{
"audit": [
{
"id": 87642,
"action": "DELETESTOP",
"table_name": "userslocal_agents",
"table_key": 449,
"before": "{\"ID\":449,\"Owner\":\"waarpmft-gatewaygw-0\",\"UsernameName\":\"totosftp_server_35281\",\"PasswordHashAddress\":\"$2a$12$J94lRBsky2Eud/D/U5Fk7urldJY.le3YwFbMmIk5iZTDpKabt/Loi\",\"Permissions\":00.0.0.0:4003\",\"Protocol\":\"sftp\",\"Enabled\":{\"T\":true},\"RootDir\":\"rootdir_sftp\",\"ReceiveDir\":\"in\",\"SendDir\":\"out\",\"TmpReceiveDir\":\"tmp\",\"ProtoConfig\":{\"commands\":{}}}",
"after": "",
"status": "SUCCESS",
"info": "",
"user": 10,
"date": "20222024-0601-20T0716T11:5413:1013.009859Z7915008Z",
"parent_id": ""
},
{
"id": 86641,
"action": "CREATE",
"table_name": "usersremote_accounts",
"table_key": 428,
"before": "",
"after": "{\"ID\":40,\"OwnerRemoteAgentID\":\"waarp-gateway\"42,\"UsernameLogin\":\"totouser_35281\",\"PasswordHashPassword\":\"$2a$12$J94lRBsky2Eud/D/U5Fk7urldJY.le3YwFbMmIk5iZTDpKabt/Loi\",\"Permissionspassword\":0}",
"status": "SUCCESS",
"info": "",
"user": 10,
"date": "20222024-0601-20T0716T11:5412:0458.376231Z8763191Z",
"parent_id": ""
}
]
} |
Get an audit record
...