List Objects¶

List objects

URI Template

GET /api/storage/buckets/{bucketName}/objects

{bucketName}

Bucket name

Query Parameters

instance

Yamcs instance name. Or _global.

delimiter

Return only objects whose name do not contain the delimiter after the prefix. For the other objects, the response contains (in the prefix response parameter) the name truncated after the delimiter. Duplicates are omitted.

Together with prefix this parameter provides filtering capabilities. These work similar to Google Cloud Storage and Amazon S3.

The delimiter allows the list to work in a directory mode despite the object namespace being flat. For example if the delimiter is set to "/", then listing the bucket containing objects "a/b", "a/c", "d", "e" and "e/f" returns objects "d" and "e" and prefixes "a/" and "e/".

prefix

List only objects whose name start with prefix

Response Type

interface ListObjectsResponse {

  // Object name prefixes for objects that matched the request but were
  // excluded from ``objects`` because of a delimiter.
  prefixes: string[];

  // The list of objects
  objects: ObjectInfo[];
}

Related Types

interface ObjectInfo {

  // Object name
  name: string;

  // Creation time
  created: string;  // RFC 3339 timestamp

  // Size in bytes
  size: string;  // String decimal
  metadata: {[key: string]: string};
}