API Documentation
Home > Total Uptime APIv2.0 Overview > Networking > Get All Ports Attached to a Server

Get All Ports Attached to a Server

Method:              GET
URI:                      /ALF/Server/{ServerId}/Port/All?{options}

This method will retrieve all of the ports that are currently attached to a server, if anything.

The {options} allow you to refine the results retrieved from the API. They must be formatted as a query string, e.g. if you use more than one, the 2nd one onwards should be preceded by an ampersand “&” character. The options include:

Parameter Description
perpage={perpage}
An integer for number of items you would like returned in this response E.g. {20}
pageno={page} An integer for the page number (only applicable if the perpage is used) E.g. {1}
sortField={sortField} The field you wish to sort by
sortOrder={sortOrder} The sort direction. E.g. {asc} or {desc}
searchField={searchField} The field you wish to search for
searchOper={searchOper} E.g. {contains}, {equal}, {not equal}, {begins with} or {ends with}
Used when a search field is specified
searchString={searchString} The value you wish to search for