Backblaze · JSON Structure

B2 Native Api List File Names Request Structure

ListFileNamesRequest schema from Backblaze B2 Native API

Type: object Properties: 5 Required: 1
Cloud StorageObject StorageStorageBackup

ListFileNamesRequest is a JSON Structure definition published by Backblaze, describing 5 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

bucketId startFileName maxFileCount prefix delimiter

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/backblaze/refs/heads/main/json-structure/b2-native-api-list-file-names-request-structure.json",
  "name": "ListFileNamesRequest",
  "description": "ListFileNamesRequest schema from Backblaze B2 Native API",
  "type": "object",
  "properties": {
    "bucketId": {
      "type": "string",
      "description": "The bucket to list",
      "example": "e73ede9969c64355ef8b"
    },
    "startFileName": {
      "type": "string",
      "description": "Start listing from this file name"
    },
    "maxFileCount": {
      "type": "int32",
      "description": "Maximum number of files to return (1-10000)",
      "example": 100
    },
    "prefix": {
      "type": "string",
      "description": "Prefix to filter file names"
    },
    "delimiter": {
      "type": "string",
      "description": "Delimiter used for virtual folder simulation"
    }
  },
  "required": [
    "bucketId"
  ]
}