Skip to main content

Administrative API

FairCom's server administrative API actions

Abstract

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 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 the JSON request to one endpoint on a server and returns the JSON response. 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

"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.

Hypertext Transfer Protocol (HTTP) is a standard request-response protocol that works on top of TCP/IP. It allows a client computer to send a request to a server computer, which in turn, replies to the request. The purpose of HTTP is to allow software to ask questions and receive answers.

Secure Hypertext Transfer Protocol (HTTP) is the HTTP protocol running over TLS. It provides secure request-response communications between computers.

WebSocket (WS) is a standard communication protocol for bidirectional exchange of data between computers, see RFC 6455. It works over TCP/IP and HTTP. It is often used by single page web applications because web browsers have built in support for WebSocket. It is also used by applications and servers that want to push messages to other computers in additional to using the request-response provided by HTTP.

WebSocket Secure (WSS)is the secure version of WebSocket. It uses TLS to create secure communications.