Get satellites

Satellites accessible for current user

Request

Query parameters

Optional. Returns satellites for a specific location ID.

GET /api/Satellite

Get satellite by id

Get satellite by ID.

Request

Path parameters

The ID of the satellite.

Response

Field Name	Type	Description	Notes

Field Name	Type	Description	Notes
ID	int	Satellite Rec ID
LocationID	int	Location Rec ID
Name	string	Satellite name
MACAddr	string	MAC address
FirmwareVersion	int	Firmware version	Integer representation of version # e.g. 12001 = v1.20.01
Status	string	Satellite current status	"Online" or "Offline"
StatusTime	DateTime	Last status update (UTC)
StartupTime	DateTime	Hardware startup time (UTC)
VPNConnectTime	DateTime	VPN connection time (UTC)
StatusChangeTime	DateTime	Time of reported status (UTC)	May be NULL if number of satellites ≥ 5 as this data lookup is expensive (i.e. time consuming to gather)
VPNIPv4Addr	string	VPN address	Value only as current as StatusTime indicates
PublicIPv4Addr	string	Last known public IP address	Value only as current as StatusTime indicates
OSMachine	string	Machine OS description
UptimeDay	int	Percentage uptime in last 24 hours	May be NULL if n/a
UptimeWeek	int	Percentage uptime in last 7 days	May be NULL if n/a
DisconnectsDay	int	Number of disconnects in last 24 hours	May be NULL if n/a
DisconnectsWeek	int	Number of disconnects in last 7 days	May be NULL if n/a
WifiFreqChan	int	Reader wifi frequency channel	1 ~ 2412 MHz 6 ~ 2437 MHz 11 ~ 2462 MHZ
WifiAffinity	int	Reader wifi affinity index	null = None assigned 1-4 = Assigned affinity
ReadersOnline	int	Number of readers online	Value only as current as StatusTime indicates
ReadersDefined	int	Number of readers defined	Value only as current as StatusTime indicates
ReadersAssigned	int	Number of readers assigned affinity for this satellite
UplinkStatus	int[3]	Array of Uplink (1-3) status codes	Value only as current as StatusTime indicates 0 = Status unknown 1 = Unable to get DHCP address 2 = No response from internet 3 = Unable to establish VPN connection 4 = Unable to establish FasServer connection 5 = No authorization 6 = SNMP and/or API to Router OS failed 7 = No connection at interface 8 = No connection to wireless access point 9 = No response from gateway 10 = Fully online with server 11 = No response from FasCard data center router 12 = Available but not currently in use 13 = Uplink not defined
ProcessorLoad	int	Processor load	Value only as current as StatusTime indicates Percentage (0-100)
FasSatMemoryUsage	int	FasSat memory usage	Value only as current as StatusTime indicates bytes

GET /api/Satellite/{satID}

Get satellite history

Single satellite

Retrieve satellite status history for a particular satellite. Similar to admin site, only changes in status or uplinks will be listed. Default 20 change records.

Request

Query parameters

Number of records to return. Max is 1000.

GET /api/Satellite/{satID}/History

Multiple satellites by history id

Retrieve satellite status history for satellites at an account or location. Similar to admin site, only changes in status or uplinks will be listed.

Request

Query parameters

Optional ID of the FasCard account to retrieve all satellites associated across all locations of Account

Optional ID of the FasCard location to retrieve all satellites associated at Location

Number of records to return. Max is 1000.

Satellite status record ID to start at

Defines whether records before or after the LastID will be retrieved

Response

Field Name	Type	Description	Notes
`ID`	long	SatelliteStatus Rec ID
`SatelliteID`	int	SatelliteRec ID
`Status`	int	Status code	0 = Offline 1 = Online
`StatusTime`	DateTime	Time of reported status (UTC)
`FirmwareVersion`	int	Firmware version	Integer representation of version # e.g. 12001 = v1.20.01
`OSMachine`	string	Machine OS description
`StartupTime`	DateTime	Hardware startup time (UTC)
`VPNConnectTime`	DateTime	VPN connection time (UTC)
`VPNIPv4Addr`	string	VPN address	Value only as current as StatusTime indicates
`PublicIPv4Addr`	string	Last known public IP address	Value only as current as StatusTime indicates
`ReadersOnline`	int	Number of readers online	Value only as current as StatusTime indicates
`ReadersDefined`	int	Number of readers defined	Value only as current as StatusTime indicates
`UplinkStatus`	int[3]	Array of Uplink (1-3) status codes	Value only as current as StatusTime indicates 0 = Status unknown 1 = Unable to get DHCP address 2 = No response from internet 3 = Unable to establish VPN connection 4 = Unable to establish FasServer connection 5 = No authorization 6 = SNMP and/or API to Router OS failed 7 = No connection at interface 8 = No connection to wireless access point 9 = No response from gateway 10 = Fully online with server 11 = No response from FasCard data center router 12 = Available but not currently in use 13 = Uplink not defined
`ProcessorLoad`	int	Processor load	Value only as current as StatusTime indicates Percentage (0-100)
`FasSatMemoryUsage`	int	FasSat memory usage	Value only as current as StatusTime indicates bytes

GET /api/Satellite/History?Account=123&Limit=10&LastID=500&Older=True

Example querying satellite status history for Account 123 limited to 10 records starting at ID49 ordered descending

GET /api/Satellite/History?Location=456&Limit=25&LastID=0&Older=False

Example querying satellite status history for Location 456 limited to 25 records starting at ID0 (i.e. oldest) ordered ascending