Download OpenAPI specification:
XCube Platform API documentation
Creates new admin user
New admin user
| grant_type | string Type of grant. Must be 'password'. |
| key | string XCube Display Manager instance key provided by Optima DTS. |
| password | string Password. |
| username | string Username. |
{- "grant_type": "string",
- "key": "string",
- "password": "string",
- "username": "string"
}{- "access_token": "string",
- "expires_in": 0,
- "token_type": "string",
- "username": "string"
}Creates new user
New user
| admin | boolean User is an administrator. |
string Email. | |
| first_name | string First name. |
| last_modified | string Date and time the user was last modified. |
| last_name | string Last name. |
| organization | string Organization. |
| password | string Password. |
| phone | string Phone number. |
| title | string Title. |
| username | string Username. |
{- "admin": true,
- "email": "string",
- "first_name": "string",
- "last_modified": "string",
- "last_name": "string",
- "organization": "string",
- "password": "string",
- "phone": "string",
- "title": "string",
- "username": "string"
}{- "admin": true,
- "email": "string",
- "first_name": "string",
- "last_modified": "string",
- "last_name": "string",
- "organization": "string",
- "password": "string",
- "phone": "string",
- "title": "string",
- "username": "string"
}[- {
- "admin": true,
- "email": "string",
- "first_name": "string",
- "last_modified": "string",
- "last_name": "string",
- "organization": "string",
- "password": "string",
- "phone": "string",
- "title": "string",
- "username": "string"
}
]Updates user
| username required | string Username |
Updated user
| admin | boolean User is an administrator. |
string Email. | |
| first_name | string First name. |
| last_modified | string Date and time the user was last modified. |
| last_name | string Last name. |
| organization | string Organization. |
| password | string Password. |
| phone | string Phone number. |
| title | string Title. |
| username | string Username. |
{- "admin": true,
- "email": "string",
- "first_name": "string",
- "last_modified": "string",
- "last_name": "string",
- "organization": "string",
- "password": "string",
- "phone": "string",
- "title": "string",
- "username": "string"
}{- "admin": true,
- "email": "string",
- "first_name": "string",
- "last_modified": "string",
- "last_name": "string",
- "organization": "string",
- "password": "string",
- "phone": "string",
- "title": "string",
- "username": "string"
}User login
User login
| grant_type | string Type of grant. Must be 'password'. |
| password | string Password. |
| username | string Username. |
{- "grant_type": "string",
- "password": "string",
- "username": "string"
}{- "access_token": "string",
- "expires_in": 0,
- "token_type": "string",
- "username": "string"
}Adds a new wall configuration
Wall configuration
| description | string Brief description of the wall (e.g., location, purpose, etc.). |
| last_modified | string Date and time the wall configuration was last modified. |
| name | string Unique, alphanumeric wall name or identifier. No spaces or special characters allowed (except for '-' and '_'). |
| wall_cols | integer Number of wall columns. |
| wall_rows | integer Number of wall rows. |
{- "description": "string",
- "last_modified": "string",
- "name": "string",
- "wall_cols": 0,
- "wall_rows": 0
}"string"Updates an existing wall configuration
| name required | string Wall name |
Wall configuration
| description | string Brief description of the wall (e.g., location, purpose, etc.). |
| last_modified | string Date and time the wall configuration was last modified. |
| name | string Unique, alphanumeric wall name or identifier. No spaces or special characters allowed (except for '-' and '_'). |
| wall_cols | integer Number of wall columns. |
| wall_rows | integer Number of wall rows. |
{- "description": "string",
- "last_modified": "string",
- "name": "string",
- "wall_cols": 0,
- "wall_rows": 0
}"string"Adds a new wall display configuration
Wall display configuration
Array of objects (data.CubeDisplayConfig) Cube display configuration(s) for the wall display config. | |
| last_modified | string Date and time the wall display configuration was last modified. |
| name | string Unique, alphanumeric wall display config (wall preset) name or identifier. No spaces or special characters allowed (except for '-' and '_'). |
| wall_name | string The unique, alphanumeric wall name or identifier to which this display config is assigned. |
{- "cube_display_configs": [
- {
- "cube_cols": 0,
- "cube_rows": 0,
- "cube_stream_configs": [
- {
- "cube_col": 0,
- "cube_row": 0,
- "name": "string",
- "tour": true
}
], - "last_modified": "string",
- "name": "string"
}
], - "last_modified": "string",
- "name": "string",
- "wall_name": "string"
}"string"Gets current wall display configurations
[- {
- "cube_display_configs": [
- {
- "cube_cols": 0,
- "cube_rows": 0,
- "cube_stream_configs": [
- {
- "cube_col": 0,
- "cube_row": 0,
- "name": "string",
- "tour": true
}
], - "last_modified": "string",
- "name": "string"
}
], - "last_modified": "string",
- "name": "string",
- "wall_name": "string"
}
]Updates an existing wall display configuration
| name required | string Wall display config name |
Wall display configuration
Array of objects (data.CubeDisplayConfig) Cube display configuration(s) for the wall display config. | |
| last_modified | string Date and time the wall display configuration was last modified. |
| name | string Unique, alphanumeric wall display config (wall preset) name or identifier. No spaces or special characters allowed (except for '-' and '_'). |
| wall_name | string The unique, alphanumeric wall name or identifier to which this display config is assigned. |
{- "cube_display_configs": [
- {
- "cube_cols": 0,
- "cube_rows": 0,
- "cube_stream_configs": [
- {
- "cube_col": 0,
- "cube_row": 0,
- "name": "string",
- "tour": true
}
], - "last_modified": "string",
- "name": "string"
}
], - "last_modified": "string",
- "name": "string",
- "wall_name": "string"
}"string"Adds a new cube configuration
Cube configuration
object Advanced cube unit configuration parameters. | |
| disabled | boolean Cube unit disabled. When true, all cube unit communications are disabled. |
| host | string Host or IP address of the cube unit. |
| last_modified | string Date and time the cube unit configuration was last modified. |
| max_cube_cols | integer Maximum number of display columns for the cube unit. |
| max_cube_rows | integer Maximum number of display rows for the cube unit. |
| name | string Unique, lowercase, alphanumeric cube unit name or identifier. No spaces or special characters allowed (except for '-' and '_'). |
| port | integer HTTP/S port of the cube unit. |
| secret | string Secret key for cube unit authorization. |
| wall_col | string Current one (1) based wall column index. |
| wall_name | string Name of the wall to which this cube unit is assigned. |
| wall_row | string Current one (1) based wall row index. |
{- "advanced_config": {
- "maintain_interval_secs": 0,
- "max_dormant_secs": 0,
- "network_activity_window_secs": 0,
- "stream_retry_delay_secs": 0,
- "stream_shutdown_wait_secs": 0
}, - "disabled": true,
- "host": "string",
- "last_modified": "string",
- "max_cube_cols": 0,
- "max_cube_rows": 0,
- "name": "string",
- "port": 0,
- "secret": "string",
- "wall_col": "string",
- "wall_name": "string",
- "wall_row": "string"
}"string"[- {
- "advanced_config": {
- "maintain_interval_secs": 0,
- "max_dormant_secs": 0,
- "network_activity_window_secs": 0,
- "stream_retry_delay_secs": 0,
- "stream_shutdown_wait_secs": 0
}, - "disabled": true,
- "host": "string",
- "last_modified": "string",
- "max_cube_cols": 0,
- "max_cube_rows": 0,
- "name": "string",
- "port": 0,
- "secret": "string",
- "wall_col": "string",
- "wall_name": "string",
- "wall_row": "string"
}
]Updates an existing cube configuration
| name required | string Cube name |
Cube configuration
object Advanced cube unit configuration parameters. | |
| disabled | boolean Cube unit disabled. When true, all cube unit communications are disabled. |
| host | string Host or IP address of the cube unit. |
| last_modified | string Date and time the cube unit configuration was last modified. |
| max_cube_cols | integer Maximum number of display columns for the cube unit. |
| max_cube_rows | integer Maximum number of display rows for the cube unit. |
| name | string Unique, lowercase, alphanumeric cube unit name or identifier. No spaces or special characters allowed (except for '-' and '_'). |
| port | integer HTTP/S port of the cube unit. |
| secret | string Secret key for cube unit authorization. |
| wall_col | string Current one (1) based wall column index. |
| wall_name | string Name of the wall to which this cube unit is assigned. |
| wall_row | string Current one (1) based wall row index. |
{- "advanced_config": {
- "maintain_interval_secs": 0,
- "max_dormant_secs": 0,
- "network_activity_window_secs": 0,
- "stream_retry_delay_secs": 0,
- "stream_shutdown_wait_secs": 0
}, - "disabled": true,
- "host": "string",
- "last_modified": "string",
- "max_cube_cols": 0,
- "max_cube_rows": 0,
- "name": "string",
- "port": 0,
- "secret": "string",
- "wall_col": "string",
- "wall_name": "string",
- "wall_row": "string"
}"string"Gets current cube display configurations
[- {
- "cube_cols": 0,
- "cube_rows": 0,
- "cube_stream_configs": [
- {
- "cube_col": 0,
- "cube_row": 0,
- "name": "string",
- "tour": true
}
], - "last_modified": "string",
- "name": "string"
}
]Sets cube display configuration
Cube display configuration
| cube_cols | integer Current number of cube display columns for the cube unit. |
| cube_rows | integer Current number of cube display rows for the cube unit. |
Array of objects (data.CubeStreamConfig) Current cube stream configuration(s) for the cube unit. | |
| last_modified | string Date and time the cube display configuration was last modified. |
| name | string Unique, lowercase, alphanumeric cube unit name or identifier. No spaces or special characters allowed (except for '-' and '_'). |
{- "cube_cols": 0,
- "cube_rows": 0,
- "cube_stream_configs": [
- {
- "cube_col": 0,
- "cube_row": 0,
- "name": "string",
- "tour": true
}
], - "last_modified": "string",
- "name": "string"
}"string"[- {
- "cube_cols": 0,
- "cube_rows": 0,
- "cube_stream_states": [
- {
- "cube_col": 0,
- "cube_row": 0,
- "dwell_time_secs": 0,
- "height": 0,
- "is_playing": true,
- "is_playing_index": 0,
- "position_x": 0,
- "position_y": 0,
- "stream_configs": [
- {
- "name": "string",
- "source_url": "string",
- "transport": "default"
}
], - "suspend_consec_failures": 0,
- "suspended_check_interval_secs": 0,
- "width": 0
}
], - "last_updated": "string",
- "name": "string",
- "status": "online",
- "status_message": "string"
}
]Adds a new stream configuration
Stream configuration
| config_source | string Source (identifier) of the stream configuration. |
| description | string Brief description of stream or stream source (camera name, camera location, etc.). |
| disabled | boolean Disable use of stream. |
| last_modified | string Date and time the stream configuration was last modified. |
| name | string Unique, alphanumeric stream name or identifier. No spaces or special characters allowed (except for '-' and '_'). |
| source_url | string Source URL for the stream. Must be a valid URL with a supported protocol ("udp", "rtsp", "rtsps", "rtmp", "rtmps", "http", "https"). |
| transport | string Enum: "default" "tcp" "udp" "udp_multicast" "http" "https" Transport protocol of the source stream. Allowed values are "tcp", "udp", "multicast", "http" and "https". |
{- "config_source": "string",
- "description": "string",
- "disabled": true,
- "last_modified": "string",
- "name": "string",
- "source_url": "string",
- "transport": "default"
}"string"Gets the stream configuration
| name required | string Stream name |
{- "config_source": "string",
- "description": "string",
- "disabled": true,
- "last_modified": "string",
- "name": "string",
- "source_url": "string",
- "transport": "default"
}Gets the list of stream configurations
[- {
- "config_source": "string",
- "description": "string",
- "disabled": true,
- "last_modified": "string",
- "name": "string",
- "source_url": "string",
- "transport": "default"
}
]Updates an existing stream configuration
| name required | string Stream name |
Stream configuration
| config_source | string Source (identifier) of the stream configuration. |
| description | string Brief description of stream or stream source (camera name, camera location, etc.). |
| disabled | boolean Disable use of stream. |
| last_modified | string Date and time the stream configuration was last modified. |
| name | string Unique, alphanumeric stream name or identifier. No spaces or special characters allowed (except for '-' and '_'). |
| source_url | string Source URL for the stream. Must be a valid URL with a supported protocol ("udp", "rtsp", "rtsps", "rtmp", "rtmps", "http", "https"). |
| transport | string Enum: "default" "tcp" "udp" "udp_multicast" "http" "https" Transport protocol of the source stream. Allowed values are "tcp", "udp", "multicast", "http" and "https". |
{- "config_source": "string",
- "description": "string",
- "disabled": true,
- "last_modified": "string",
- "name": "string",
- "source_url": "string",
- "transport": "default"
}"string"Adds a new tour configuration
Tour configuration
| description | string Brief description of the tour (e.g., purpose, content, etc.). |
| dwell_time_secs | integer Playback dwell time in seconds for each stream in the tour. |
| last_modified | string Date and time the tour configuration was last modified. |
| name | string Unique, alphanumeric tour name or identifier. No spaces or special characters allowed (except for '-' and '_'). |
| suspend_consec_failures | integer Number of consecutive failures before a tour stream is temporarily suspended (removed from tour). |
| suspended_check_interval_secs | integer Interval in seconds at which to check if a suspended tour stream is available. |
| tour_streams | Array of strings Ordered list of streams included in tour. |
{- "description": "string",
- "dwell_time_secs": 0,
- "last_modified": "string",
- "name": "string",
- "suspend_consec_failures": 0,
- "suspended_check_interval_secs": 0,
- "tour_streams": [
- "string"
]
}"string"[- {
- "description": "string",
- "dwell_time_secs": 0,
- "last_modified": "string",
- "name": "string",
- "suspend_consec_failures": 0,
- "suspended_check_interval_secs": 0,
- "tour_streams": [
- "string"
]
}
]Updates an existing tour configuration
| name required | string Tour name |
Tour configuration
| description | string Brief description of the tour (e.g., purpose, content, etc.). |
| dwell_time_secs | integer Playback dwell time in seconds for each stream in the tour. |
| last_modified | string Date and time the tour configuration was last modified. |
| name | string Unique, alphanumeric tour name or identifier. No spaces or special characters allowed (except for '-' and '_'). |
| suspend_consec_failures | integer Number of consecutive failures before a tour stream is temporarily suspended (removed from tour). |
| suspended_check_interval_secs | integer Interval in seconds at which to check if a suspended tour stream is available. |
| tour_streams | Array of strings Ordered list of streams included in tour. |
{- "description": "string",
- "dwell_time_secs": 0,
- "last_modified": "string",
- "name": "string",
- "suspend_consec_failures": 0,
- "suspended_check_interval_secs": 0,
- "tour_streams": [
- "string"
]
}"string"