v1

latestOpenAPI 3.0.02026-07-175652103.9 KB

address book

Add peer

This function is an API endpoint that adds a peer to an address book.

Parameters

ab: The identifier of the address book.
request: A JSON object containing the new peer information.

Returns

If successful, this function returns an ActionResponse::Empty object.

post/api/ab/peer/add/{ab}

Path parameters

abstring required

Request body

idstring required

hashstring nullable

passwordstring nullable

usernamestring nullable

hostnamestring nullable

platformstring nullable

aliasstring nullable

tagsstring[] nullable

forceAlwaysRelayboolean nullable

rdpPortstring nullable

rdpUsernamestring nullable

loginNamestring nullable

same_serverboolean nullable

Response

# 200 OK
This response is given when the request is successful.
The body is empty if there is no error,
The body contains a json object with the error {"error":"Error message"}