Retrieves the list of FTP servers.
Since Product Version: 3.2
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/settings/servers/ftpServers
Response Parameters
ipAddress
String
|
IP address of the server.
|
name
String
|
|
serverType
FTPServerTypeEnum
|
Type of the server.
Allowed values:
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v1/op/settings/servers/ftpServers
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/settings/servers/ftpServers" rootUrl="https://localhost/webacs/api/v1/op">
<ftpServerDTO>
<ipAddress>String value</ipAddress>
<name>String value</name>
<serverType>TFTP</serverType>
</ftpServerDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/settings/servers/ftpServers.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/settings\/servers\/ftpServers",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"ftpServerDTO" : {
"ipAddress" : "String value",
"name" : "String value",
"serverType" : "TFTP"
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/settings/servers/ftpServers
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
ipAddress
String
|
IP address of the server.
|
name
String
|
|
serverType
FTPServerTypeEnum
|
Type of the server.
Allowed values:
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v2/op/settings/servers/ftpServers
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/settings/servers/ftpServers" rootUrl="https://localhost/webacs/api/v2/op">
<ftpServerDTO>
<ipAddress>String value</ipAddress>
<name>String value</name>
<serverType>TFTP</serverType>
</ftpServerDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/settings/servers/ftpServers.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/settings/servers/ftpServers",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"ftpServerDTO" : [ {
"ipAddress" : "String value",
"name" : "String value",
"serverType" : "TFTP"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/settings/servers/ftpServers
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
ipAddress
String
|
IP address of the server.
|
name
String
|
|
serverType
FTPServerTypeEnum
|
Type of the server.
Allowed values:
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v3/op/settings/servers/ftpServers
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/settings/servers/ftpServers" rootUrl="https://localhost/webacs/api/v3/op">
<ftpServerDTO>
<ipAddress>String value</ipAddress>
<name>String value</name>
<serverType>TFTP</serverType>
</ftpServerDTO>
<ftpServerDTO>
<ipAddress>Another string value</ipAddress>
<name>Another string value</name>
<serverType>FTP</serverType>
</ftpServerDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/settings/servers/ftpServers.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/settings/servers/ftpServers",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"ftpServerDTO" : [ {
"ipAddress" : "String value",
"name" : "String value",
"serverType" : "TFTP"
}, {
"ipAddress" : "Another string value",
"name" : "Another string value",
"serverType" : "FTP"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/settings/servers/ftpServers
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
ipAddress
String
|
IP address of the server.
|
name
String
|
|
serverType
FTPServerTypeEnum
|
Type of the server.
Allowed values:
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Response Payload
https://localhost/webacs/api/v4/op/settings/servers/ftpServers
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/settings/servers/ftpServers" rootUrl="https://localhost/webacs/api/v4/op">
<ftpServerDTO>
<ipAddress>String value</ipAddress>
<name>String value</name>
<serverType>TFTP</serverType>
</ftpServerDTO>
<ftpServerDTO>
<ipAddress>Another string value</ipAddress>
<name>Another string value</name>
<serverType>FTP</serverType>
</ftpServerDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/settings/servers/ftpServers.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/settings/servers/ftpServers",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"ftpServerDTO" : [ {
"ipAddress" : "String value",
"name" : "String value",
"serverType" : "TFTP"
}, {
"ipAddress" : "Another string value",
"name" : "Another string value",
"serverType" : "FTP"
} ]
}
}