Page Comparison

...

	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	See Add Key: JSON Example.
Properties	See Add Key: JSON Properties.

Anchor

	add key
	add key

Add Key: JSON Example

...

	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
Example	See List Keys: JSON Example.
URI Parameters	See List Keys: URI Parameters.

Anchor

	list key
	list key

List Keys: JSON Example

Example

JSON

Example Response

Expand

title	JSON

Code Block

language	js

{
    "pgp": [
        {
            "name": "test1.key",
            "owner_type": "users",
            "pgp_name": "test1.key",
            "pgp_email": "test1@example.com",
            "pgp_algorithm": "rsa2048",
            "comment": "first test"
        },
        {
            "name": "test1.pub",
            "owner_type": "users",
            "pgp_name": "test1",
            "pgp_email": "test1@example.com",
            "pgp_algorithm": "rsa2048",
            "public_key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nmQENBGKd5IMBCACz6jW8UpCGd5mVhqFVwNklZem7OAaOCG3LoIZK/EsI3b+ex0n4\nbQmXmKjZeCydqtVbeJl6INip9vlj0Tiz1k+eNqRsPbo5RtQk/ObPQz0uwmmK0Xuo\nAmG6ECsv+g1jG6B6Sz2Gq3HuUO7DA77ltVWqx7uQycMDGrJlgR9Gyplnc9Nuir+G\nsx1BYgcr5wpGOk/YdH94sGtIaYYhV7JMhVHhLFonhzEIwCpOx26ISd8XGoiAdW7V\n2X3DsmOuZJVBK8v2MGDu1TIa5/W/wF77RCZmYxULv7Xt8b/o91vz2a6dJcB1LDO6\nYNoqZAev4ynXxX6tC/tVrV1RoqmsFvQvCG8RABEBAAG0GXRlc3QxIDx0ZXN0MUBl\neGFtcGxlLmNvbT6JAVQEEwEIAD4WIQTZR01OCmqYzlvbtAulzqxSXGHdlAUCYp3k\ngwIbAwUJA8JnAAULCQgHAgYVCgkICwIEFgIDAQIeAQIXgAAKCRClzqxSXGHdlFNA\nB/0cNN5/ZfEdU31OBc806WR0/Z6tYCYot0a0XBGL3v8gVCgf9PAibVg3WxDH0YwB\nTy0pphu1YThZcBG//WZjWC2006nZUVgCBwb/phVozs1k5N8bHyO6jwywPz2nctX7\n5f2gTksNfJKbIm+3mt6SxmDC4cfmVzXDfEkr/d/6AZ/VX4gm5mApPyxiPW5U8M1Y\nDXwspo4h3cn1r37w8SZB0GBMQXVk1rCaIqXnw+kDNgjXFDsxJKQL/uEqPK12UP3P\nZPhz0pKKq8f8r0H9ctmee0J25lG/gPDt+Om8tGvbcIhrXHEE44dIMsE5tdcSM7zn\nCnpDA44AOzr9wxI8MA0IkicZuQENBGKd5IMBCAC5ToCtudbiZblXfgHhLS4bpG/M\nnClOalq4Zo5+vWJnXkavNUdvUz0v+2nChSCVg7XpQLelov4EyEbPFsZsCvisRSmW\nn2ECWKmIssT72/N1ml2elYopU9CFnSrpy8/49G5GvBjKlHS/OFtZNM8rbvPal5PQ\nUO5dZsFeZjGxFt99zFlt1BM5tWwd9cbD4FMSo2Dw6isE5ICqKVsnWnobr4USTuuT\n8Zi2O+Ze7leGSlM/dGdVwM39o4b8vO7nDly98ztRhfobjOQIG/n1pIvQmTAspgGL\nYkDnosF4gF5oa0LIG43FaK1OxCVHoGhnHvsPV4N0rcAHW0C+cblRO0+SjrqlABEB\nAAGJATwEGAEIACYWIQTZR01OCmqYzlvbtAulzqxSXGHdlAUCYp3kgwIbDAUJA8Jn\nAAAKCRClzqxSXGHdlGw7B/0XULMy9mDzQi9PN2i+QzQxKjAofSUJHYcl9tpsG+8D\nmQV2sNdGwrdTynKqGBIMcjY+ryY6Jjigqjwa2eg5d3AjGHCDdxJdBABJjyfHQxwE\nFqmAyipEW5z9HpKZS+mPva+6sINBXSvSoHgOkM1vwAIHRJc0tSD0i4TiUnbPlW2s\noJAMZbc9WcQmr4X+kUgnG8C6LJw3x3kpU2AOGfQmF9uIM0bgIc0FclxtCc8OTq6A\nSReh9/IGRgoXDY9TKoU1h6fzAdH+xQv0WCmr0vyrI0akB0WFaPkLw6Xn5YBrqgPa\nyiaWoy3mBR5JDkBZXs72Eg3eibSuwVbCzNI4p73BpivL\n=rp6q\n-----END PGP PUBLIC KEY BLOCK-----",
            "comment": "first test"
        }
    ]
}

Anchor

	add list key parametersadd
	list key parameters

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	See Get a Key: JSON Example.

Anchor

	get key
	get key

Get a Key: JSON Example

...

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-gw-gateway0\",\"UsernameName\":\"totosftp_server_35281\",\"PasswordHashAddress\":\"$2a$12$J94lRBsky2Eud/D/U5Fk7urldJY.le3YwFbMmIk5iZTDpKabt/Loi0.0.0.0:4003\",\"PermissionsProtocol\":0}",
   \"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

...

Versions Compared

Old Version 4

New Version Current

Key

Add Key: JSON Example

List Keys: JSON Example

List Keys: URI Parameters

Get a Key: JSON Example

Get an audit record