Cloud

API for communication with ZBOS by Zora Robotics.

Channels

zbos/cloud/config/get

PUB Get cloud config

see zbos/cloud/config/response/\{key} for response

Channel tags

  • Cloud

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any
Examples of payload
{
  "key": "ABCxyz"
}

zbos/cloud/config/response/\{key}

SUB response: Get cloud config

Channel tags

  • Cloud

Map
Payload

Name

Type

Description

Accepted values

Message Payload

object

Any
Example of payload (generated)
{}

zbos/cloud/config/set

PUB Set cloud config

Channel tags

  • Cloud

Map
Payload

Name

Type

Description

Accepted values

Message Payload

object

Any
Example of payload (generated)
{}

zbos/cloud/config/event

SUB event: Config cloud

Channel tags

  • Cloud

Map
Payload

Name

Type

Description

Accepted values

Message Payload

object

Any
Example of payload (generated)
{}

zbos/media/library/resync

PUB Resync all media libraries

see zbos/media/library/resync/response/\{key} for response

Channel tags

  • Cloud

EmptyMessage

Empty message

zbos/media/library/resync/response/\{key}

SUB response: Resync all media libraries

Channel tags

  • Cloud

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/media/library/file/upload

PUB Upload file in media library

see zbos/media/library/file/upload/response/\{key} for response

Channel tags

  • Cloud

FileUploadRequest
Payload

Name

Type

Description

Accepted values

file

string

Any

storageAccount

string

Any

key

string

Any

metadata

object

Any
Examples of payload
{
  "file": "string",
  "storageAccount": "string",
  "key": "string",
  "metadata": {}
}

zbos/media/library/file/upload/response/\{key}

SUB response: Upload file in media library

Channel tags

  • Cloud

CloudResult
Payload

Name

Type

Description

Accepted values

success

boolean

Any

cloudFileId

string

Any
Examples of payload
{
  "success": false,
  "cloudFileId": "string"
}