The list-bucket command lists all objects within a bucket.

JSON Input Data Format
{
    id: string,
    name: string,
    path: string,
    cloudid: string,
    showversions: boolean,
    search: string
}
id * Specifies the ID of the bucket.
name * Specifies the name of the bucket.
path * Specifies the path for conducting the list. Specify "/" to list from the root and "/foldername" to list a subfolder.
cloudid * Specifies the {ANYNODE} ID hosting the bucket.
showversions Specifies whether all versions of an object are listed; the default setting is false.
search Filters the list for the provided text.
* Indicates a mandatory field.

Code Snippets
Here are several code snippets provided for your direct use. Simply select your preferred tool/language by clicking on it.


Successful Response
{
    "result": "OK",
    "payload": [
        {
            "key": "contacts.csv",
            "type": "file",
            "size": 17154,
            "versionOrdinal": 1,
            "etag": "",
            "lastModified": "2022-05-15T09:18:49.4412254+02:00"
        },
        {
            "key": "profiles/",
            "type": "folder",
            "size": 22,
            "versionOrdinal": 1,
            "etag": "",
            "lastModified": "2022-05-15T09:28:33.527797694+02:00"
        }
    ]
}

Failed Response
{
    "result": "ERR",
    "message": "Error message ..."
}