Skip to main content

Session and services API actions

Use the session and services API actions to manage admin sessions and configure service settings

Use the following actions to manage admin sessions and configure general service settings

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 log out 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.

This page outlines the session and services API actions for managing admin sessions and configuring service settings within a FairCom server environment. It details specific actions like creating, altering, deleting, describing, listing, and pinging sessions, each with a brief description and a link to further documentation. Additionally, it covers service-related actions such as listing and managing services, also with descriptions and links to the available API actions for session and service management.

API actions
admin session actions
admin service actions
JSON ADMIN API
jsonAction
sessions and services
create session
alter session
delete session
describe session
list session
ping session
list service
manage service