Service: Station

Reading and editing the stations

Functions

Result	Name / Params			Comment
StationGetResult	station.Get			Returns a filtered list of Station Objects.
		mode	string	(Optional) View of the objects to return: raw or effective. Default is effective. See DataMode.
		include	string	(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay). See DataMode.
		filter	DataFilter	(Optional) Filter definition which determines the result set.
		sort	DataSortItem[]	(Optional) Sorting definition as a list of properties with order.
		offset	int	(Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination.
		limit	int	(Optional) Maximum amount of Objects that should be returned. (Max : 100000)
		select	string[]	(Optional) List of properties that should be contained in the result objects.
StationGetResult	station.GetNext			Returns a filtered list of Station Objects as a follow up to a previous Get call.
		context	string	The context received within the last get result. Mandatory for subsequent get calls with pagination.
		scroll	int	(Optional) Scrolls through the result set with 'Next' or 'Prev'. Used for pagination. See PaginationScroll.
		offset	int	(Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination.
		limit	int	(Optional) Maximum amount of Objects that should be returned. (Max : 100000)
Station	station.GetOne			Returns a single Station Object identified by the given id.
		id	guid	The Station's id.
		mode	string	(Optional) View of the object to return: raw or effective. Default is effective. See DataMode.
		include	string	(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay). See DataMode.
		select	string[]	(Optional) List of properties that should be contained in the result object.
guid	station.Create			Creates the Station in the system and returns the id of the Station. The Station must not have an id. If an id is set, the creation is rejected and an empty id is returned.
guid		object	StationRaw	The Station to create.
bool	station.Update			Updates a Station with data from the provided Object.
		id	guid	Id of the Station to update.
		object	StationRaw	Station to update
bool	station.Set			Sets specific properties of a Station Object.
		id	guid	Id of the Station to modify.
		props	value{}	(Key: SymbolPath) List of properties that should be set. Property paths may be used as ids to address any partial aspect of the Object.
bool	station.Delete			Deletes a Station Object. Returns true if successfully deleted or if no such Object existed to begin with.
bool		id	guid	Id of the Station to delete.
bool	station.BulkModify			Performs a bulk of changes at once.
		create	StationRaw[]	(Optional) List of Station Objects to create.
		update	StationRaw[]	(Optional) List of Station Objects to update.
		set	ObjectAspect[]	(Optional) List of Station Object properties to set.
		delete	guid[]	(Optional) List of Station ids to delete.

Notifications

Name / Params			Comment
station.Created			Notifies about new Station Objects.
	objects	Station[]	Newly created Station Objects.
station.Updated			Notifies about updated Station Objects.
	objects	Station[]	Changed Station Objects.
station.Deleted			Notifies about deleted Station Objects.
	ids	guid[]	Ids of the deleted Station Objects.
station.State			Notifies of State changes.
	objects	StationStateNotify[]	Modified States.

Objects

Station

This object extends StationRaw.

Property	Type	Description
State	StationState	(Not in default set, Computed)
EditTime	time	(Readonly, Not in default set)
EditUser	string	(Readonly, Not in default set)

StationState

Property	Type	Description
StationCode	string	Station code, identifying the station to which the state belongs. This is only set inside notifications.
RequiredAction	int	Indicates whether the station must reconnect or restart for configuration changes to take effect. See RequiredAction.
User	string	The user currently logged in to the station.
License	string	The license currently used for the station.
UpConnections	UpConnection[]	All current up-connections of this station. Disconnected connections are not listed.
Reachable	bool	Indicates whether this Station is reachable.
ConnectionType	int	Indicates if a NetConnection is active/inactive or if it’s an IpcConnection. See ConnectionType.
HasControl	bool	Indicates whether this station currently has exclusive control.
StationType	int	Station type, identifying what this Station can do. See StationType.

UpConnection

Property	Type	Description
StationCode	string	Station code, identifying the connection target station.
Active	bool	Indicates whether the connection is currently active or inactive.

StationGetResult

Property	Type	Description
Objects	Station[]	Array of Objects.
Pagination	Pagination	Describes the result set, if not all Objects were returned.

StationRaw

Property	Type	Description
Id	guid	(Readonly)
SegmentIds	guid[]	Assigned segments.
Num	int	Station number, used as unique identifier for the station.
Code	string	Station code, used as unique identifier for the station. Only values which can be converted to [1,4094] are allowed (similar to X4 extension code).
Type	int	See StationType.
Name	string	Station name
Desc	string
Address	string	Default address to reach the station.
Port	int	Default port to reach the station.
Flags	int	See StationFlags.
LocationId	guid
ProfileIds	guid[]	Assigned profiles.
Destinations	string[]	Uplink station codes for this station.
GroupName	string	A name to group stations.
GroupRank	int	Rank within the associated station group (the lower the more important).
Certificate	string	Station’s assigned certificate fingerprint (hash).

StationStateNotify

Property	Type	Description
Id	guid
State	StationState

Enums

StationType

Name	Value	Description
Standalone	0
Server	1
LocalServer	2	Client (with local server functionality)
ExtensionServer	3	Client (with extension server)
Client	4
Display	5
Floating	6	AOP client (e.g. web client)
Unknown	65535	Invalid type

StationFlags (Flags)

Name	Value	Description
UsedForCop	0x2
Exposed	0x8	Not allowed for server and local server

ConnectionType

Name	Value	Description
Unknown	0
Active	1
Inactive	2
Aop	3

RequiredAction

Name	Value	Description
Nothing	0
ReconnectUp	1
ReconnectAll	2
Restart	3

Last modified September 25, 2026