Spawner service v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

A sample API

Base URLs:

• /

Default

get__version

GET /version

Get User container version

Example responses

200 Response

{
  "date": null,
  "commit": "string",
  "version": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline
404	Not Found	none	Inline
500	Internal Server Error	none	InternalError

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» date	Date	false	none	none
» commit	string	false	none	none
» version	string	false	none	none

Status Code 404

Name	Type	Required	Restrictions	Description
» code	integer	false	none	none
» data	string	false	none	none

post__launch

POST /launch

Used to run builtin application process

Body parameter

{
  "command": "string",
  "args": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» command	body	string	true	none
» args	body	[string]	false	none

Example responses

200 Response

{
  "code": 0,
  "data": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	none	launch
500	Internal Server Error	none	InternalError

post__setAudioQuality

POST /setAudioQuality

Set the audio quality

Body parameter

{
  "sink": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» sink	body	string	true	none

Example responses

200 Response

{
  "code": 0,
  "data": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	none	processResult
500	Internal Server Error	none	InternalError

post__playAudioSample

POST /playAudioSample

Play a sample audio

Example responses

200 Response

{
  "code": 0,
  "data": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	none	processResult
500	Internal Server Error	none	InternalError

put__configurePulse

PUT /configurePulse

Configure pulse audio for Janus

Body parameter

{
  "destinationIp": "string",
  "port": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» destinationIp	body	string	true	none
» port	body	string	true	none

Example responses

200 Response

{
  "code": 0,
  "data": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Success
500	Internal Server Error	none	InternalError

post__broadcastwindowslist

POST /broadcastwindowslist

Emit a broadcast with window list as data

Example responses

200 Response

{
  "code": 0,
  "data": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Success
500	Internal Server Error	none	InternalError

post__clipboardsync

POST /clipboardsync

Synchronize X11 and gtk clipboard

Example responses

200 Response

{
  "code": 0,
  "data": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Success
500	Internal Server Error	none	InternalError

post__setDesktop

POST /setDesktop

Store a data as json file in desktop

Body parameter

{
  "key": "string",
  "value": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» key	body	string	true	none
» value	body	string	true	none

Example responses

200 Response

{
  "code": 0,
  "data": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Success
500	Internal Server Error	none	InternalError

get__getDesktop

GET /getDesktop

Get a data stored as json file

Parameters

Name	In	Type	Required	Description
key	query	string	true	none

Example responses

200 Response

{
  "code": 0,
  "data": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline
500	Internal Server Error	none	InternalError

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	none
» data	object	false	none	none

get__getmimeforfile

GET /getmimeforfile

Get a mime for a given filename

Parameters

Name	In	Type	Required	Description
filename	query	string	true	none

Example responses

200 Response

{
  "data": {}
}

Responses

Status	Meaning	Description	Schema
200	OK	none	MIME
500	Internal Server Error	none	InternalError

get__filesearch

GET /filesearch

Used for list files by dock

Parameters

Name	In	Type	Required	Description
maxfile	query	integer	false	none
keywords	query	string	true	none

Example responses

200 Response

{
  "code": 0,
  "data": [
    {
      "file": "string",
      "mime": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline
500	Internal Server Error	none	InternalError

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	none
» data	[object]	false	none	none
»» file	string	false	none	none
»» mime	string	false	none	none

post__generateDesktopFiles

POST /generateDesktopFiles

Build desktop files to run containerized applications

Body parameter

{
  "list": [
    {
      "mimetype": "string",
      "path": "string",
      "executablefilename": "string",
      "icon": "string",
      "name": "string",
      "launch": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» list	body	[object]	true	none
»» mimetype	body	string	false	none
»» path	body	string	false	none
»» executablefilename	body	string	false	none
»» icon	body	string	false	none
»» name	body	string	false	none
»» launch	body	string	false	none

Example responses

200 Response

{
  "code": 0,
  "data": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Success
500	Internal Server Error	none	InternalError

get__getappforfile

GET /getappforfile

Allow to get the app necessary

Example responses

200 Response

{
  "code": 0,
  "data": [
    {
      "command": "string",
      "args": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	none	AppForFile
500	Internal Server Error	none	InternalError

get__about

GET /about

Get system informations

Example responses

200 Response

{
  "hostname": "string",
  "ipaddr": "string",
  "plateform": "string",
  "arch": "string",
  "release": "string",
  "cpu": "string",
  "clientipaddr": "string",
  "country": "string",
  "language": "string",
  "build": "string",
  "POD_NAMESPACE": "string",
  "POD_NAME": "string",
  "NODE_NAME": "string",
  "POD_IP": "string",
  "KUBERNETES_SERVICE_HOST": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline
500	Internal Server Error	none	InternalError

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» hostname	string	false	none	none
» ipaddr	string	false	none	none
» plateform	string	false	none	none
» arch	string	false	none	none
» release	string	false	none	none
» cpu	string	false	none	none
» clientipaddr	string	false	none	none
» country	string	false	none	none
» language	string	false	none	none
» build	string	false	none	none
» POD_NAMESPACE	string	false	none	none
» POD_NAME	string	false	none	none
» NODE_NAME	string	false	none	none
» POD_IP	string	false	none	none
» KUBERNETES_SERVICE_HOST	string	false	none	none

get__getSettings

GET /getSettings

Get configuration for settings window

Example responses

200 Response

{
  "code": 0,
  "data": [
    {
      "tab": "string",
      "enabled": true
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline
500	Internal Server Error	none	InternalError

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	none
» data	[any]	false	none	none
»» tab	string	false	none	none
»» enabled	boolean	false	none	none

post__setBackgroundColor

POST /setBackgroundColor

Change the background color

Body parameter

{
  "color": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» color	body	string	true	none

Example responses

200 Response

{
  "code": 0,
  "data": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Success
500	Internal Server Error	none	InternalError

post__setBackgroundImage

POST /setBackgroundImage

Set the background image

Body parameter

{
  "imgName": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» imgName	body	string	true	none

Example responses

200 Response

{
  "code": 0,
  "data": {
    "color": "string",
    "subData": {
      "code": 0,
      "data": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline
404	Not Found	none	Inline
500	Internal Server Error	none	InternalError

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	none
» data	object	false	none	none
»» color	string	false	none	none
»» subData	Success	false	none	All operations completed with success
»»» code	integer	false	none	none
»»» data	string	false	none	none

Status Code 404

Name	Type	Required	Restrictions	Description
» code	integer	false	none	none
» data	string	false	none	none

post__setDefaultImage

POST /setDefaultImage

Set the default image as background

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline
404	Not Found	none	Inline
500	Internal Server Error	none	InternalError

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	none
» data	string	false	none	none

Status Code 404

Name	Type	Required	Restrictions	Description
» code	integer	false	none	none
» data	string	false	none	none

get__getwindowslist

GET /getwindowslist

Get window list

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline
500	Internal Server Error	none	InternalError

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» code	integer	false	none	none
» data	[any]	false	none	none
»» id	integer	false	none	none
»» pid	integer	false	none	none
»» wm_class	string	false	none	none
»» title	string	false	none	none
»» machine_name	string	false	none	none

post__activatewindows

POST /activatewindows

Activate windows

Body parameter

{
  "windowsid": [
    0
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» windowsid	body	[integer]	true	none

Example responses

200 Response

{
  "code": 0,
  "data": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Success
500	Internal Server Error	none	InternalError

post__closewindows

POST /closewindows

Close windows

Body parameter

{
  "windowsid": [
    0
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» windowsid	body	[integer]	true	none

Example responses

200 Response

{
  "code": 0,
  "data": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Success
500	Internal Server Error	none	InternalError

post__placeAllWindows

POST /placeAllWindows

Place and resize all windows

Example responses

200 Response

{
  "code": 0,
  "data": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Success
500	Internal Server Error	none	InternalError

Schemas

InternalError

{
  "code": 0,
  "data": "string"
}

Properties

Name	Type	Required	Restrictions	Description
code	integer	false	none	none
data	string	false	none	none

Success

{
  "code": 0,
  "data": "string"
}

All operations completed with success

Properties

Name	Type	Required	Restrictions	Description
code	integer	false	none	none
data	string	false	none	none

processResult

{
  "code": 0,
  "data": {}
}

Properties

Name	Type	Required	Restrictions	Description
code	integer	false	none	none
data	object	false	none	none

launch

{
  "code": 0,
  "data": {}
}

Properties

Name	Type	Required	Restrictions	Description
code	integer	false	none	none
data	object	false	none	none

MIME

{
  "data": {}
}

Properties

Name	Type	Required	Restrictions	Description
data	object	false	none	none

AppForFile

{
  "code": 0,
  "data": [
    {
      "command": "string",
      "args": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
code	integer	false	none	none
data	[object]	false	none	none
» command	string	false	none	none
» args	string	false	none	none