Backblaze · Schema

CreateKeyRequest

CreateKeyRequest schema from Backblaze B2 Native API

Cloud StorageObject StorageStorageBackup

Properties

Name	Type	Description
accountId	string
capabilities	array	List of capabilities for the key
keyName	string	A name for the key (letters, numbers, hyphens)
validDurationInSeconds	integer	Duration before key expires
bucketId	string	Restrict key to this bucket
namePrefix	string	Restrict key to files with this prefix

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/backblaze/refs/heads/main/json-schema/b2-native-api-create-key-request-schema.json",
  "title": "CreateKeyRequest",
  "description": "CreateKeyRequest schema from Backblaze B2 Native API",
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string",
      "example": "abc123def456"
    },
    "capabilities": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of capabilities for the key"
    },
    "keyName": {
      "type": "string",
      "description": "A name for the key (letters, numbers, hyphens)",
      "example": "my-app-key"
    },
    "validDurationInSeconds": {
      "type": "integer",
      "description": "Duration before key expires"
    },
    "bucketId": {
      "type": "string",
      "description": "Restrict key to this bucket"
    },
    "namePrefix": {
      "type": "string",
      "description": "Restrict key to files with this prefix"
    }
  },
  "required": [
    "accountId",
    "capabilities",
    "keyName"
  ]
}