{"openapi":"3.0.3","info":{"title":"Game server","version":"1.0.0"},"components":{"schemas":{}},"paths":{"/api/v1/history/link":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"session":{"type":"string"},"casino_id":{"type":"string"},"sign":{"type":"string"}},"required":["session","casino_id"]}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}}}}}}}}},"/api/v1/machine/list":{"post":{"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"casino_id":{"type":"string","description":"CAS ID from config"},"sign":{"type":"string"}},"required":["casino_id","sign"],"additionalProperties":false},{"type":"object","properties":{"filter":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object","properties":{"eq":{"type":"string"},"neq":{"type":"string"},"regex":{"type":"string"},"gt":{"type":"integer"},"ge":{"type":"integer"},"lt":{"type":"integer"},"le":{"type":"integer"}},"additionalProperties":false,"minProperties":1}}},"sign":{"type":"string"}},"required":["filter","sign"],"additionalProperties":false}]},"examples":{"example1":{"value":{"casino_id":"my_cas"}},"example2":{"value":{"filter":[{"manufacturer":{"eq":"SampleManufacturer"}},{"denomination":{"ge":5,"lt":20},"serial":{"regex":"^.*02$"}}]}}}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"enum":["machine"]},"serial":{"type":"string"},"status":{"type":"string"},"tags":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"}]}}},"required":["type","serial","status","tags"]},{"type":"object","properties":{"type":{"enum":["lobby"]},"id":{"type":"string"}},"required":["type","id"]}]}}},"required":["items"]}}}}}}},"/api/v1/session/init":{"post":{"description":"Create a new session on GameServer","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"casino_id":{"type":"string","description":"CAS ID from config"},"game_id":{"type":"string","description":"Either machine's identifier (serial), or lobby ID from config"},"colorscheme":{"type":"string","description":"Color scheme to be applied to the client appearance"},"session":{"type":"string","description":"Session identifier on CAS side"},"user_id":{"type":"string","description":"CAS user identifier"},"currency":{"type":"string"},"locale":{"type":"string"},"geo":{"type":"string"},"denomination":{"type":"integer","minimum":1},"balance":{"type":"integer","minimum":0,"description":"Initial balance from CAS"},"return_url":{"type":"string","description":"An URL for redirecting a user after exiting. Works only links opened in new tab, ignored for iframes"},"cashier_url":{"type":"string","description":"An URL for redirecting to deposit page"},"sub_id":{"type":"string","description":"IDs of sub-clients, in the form of comma-separated list"},"buffer":{"type":"string","description":"Used for integration with stateless systems"},"sign":{"type":"string"}},"required":["casino_id","game_id","session","currency"]},"example":{"casino_id":"my_cas","game_id":"FFFFFFF1","session":"a177fc5d-f190-41be-8aaf-45a7022de482","user_id":"my_user","currency":"USD","locale":"en","denomination":1000,"balance":17020,"sign":"681a8e00d075397ac666d347490f19b565b639d25ac31775b157d35d8855d854"}}},"required":true},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Generated URL"}},"required":["url"]}}}}}}},"/api/v1/manage/machines/":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"key","required":true,"description":"Management API key of the configured management user"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"machines":{"type":"array","items":{"type":"object","properties":{"serial":{"type":"string"},"is_alive":{"type":"boolean"},"status":{"type":"string"},"session":{"type":"object","properties":{"id":{"type":"string"},"user_id":{"type":"string"},"lobby_id":{"type":"string"},"currency":{"type":"string"},"balance":{"type":"integer"},"denomination":{"type":"integer"},"machine_balance":{"type":"integer"}},"required":["id","lobby_id","currency","balance","denomination","machine_balance"]},"tags":{"type":"object"},"vendor":{"enum":["novomatic","apex","pate","egt"]},"alias":{"type":"string","maxLength":64,"pattern":"^[\\w !\"#$%&'()*+,./:;<=>?@[\\]^`{|}~-]*$"}},"required":["serial","is_alive","status"]}}},"required":["machines"],"additionalProperties":false}}}}}}},"/api/v1/manage/machines/{serial}":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"key","required":true,"description":"Management API key of the configured management user"},{"schema":{"type":"string"},"in":"path","name":"serial","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"machine":{"type":"object","properties":{"serial":{"type":"string"},"is_alive":{"type":"boolean"},"status":{"type":"string"},"session":{"type":"object","properties":{"id":{"type":"string"},"user_id":{"type":"string"},"lobby_id":{"type":"string"},"currency":{"type":"string"},"balance":{"type":"integer"},"denomination":{"type":"integer"},"machine_balance":{"type":"integer"}},"required":["id","lobby_id","currency","balance","denomination","machine_balance"]},"tags":{"type":"object"},"vendor":{"enum":["novomatic","apex","pate","egt"]},"alias":{"type":"string","maxLength":64,"pattern":"^[\\w !\"#$%&'()*+,./:;<=>?@[\\]^`{|}~-]*$"}},"required":["serial","is_alive","status"]}},"required":["machine"],"additionalProperties":false}}}}}}},"/api/v1/manage/machines/{serial}/command":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"command":{"enum":["machine-enable","machine-disable","reboot","payout","calibrate","menu-open","menu-close"],"description":"enable/disable are handled by the server, others are forwarded to machine as a system command"},"ipAddress":{"type":"string","description":"Audit: IP address of the original requester"},"userId":{"type":"string","description":"Audit: id of the original requester"},"userAlias":{"type":"string","description":"Audit: alias of the original requester"},"comment":{"type":"string","description":"Audit: free-text reason for the action"}},"required":["command"]}}},"required":true},"parameters":[{"schema":{"type":"string"},"in":"query","name":"key","required":true,"description":"Management API key of the configured management user"},{"schema":{"type":"string"},"in":"path","name":"serial","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string"}},"required":["result"]}}}}}}},"/api/v1/manage/machines/{serial}/reset":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Optional audit metadata about the original requester, stored in the management audit log","properties":{"ipAddress":{"type":"string","description":"Audit: IP address of the original requester"},"userId":{"type":"string","description":"Audit: id of the original requester"},"userAlias":{"type":"string","description":"Audit: alias of the original requester"},"comment":{"type":"string","description":"Audit: free-text reason for the action"}},"additionalProperties":false,"nullable":true}}},"description":"Optional audit metadata about the original requester, stored in the management audit log"},"parameters":[{"schema":{"type":"string"},"in":"query","name":"key","required":true,"description":"Management API key of the configured management user"},{"schema":{"type":"string"},"in":"path","name":"serial","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"machine":{"type":"object","properties":{"serial":{"type":"string"},"is_alive":{"type":"boolean"},"status":{"type":"string"},"session":{"type":"object","properties":{"id":{"type":"string"},"user_id":{"type":"string"},"lobby_id":{"type":"string"},"currency":{"type":"string"},"balance":{"type":"integer"},"denomination":{"type":"integer"},"machine_balance":{"type":"integer"}},"required":["id","lobby_id","currency","balance","denomination","machine_balance"]},"tags":{"type":"object"},"vendor":{"enum":["novomatic","apex","pate","egt"]},"alias":{"type":"string","maxLength":64,"pattern":"^[\\w !\"#$%&'()*+,./:;<=>?@[\\]^`{|}~-]*$"}},"required":["serial","is_alive","status"]}},"required":["machine"],"additionalProperties":false}}}}}}},"/api/v1/manage/machines/reset":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Optional audit metadata about the original requester, stored in the management audit log","properties":{"ipAddress":{"type":"string","description":"Audit: IP address of the original requester"},"userId":{"type":"string","description":"Audit: id of the original requester"},"userAlias":{"type":"string","description":"Audit: alias of the original requester"},"comment":{"type":"string","description":"Audit: free-text reason for the action"}},"additionalProperties":false,"nullable":true}}},"description":"Optional audit metadata about the original requester, stored in the management audit log"},"parameters":[{"schema":{"type":"string"},"in":"query","name":"key","required":true,"description":"Management API key of the configured management user"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"machines":{"type":"array","items":{"type":"object","properties":{"serial":{"type":"string"},"is_alive":{"type":"boolean"},"status":{"type":"string"},"session":{"type":"object","properties":{"id":{"type":"string"},"user_id":{"type":"string"},"lobby_id":{"type":"string"},"currency":{"type":"string"},"balance":{"type":"integer"},"denomination":{"type":"integer"},"machine_balance":{"type":"integer"}},"required":["id","lobby_id","currency","balance","denomination","machine_balance"]},"tags":{"type":"object"},"vendor":{"enum":["novomatic","apex","pate","egt"]},"alias":{"type":"string","maxLength":64,"pattern":"^[\\w !\"#$%&'()*+,./:;<=>?@[\\]^`{|}~-]*$"}},"required":["serial","is_alive","status"]}}},"required":["machines"],"additionalProperties":false}}}}}}},"/api/v1/manage/machines/{serial}/update":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"serial":{"type":"string"},"status":{"enum":["busy","online","payout","disabled","service","service-payout"]},"game_start":{"type":"boolean"}}}}}},"parameters":[{"schema":{"type":"string"},"in":"query","name":"key","required":true,"description":"Management API key of the configured management user"},{"schema":{"type":"string"},"in":"path","name":"serial","required":true}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"machine":{"type":"object","properties":{"serial":{"type":"string"},"is_alive":{"type":"boolean"},"status":{"type":"string"},"session":{"type":"object","properties":{"id":{"type":"string"},"user_id":{"type":"string"},"lobby_id":{"type":"string"},"currency":{"type":"string"},"balance":{"type":"integer"},"denomination":{"type":"integer"},"machine_balance":{"type":"integer"}},"required":["id","lobby_id","currency","balance","denomination","machine_balance"]},"tags":{"type":"object"},"vendor":{"enum":["novomatic","apex","pate","egt"]},"alias":{"type":"string","maxLength":64,"pattern":"^[\\w !\"#$%&'()*+,./:;<=>?@[\\]^`{|}~-]*$"}},"required":["serial","is_alive","status"]}},"required":["machine"],"additionalProperties":false}}}}}}},"/api/v1/manage/machines/{serial}/service/enter":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Optional audit metadata about the original requester, stored in the management audit log","properties":{"ipAddress":{"type":"string","description":"Audit: IP address of the original requester"},"userId":{"type":"string","description":"Audit: id of the original requester"},"userAlias":{"type":"string","description":"Audit: alias of the original requester"},"comment":{"type":"string","description":"Audit: free-text reason for the action"}},"additionalProperties":false,"nullable":true}}},"description":"Optional audit metadata about the original requester, stored in the management audit log"},"parameters":[{"schema":{"type":"string"},"in":"query","name":"key","required":true,"description":"Management API key of the configured management user"},{"schema":{"type":"string"},"in":"path","name":"serial","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"machine":{"type":"object","properties":{"serial":{"type":"string"},"is_alive":{"type":"boolean"},"status":{"type":"string"},"session":{"type":"object","properties":{"id":{"type":"string"},"user_id":{"type":"string"},"lobby_id":{"type":"string"},"currency":{"type":"string"},"balance":{"type":"integer"},"denomination":{"type":"integer"},"machine_balance":{"type":"integer"}},"required":["id","lobby_id","currency","balance","denomination","machine_balance"]},"tags":{"type":"object"},"vendor":{"enum":["novomatic","apex","pate","egt"]},"alias":{"type":"string","maxLength":64,"pattern":"^[\\w !\"#$%&'()*+,./:;<=>?@[\\]^`{|}~-]*$"}},"required":["serial","is_alive","status"]}},"required":["machine"],"additionalProperties":false}}}}}}},"/api/v1/manage/machines/{serial}/service/exit":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Optional audit metadata about the original requester, stored in the management audit log","properties":{"ipAddress":{"type":"string","description":"Audit: IP address of the original requester"},"userId":{"type":"string","description":"Audit: id of the original requester"},"userAlias":{"type":"string","description":"Audit: alias of the original requester"},"comment":{"type":"string","description":"Audit: free-text reason for the action"}},"additionalProperties":false,"nullable":true}}},"description":"Optional audit metadata about the original requester, stored in the management audit log"},"parameters":[{"schema":{"type":"string"},"in":"query","name":"key","required":true,"description":"Management API key of the configured management user"},{"schema":{"type":"string"},"in":"path","name":"serial","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"machine":{"type":"object","properties":{"serial":{"type":"string"},"is_alive":{"type":"boolean"},"status":{"type":"string"},"session":{"type":"object","properties":{"id":{"type":"string"},"user_id":{"type":"string"},"lobby_id":{"type":"string"},"currency":{"type":"string"},"balance":{"type":"integer"},"denomination":{"type":"integer"},"machine_balance":{"type":"integer"}},"required":["id","lobby_id","currency","balance","denomination","machine_balance"]},"tags":{"type":"object"},"vendor":{"enum":["novomatic","apex","pate","egt"]},"alias":{"type":"string","maxLength":64,"pattern":"^[\\w !\"#$%&'()*+,./:;<=>?@[\\]^`{|}~-]*$"}},"required":["serial","is_alive","status"]}},"required":["machine"],"additionalProperties":false}}}}}}},"/api/v1/manage/machines/{serial}/service/session/init":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Optional audit metadata about the original requester, stored in the management audit log","properties":{"ipAddress":{"type":"string","description":"Audit: IP address of the original requester"},"userId":{"type":"string","description":"Audit: id of the original requester"},"userAlias":{"type":"string","description":"Audit: alias of the original requester"},"comment":{"type":"string","description":"Audit: free-text reason for the action"}},"additionalProperties":false,"nullable":true}}},"description":"Optional audit metadata about the original requester, stored in the management audit log"},"parameters":[{"schema":{"type":"string"},"in":"query","name":"key","required":true,"description":"Management API key of the configured management user"},{"schema":{"type":"string"},"in":"path","name":"serial","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"]}}}}}}},"/api/v1/manage/machines/service/session":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"key","required":true,"description":"Management API key of the configured management user"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"sessions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"serial":{"type":"string"}},"required":["id","serial"],"additionalProperties":false}}},"required":["sessions"],"additionalProperties":false}}}}}}},"/api/v1/manage/machines/{serial}/settings":{"get":{"parameters":[{"schema":{"type":"string"},"in":"query","name":"key","required":true,"description":"Management API key of the configured management user"},{"schema":{"type":"string"},"in":"path","name":"serial","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"type":"object","description":"Machine settings and identification. `info` and `tags` are read-only (reported by the machine itself); the rest is stored as retained MQTT messages on the central broker and can be changed with PATCH. Unset or unreported values are omitted.","properties":{"serial":{"type":"string","description":"Machine serial number","example":"0200000000000016"},"info":{"type":"object","properties":{"Name":{"type":"string"},"AdditionalID":{"type":"string"},"Denomination":{"type":"integer"},"Max_Bet":{"type":"integer"},"Last_AFT_State":{"type":"integer"},"AFT_State":{"type":"integer"},"Progressive_Group":{"type":"integer"},"Game_Options":{"type":"string"},"PayTable_ID":{"type":"string"},"Base_Percentage":{"type":"number"},"Sas_Version":{"type":"string"},"Serial_Number":{"type":"string"},"sas_n":{"type":"integer"},"gm_date":{"type":"string"},"gmc_sn":{"type":"string"}},"required":["Denomination"]},"tags":{"type":"object","description":"Read-only machine tags (`manufacturer`, `game_collection`, `denomination`, ...)","additionalProperties":true},"screen":{"type":"object","description":"Screen configuration of the streamed machine video","properties":{"orientation":{"type":"integer","minimum":0,"maximum":3,"description":"Rotation of the source video stream in 90° steps (0-3). 0 - horizontal (landscape) cabinet, stream is used as-is; vertical (portrait) cabinets stream rotated and typically use 3 (the client rotates the video back by 270°)","example":0},"stretch":{"type":"boolean","description":"true - vertical (portrait) cabinet: the client uses vertical layouts and scaling"},"vdisplay_count":{"type":"integer","minimum":0,"maximum":10,"description":"Number of stacked virtual displays in the video stream. Vertical cabinets with 3 physical screens use 3 (enables per-screen scrolling on the client); 0 - splitting disabled (single-screen horizontal cabinet)","example":0}},"additionalProperties":false},"devices":{"type":"object","description":"Capture device selection: browser mediaDevices ids (hex) of the cameras/capture cards","properties":{"pip":{"type":"string","pattern":"^[0-9a-f]{8,64}$","description":"Main machine screen capture device id"},"ext":{"type":"string","pattern":"^[0-9a-f]{8,64}$","description":"External (room) camera device id"},"kbd":{"type":"string","pattern":"^[0-9a-f]{8,64}$","description":"Keyboard/button panel camera device id"}},"additionalProperties":false},"crop":{"type":"object","description":"Crop applied to the external camera stream. `x`/`y`/`w`/`h` are fractions of the source frame (0..1, slight out-of-range values occur after manual calibration), `r` is the rotation in radians","properties":{"x":{"type":"number","description":"Left offset as a fraction of the frame width"},"y":{"type":"number","description":"Top offset as a fraction of the frame height"},"w":{"type":"number","description":"Width as a fraction of the frame width"},"h":{"type":"number","description":"Height as a fraction of the frame height"},"r":{"type":"number","description":"Rotation in radians"}},"required":["x","y","w","h","r"],"additionalProperties":false},"image":{"type":"string","pattern":"^[A-Za-z0-9._-]+(/[A-Za-z0-9._-]+)*$","maxLength":128,"description":"Lobby image file name with extension, relative to the devices/ prefix of the assets host (may contain path segments, e.g. viva/APEX/clover_link.png)","example":"viva/APEX/clover_link.png"},"comment":{"type":"string","maxLength":1024,"description":"Free-text operator note about the machine; an empty string clears the note"},"vendor":{"enum":["novomatic","apex","pate","egt"]},"alias":{"type":"string","maxLength":64,"pattern":"^[\\w !\"#$%&'()*+,./:;<=>?@[\\]^`{|}~-]*$"}},"required":["serial","tags","screen","devices"],"additionalProperties":false}},"required":["settings"],"additionalProperties":false}}}}}},"patch":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ipAddress":{"type":"string","description":"Audit: IP address of the original requester"},"userId":{"type":"string","description":"Audit: id of the original requester"},"userAlias":{"type":"string","description":"Audit: alias of the original requester"},"comment":{"type":"string","description":"Audit: free-text reason for the action"},"settings":{"type":"object","properties":{"screen":{"type":"object","description":"Screen configuration of the streamed machine video","properties":{"orientation":{"type":"integer","minimum":0,"maximum":3,"description":"Rotation of the source video stream in 90° steps (0-3). 0 - horizontal (landscape) cabinet, stream is used as-is; vertical (portrait) cabinets stream rotated and typically use 3 (the client rotates the video back by 270°)","example":0},"stretch":{"type":"boolean","description":"true - vertical (portrait) cabinet: the client uses vertical layouts and scaling"},"vdisplay_count":{"type":"integer","minimum":0,"maximum":10,"description":"Number of stacked virtual displays in the video stream. Vertical cabinets with 3 physical screens use 3 (enables per-screen scrolling on the client); 0 - splitting disabled (single-screen horizontal cabinet)","example":0}},"additionalProperties":false},"devices":{"type":"object","description":"Capture device selections; null clears a selection and stops the corresponding stream","properties":{"pip":{"type":["string","null"],"pattern":"^[0-9a-f]{8,64}$","description":"Main machine screen capture device id"},"ext":{"type":["string","null"],"pattern":"^[0-9a-f]{8,64}$","description":"External (room) camera device id"},"kbd":{"type":["string","null"],"pattern":"^[0-9a-f]{8,64}$","description":"Keyboard/button panel camera device id"}},"additionalProperties":false},"crop":{"type":["object","null"],"description":"Crop applied to the external camera stream. `x`/`y`/`w`/`h` are fractions of the source frame (0..1, slight out-of-range values occur after manual calibration), `r` is the rotation in radians; null resets to full frame (x: 0, y: 0, w: 1, h: 1, r: 0)","properties":{"x":{"type":"number","description":"Left offset as a fraction of the frame width"},"y":{"type":"number","description":"Top offset as a fraction of the frame height"},"w":{"type":"number","description":"Width as a fraction of the frame width"},"h":{"type":"number","description":"Height as a fraction of the frame height"},"r":{"type":"number","description":"Rotation in radians"}},"required":["x","y","w","h","r"],"additionalProperties":false},"image":{"type":["string","null"],"pattern":"^[A-Za-z0-9._-]+(/[A-Za-z0-9._-]+)*$","maxLength":128,"description":"Lobby image file name with extension, relative to the devices/ prefix of the assets host (may contain path segments, e.g. viva/APEX/clover_link.png)","not":{"enum":["noimage"]},"example":"viva/APEX/clover_link.png"},"comment":{"type":"string","maxLength":1024,"description":"Free-text operator note about the machine; an empty string clears the note"},"vendor":{"enum":["novomatic","apex","pate","egt",null]},"alias":{"type":["string","null"],"maxLength":64,"pattern":"^[\\w !\"#$%&'()*+,./:;<=>?@[\\]^`{|}~-]*$"}},"additionalProperties":false}},"required":["settings"],"additionalProperties":false}}},"required":true},"parameters":[{"schema":{"type":"string"},"in":"query","name":"key","required":true,"description":"Management API key of the configured management user"},{"schema":{"type":"string"},"in":"path","name":"serial","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"type":"object","description":"Machine settings and identification. `info` and `tags` are read-only (reported by the machine itself); the rest is stored as retained MQTT messages on the central broker and can be changed with PATCH. Unset or unreported values are omitted.","properties":{"serial":{"type":"string","description":"Machine serial number","example":"0200000000000016"},"info":{"type":"object","properties":{"Name":{"type":"string"},"AdditionalID":{"type":"string"},"Denomination":{"type":"integer"},"Max_Bet":{"type":"integer"},"Last_AFT_State":{"type":"integer"},"AFT_State":{"type":"integer"},"Progressive_Group":{"type":"integer"},"Game_Options":{"type":"string"},"PayTable_ID":{"type":"string"},"Base_Percentage":{"type":"number"},"Sas_Version":{"type":"string"},"Serial_Number":{"type":"string"},"sas_n":{"type":"integer"},"gm_date":{"type":"string"},"gmc_sn":{"type":"string"}},"required":["Denomination"]},"tags":{"type":"object","description":"Read-only machine tags (`manufacturer`, `game_collection`, `denomination`, ...)","additionalProperties":true},"screen":{"type":"object","description":"Screen configuration of the streamed machine video","properties":{"orientation":{"type":"integer","minimum":0,"maximum":3,"description":"Rotation of the source video stream in 90° steps (0-3). 0 - horizontal (landscape) cabinet, stream is used as-is; vertical (portrait) cabinets stream rotated and typically use 3 (the client rotates the video back by 270°)","example":0},"stretch":{"type":"boolean","description":"true - vertical (portrait) cabinet: the client uses vertical layouts and scaling"},"vdisplay_count":{"type":"integer","minimum":0,"maximum":10,"description":"Number of stacked virtual displays in the video stream. Vertical cabinets with 3 physical screens use 3 (enables per-screen scrolling on the client); 0 - splitting disabled (single-screen horizontal cabinet)","example":0}},"additionalProperties":false},"devices":{"type":"object","description":"Capture device selection: browser mediaDevices ids (hex) of the cameras/capture cards","properties":{"pip":{"type":"string","pattern":"^[0-9a-f]{8,64}$","description":"Main machine screen capture device id"},"ext":{"type":"string","pattern":"^[0-9a-f]{8,64}$","description":"External (room) camera device id"},"kbd":{"type":"string","pattern":"^[0-9a-f]{8,64}$","description":"Keyboard/button panel camera device id"}},"additionalProperties":false},"crop":{"type":"object","description":"Crop applied to the external camera stream. `x`/`y`/`w`/`h` are fractions of the source frame (0..1, slight out-of-range values occur after manual calibration), `r` is the rotation in radians","properties":{"x":{"type":"number","description":"Left offset as a fraction of the frame width"},"y":{"type":"number","description":"Top offset as a fraction of the frame height"},"w":{"type":"number","description":"Width as a fraction of the frame width"},"h":{"type":"number","description":"Height as a fraction of the frame height"},"r":{"type":"number","description":"Rotation in radians"}},"required":["x","y","w","h","r"],"additionalProperties":false},"image":{"type":"string","pattern":"^[A-Za-z0-9._-]+(/[A-Za-z0-9._-]+)*$","maxLength":128,"description":"Lobby image file name with extension, relative to the devices/ prefix of the assets host (may contain path segments, e.g. viva/APEX/clover_link.png)","example":"viva/APEX/clover_link.png"},"comment":{"type":"string","maxLength":1024,"description":"Free-text operator note about the machine; an empty string clears the note"},"vendor":{"enum":["novomatic","apex","pate","egt"]},"alias":{"type":"string","maxLength":64,"pattern":"^[\\w !\"#$%&'()*+,./:;<=>?@[\\]^`{|}~-]*$"}},"required":["serial","tags","screen","devices"],"additionalProperties":false}},"required":["settings"],"additionalProperties":false}}}}}}},"/api/v1/manage/machines/{serial}/video-link":{"post":{"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Optional audit metadata about the original requester, stored in the management audit log","properties":{"ipAddress":{"type":"string","description":"Audit: IP address of the original requester"},"userId":{"type":"string","description":"Audit: id of the original requester"},"userAlias":{"type":"string","description":"Audit: alias of the original requester"},"comment":{"type":"string","description":"Audit: free-text reason for the action"}},"additionalProperties":false,"nullable":true}}},"description":"Optional audit metadata about the original requester, stored in the management audit log"},"parameters":[{"schema":{"type":"string"},"in":"query","name":"key","required":true,"description":"Management API key of the configured management user"},{"schema":{"type":"string"},"in":"path","name":"serial","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"]}}}}}}}},"externalDocs":{"url":"/cas/documentation","description":"CAS API"}}