This is documentation for the Fudo PAM 4.4 version, which is no longer supported. You may want to check documentation for one of the supported Fudo PAM versions: 5.0, 5.1, 5.2, 5.3 or 5.4.
Servers
is a definition of the IT infrastructure resource, which can be accessed over one of the specified protocols.
Data structures
ServerModel
Parameter |
Type |
Description |
id |
bigserial |
Object Identifier |
name |
string |
Required |
address |
IPv4/string |
Write only, required if subnetmask is empty (static server) |
addresses |
string |
Read only, a list of IP addresses |
description |
string |
Object description |
http |
HTTPServerAttributes |
Required if protocol == http |
rdp |
RDPServerAttributes |
Required if protocol == rdp |
subnet |
SubnetModel |
Required if not address |
tls |
TLSServerAttributes |
|
remote_apps |
RemoteAppsAttributes |
Available for protocol == rdp |
legacy_ciphers |
bool |
Allow negotiating older encryption algorithms (DSA(1024), RSA(1024)) |
blocked |
bool |
|
reason |
string |
The reason for blocking Server object |
port |
int |
Required |
bind_ip |
IPv4 |
Required |
protocol |
string{checkout, citrixsf, http, ica, modbus, mysql, oracle, rdp, ssh, system, tcp, tds, telnet, tn3270, tn5250, vnc} |
Required |
HTTPServerAttributes
Parameter |
Type |
Description |
timeout |
int |
Default 900 |
RDPServerAttributes
Parameter |
Type |
Description |
ca_certificate |
PEM |
|
security |
string{std, tls, nla} |
|
TLSServerAttributes
Parameter |
Type |
Description |
ca_certificate |
PEM |
required if use_tls |
use_tls |
boolean |
|
RemoteAppsAttributes
Parameter |
Type |
Description |
id |
string |
|
server |
id |
|
name |
string |
required |
path |
string |
required |
args |
string |
|
variables |
id, name (required), encrypt, object_type, object_property |
|
ServerAddressModel
Parameter |
Type |
Description |
host |
IPv4 |
required |
http |
HTTPServerAddressAttributes |
|
rdp |
RDPServerAddressAttributes |
|
tls |
TLSServerAddressAttributes |
|
ssh |
SSHServerAddressAttributes |
|
SubnetModel
Parameter |
Type |
Description |
ip |
IPv4/string |
Subnetwork IP address, e.g. 10.0.255.255 . |
mask |
int |
Subnet mask in CIDR notation. |
subnet |
string |
|
HTTPServerAddressAttributes
Parameter |
Type |
Description |
host |
string |
|
tls_certificate |
string |
|
RDPServerAddressAttributes
Parameter |
Type |
Description |
tls_certificate |
PEM |
|
public_key |
PEM |
|
SSHServerAddressAttributes
Parameter |
Type |
Description |
public_key |
PEM |
|
TLSServerAddressAttributes
Parameter |
Type |
Description |
tls_certificate |
PEM |
|
Creating a server
Request
Method |
|
Path |
|
Headers |
Content-Type: Application/JSON
|
Body |
|
Possible Response
Status |
|
Headers |
Content-Type: Application/JSON
|
Body |
|
Description |
Object successfully created. Resultant object’s attributes are included in response body. |
Possible Response
Status |
|
Headers |
Content-Type: Application/JSON
|
Body |
|
Description |
Validation didn’t pass. |
Retrieving servers list
Request
Note
Results pagination
Every GET
request, which returns a collection of objects can be optionally paginated. To achieve it add a pagination parameter to the request path:
/api/system/objects?page=3&page_size=10
Pagination parameters
page |
int |
page_size |
int |
Possible Response
Status |
|
Headers |
Content-Type: Application/JSON
|
Body |
|
Retrieving a server
Request
Method |
|
Path |
/api/system/servers/:server_id
|
Possible Response
Status |
|
Headers |
Content-Type: Application/JSON
|
Body |
|
Possible Response
Status |
|
Description |
No server with given id. |
Modifying a server
Request
Method |
|
Path |
/api/system/servers/:server_id
|
Possible Response
Status |
|
Headers |
Content-Type: Application/JSON
|
Body |
|
Possible Response
Status |
|
Headers |
Content-Type: Application/JSON
|
Body |
|
Possible Response
Status |
|
Description |
No server with given id. |
Deleting a server
Request
Method |
|
Path |
/api/system/servers/:server_id
|
Possible Response
Possible Response
Status |
|
Description |
Object with specified identifier was not found. |
Retrieving users allowed to manage given server
Request
Method |
|
Path |
/api/system/servers/:server_id/granted_users
|
Note
Results pagination
Every GET
request, which returns a collection of objects can be optionally paginated. To achieve it add a pagination parameter to the request path:
/api/system/objects?page=3&page_size=10
Pagination parameters
page |
int |
page_size |
int |
Possible Response
Status |
|
Headers |
Content-Type: Application/JSON
|
Body |
[
{
'name': 'username',
'id': :id
}, ...
]
|
Granting management privileges
Request
Method |
|
Path |
/api/system/servers/:server_id/granted_users
|
Body |
{
''user_id'': :user_id
}
|
Possible Response
Revoking management privileges
Request
Method |
|
Path |
/api/system/servers/:server_id/granted_users/:user_id
|
Possible Response
Possible Response
Listing server addresses
Request
Method |
|
Path |
/api/system/servers/:server_id/addresses
|
Note
Results pagination
Every GET
request, which returns a collection of objects can be optionally paginated. To achieve it add a pagination parameter to the request path:
/api/system/objects?page=3&page_size=10
Pagination parameters
page |
int |
page_size |
int |
Possible Response
Possible Response
Status |
|
Headers |
Content-Type: Application/JSON
|
Body |
[
ServerAddressModel
...
]
|
Possible Response
Creating a server address
Request
Method |
|
Path |
/api/system/servers/:server_id/addresses
|
Headers |
Content-Type: Application/JSON
|
Body |
|
Possible Response
Status |
|
Headers |
Content-Type: Application/JSON
|
Body |
|
Possible Response
Status |
|
Headers |
Content-Type: Application/JSON
|
Body |
|
Possible Response
Status |
|
Description |
No server with given :server_id.
|
Updating a server address
Request
Method |
|
Path |
/api/system/servers/:server_id/addresses/:address_id
|
Body |
|
Possible Response
Status |
|
Headers |
Content-Type: Application/JSON
|
Body |
|
Possible Response
Status |
|
Headers |
Content-Type: Application/JSON
|
Body |
|
Possible Response
Status |
|
Description |
No server with given :server_id.
|
|
|
Description |
No server address with given :address_id
|
Deleting a server address
Request
Method |
|
Path |
/api/system/servers/:server_id/addresses/:address_id
|
Possible Response
Possible Response
Status |
|
Description |
No server with given :server_id.
|
|
|
Description |
No server address with given :address_id
|