Skip to main content

Administrative API

This section describes FairCom’s server administrative API. The API uses the jsonAction protocol. The API contains actions for managing the server. The server endpoint over HTTP is /api.

Sessions

Action

Description

"alterSession"

Modifies the settings of a session, such as changing the default database and owner.

"createSession"

Allows an account to log into a FairCom server.

"deleteSession"

Allows an account to logout and close a session.

"describeSessions"

Describes the settings for one or more sessions.

"listSessions"

Lists sessions that the current account is authorized to see.

"pingSession"

Keeps a session alive and returns failure when a session is inactive.

Services

Action

Description

"listServices"

Returns information about each specified service.

"manageService"

Configures the general settings of a FairCom server service.