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
.
This API is based on the jsonAction protocol, which POSTs JSON requests to one endpoint on a server and returns JSON responses. This section defines the JSON payloads that can be POSTed to the FairCom server over HTTP, HTTPS, WS, and WSS using the endpoint /api
, such as https://localhost:8443/api
.
Sessions
Action | Description |
---|---|
Modifies the settings of a session, such as changing the default database and owner. | |
Allows an account to log into a FairCom server. | |
Allows an account to logout and close a session. | |
Describes the settings for one or more sessions. | |
Lists sessions that the current account is authorized to see. | |
Keeps a session alive and returns failure when a session is inactive. |
Services
Action | Description |
---|---|
Returns information about each specified service. | |
Configures the general settings of a FairCom server service. |