bus

List objects

Changed on

Lists objects with the specified prefix.

get/bus/objects/{prefix}

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

prefixstring required
Example:folder/

The prefix to filter objects by

Query parameters

bucketstring required

The name of the bucket.

Example:default
delimiterstring

Path delimiter ("/" or empty)

limitinteger

Maximum number of objects to return

markerstring

Key to start listing from

sortbystring

Field to sort results by

sortdirstring

Sort direction (asc/desc)

substringstring

Filter objects by substring

slabencryptionkeystring

Encryption key for slabs

Response

Successfully listed objects

hasMoreboolean

Whether there are more objects to fetch

Example response

{
  "objects": [
    {
      "bucket": "default",
      "etag": "W/\"33a64df551425fcc55e4d42a148795d9f25f89d4\""
    }
  ]
}

Changes

  • c38282599c5aRevision changes
    • breaking

      the ////// response's property type changed from integer to no type, and format from uint8 to no format for status

    • info

      added subschema #2 to the ////// response property allOf list for the response status

  • 922f156353c9Revision changes
    • breaking

      removed the media type text/plain for the response with the status

    • info

      api tag bus added