BunnyCDN.Net.Storage

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #claude-code #codex #cli #developer-tools #react #windows

BunnyCDN.Net.Storage

★ 46 Open GitHub ↗

The official .NET library used for interacting with the BunnyCDN Storage API.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# BunnyCDN.Net.Storage
The official .NET library used for interacting with the BunnyCDN Storage API.

### How to use:

The storage library is very simple to use. First, create the basic BunnyCDNStorage object with the authentication details. It's the basic object for interaction with the API.

```c#
var bunnyCDNStorage = new BunnyCDNStorage("storagezonename", "MyAccessKey", "de");
```

The BunnyCDNStorage constructor takes the following parameters:
- **storageZoneName** - The name of your storage zone
- **apiAccessKey** - The API access key (password)
- **storageZoneRegion** - (Optional) The storage zone region code (de, ny, or sg). By default de is selected.
- **handler** - (Optional) The HttpMessageHandler used by the internal HttpClient

### Navigation:
  - [How to use:](#how-to-use)
  - [Uploading objects:](#uploading-objects)
  - [Listing objects:](#listing-objects)
  - [Downloading objects:](#downloading-objects)
  - [Deleting objects:](#deleting-objects)

<br/>

## Uploading objects:
Uploading supports either loading from a stream or reading directly from a local file path. If the path to the object does not exist yet, it will be automatically created.

**Uploading from a stream**
```c#
await bunnyCDNStorage.UploadAsync(stream, "/storagezonename/helloworld.txt");
```

**Uploading a local file**
```c#
await bunnyCDNStorage.UploadAsync("local/file/path/helloworld.txt", "/storagezonename/helloworld.txt");
```
**Uploading with checksum verification**
```c#
# Providing the hash
await bunnyCDNStorage.UploadAsync(stream, "/storagezonename/helloworld.txt", "d04b98f48e8f8bcc15c6ae5ac050801cd6dcfd428fb5f9e65c4e16e7807340fa");
await bunnyCDNStorage.UploadAsync("/local/path/to/file.txt", "/storagezonename/helloworld.txt", "d04b98f48e8f8bcc15c6ae5ac050801cd6dcfd428fb5f9e65c4e16e7807340fa");
# Auto generating the hash
await bunnyCDNStorage.UploadAsync(stream, "/storagezonename/helloworld.txt", true);
await bunnyCDNStorage.UploadAsync("/local/path/to/file.txt", "/storagezonename/helloworld.txt", true);
# Provide hash which will be auto-generated if format is invalid
await bunnyCDNStorage.UploadAsync(stream, "/storagezonename/helloworld.txt", true, "d04b98f48e8f8bcc15c6ae5ac050801cd6dcfd428fb5f9e65c4e16e7807340fa");
await bunnyCDNStorage.UploadAsync("/local/path/to/file.txt", "/storagezonename/helloworld.txt", true, "d04b98f48e8f8bcc15c6ae5ac050801cd6dcfd428fb5f9e65c4e16e7807340fa");
await bunnyCDNStorage.UploadAsync(stream, "/storagezonename/helloworld.txt", true, "invalidtobereplaced");
await bunnyCDNStorage.UploadAsync("/local/path/to/file.txt", "/storagezonename/helloworld.txt", true, "invalidtobereplaced");
```

<br/>

## Listing objects:
Get a list of of all objects on the given path. Returns a List<StorageObject> collection.
```c#
var objects = await bunnyCDNStorage.GetStorageObjectsAsync("/storagezonename/");
```

The StorageObject contains the following properties:
- **Guid** - The unique GUID of the file
- **UserId** - The ID of the BunnyCDN user that holds the file
- **DateCreated** - The date when the file was created
- **LastChanged** - The date when the file was last modified
- **StorageZoneName** - The name of the storage zone to which the file is linked
- **Path** - The path to the object
- **ObjectName** - The name of the object
- **Length** - The total of the object in bytes
- **IsDirectory** - True if the object is a directory, otherwise false.
- **ServerId** - The ID of the storage server that the file resides on
- **StorageZoneId** - The ID of the storage zone that the object is linked to
- **FullPath** - The full path to the file

<br/>

## Downloading objects:
Downloading supports either loading into a stream or saving directly to a local file.

**Download as a stream**
```c#
await bunnyCDNStorage.DownloadObjectAsStreamAsync("/storagezonename/helloworld.txt");
```

**Download as a file**
```c#
await bunnyCDNStorage.DownloadObjectAsync("/storagezonename/helloworld.txt", "local/file/path/helloworld.txt");
```

<br/>

## Deleting objects:
Deleting supports both files and directories. If the target object is a directory, the directory content will also be deleted.
```c#
await bunnyCDNStorage.DeleteObjectAsync("/storagezonename/helloworld.txt");
```

BunnyCDN.Net.Storage

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README