Core Server Instances

Last modified by michaely on 2021/09/10 23:34

This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.

The information on this page applies to iSymphony 3.1+.

Description

The core server instance REST resource allows access to the top level configuration for core servers. This resource allows adding, removing, and editing of core servers in the system.

On this page:

The [toc] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

Root Resource Path

communication_manager/rest/config/server/coreServers

JSON Representation

{
"id": "0a576628-502c-491a-9d49-670bbb79cfee",
"slug": "default",
"name": "default"
}

Property	Type	Description
id	String	The id of the core server.
slug	String	The slug (core server configuration directory name) of the core server.
name	String	The display name of the core server.

Resource Paths

communication_manager/rest/config/server/coreServers
Description	Accesses all the core server instances in the system.
GET	Gets all the core server instances in the system.
POST	Adds a core server to the configuration. Errors: 409 'A core server with the given id already exists.': Returned if an core server with the given id already exists. 409 'A core server with the given slug already exists.': Returned if an core server with the given slug already exists. 409 'No name provided.': Returned if no name was provided. 409 'No slug provided.': Returned if no slug was provided.

communication_manager/rest/config/server/coreServers/[{id} \| getByName/{slug}]
Description	Accesses the configuration of a specific core server instance. Parameters: id: The configuration id of the core server instance. slug : The slug of the core server instance.
GET	Gets the configuration of the specified core server. Errors: 404 'A core server with the given id does not exist': Returned if no core server exists with the given id. 404 'A core server with the given slug does not exist': Returned if no core server exists with the given slug.
PUT	Updates the specified core server configuration. Errors: 404 'A core server with the given id does not exist': Returned if no core server exists with the given id. 404 'A core server with the given slug does not exist': Returned if no core server exists with the given slug. 409 'No name provided.': Returned if no name was provided. 409 'No slug provided.': Returned if no slug was provided.
DELETE	Deletes the specified core server. Errors: 404 'A core server with the given id does not exist': Returned if no core server exists with the given id. 404 'A core server with the given slug does not exist': Returned if no core server exists with the given slug.

Sub/Child Resource Paths

communication_manager/rest/config/server/coreServers/[{id} \| getByName/{slug}]/managingAdministrators
Description	Access the sub/child resource for the Administrators that manage the specified core server instance. Parameters: id: The configuration id of the core server instance. slug : The slug of the core server instance. Errors: 404 'A core server with the given id does not exist': Returned if no core server exists with the given id. 404 'A core server with the given slug does not exist': Returned if no core server exists with the given slug. See Administrator Configuration for more information.

communication_manager/rest/config/server/coreServers/[{id} \| getByName/{slug}]/license
Description	Access the sub/child resource for the License of the specified core server instance. Parameters: id: The configuration id of the core server instance. slug : The slug of the core server instance. Errors: 404 'A core server with the given id does not exist': Returned if no core server exists with the given id. 404 'A core server with the given slug does not exist': Returned if no core server exists with the given slug. See Licensing for more information.

Curl Examples

Get all core server instances

curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/server/coreServers

Get the configuration for a specific core server instance

curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/server/coreServers/ee828da8-5ee6-413d-82ac-1273f598659d

Add a new core server instance

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"id": "0a576628-502c-491a-9d59-670bbb79cfee", "slug": "new_server", "name": "newServer"}' http://localhost:58080/communication_manager/rest/config/server/coreServers

Delete a core server instance

curl --user manager:manag3rpa55word -k -i -X DELETE http://localhost:58080/communication_manager/rest/config/server/coreServers/0a576628-502c-491a-9d59-670bbb79cfee

Update a core server instance

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d '{"id": "0a576628-502c-491a-9d59-670bbb79cfee", "slug": "new_server", "name": "newName"}' http://localhost:58080/communication_manager/rest/config/server/coreServers/0a576628-502c-491a-9d59-670bbb79cfee