Filebase

https://docs.filebase.com
Admin
Filebase is the leading InterPlanetary development platform providing IPFS storage, dedicated...
Tokens:87,723
Snippets:722
Trust Score:9.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Setup Python Environment

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/code-examples

Commands to clone the example repository, install required dependencies, and run the Python application with environment variables.

```bash
git clone https://github.com/filebase/python-example && cd python-example
pip3 install -r requirements.txt
AWS_ACCESS_KEY_ID=key AWS_SECRET_ACCESS_KEY=secret python3 app.py
```

--------------------------------

### Vue Frontend Setup

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/vue

This section details the steps to set up the Vue.js frontend. It includes installing the Vue CLI globally, creating a new Vue application, adding the Vuetify UI framework, and starting the development server.

```bash
npm install -g @vue/cli
vue create filebase-vue-app
cd vue-multers3-frontend
vue add vuetify
npm run serve
```

--------------------------------

### NodeJS Quick Start with Filebase

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/code-examples

This snippet demonstrates how to quickly set up and run a NodeJS application using Filebase. It includes cloning the repository, installing dependencies, and executing the main application file with necessary AWS credentials.

```bash
git clone https://github.com/filebase/nodejs-example && cd nodejs-example
npm ci
AWS_ACCESS_KEY_ID=key AWS_SECRET_ACCESS_KEY=secret node app.js
```

--------------------------------

### Initialize and Run Nuxt Application

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/nuxt

Installs the necessary Vue CLI tools, initializes a new Nuxt project, and starts the development server.

```bash
npm install -g @vue/cli
npm install -g @vue/cli-init
vue init nuxt-community/starter-template filebase-sample
cd filebase-sample
npm install
npm run dev
```

--------------------------------

### Install Filebase Client

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/filebase-npm-package

Commands to install the Filebase client library using popular package managers.

```bash
npm i @filebase/client
```

```bash
yarn add @filebase/client
```

--------------------------------

### Apostrophe CMS Project Setup and Filebase Configuration

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/apostrophe-cms

This snippet demonstrates the necessary commands to set up a new Apostrophe CMS project and the configuration required in the `app.js` file to enable Filebase as the S3-compatible storage backend. It includes project initialization, dependency installation, user creation, project startup, and the specific module configuration for attachments.

```bash
apos create test-project
cd test-project
npm install
node app.js apostrophe-users:add admin admin
node app.js
```

```javascript
modules: {
  'apostrophe-attachments': {
    uploadfs: {
      backend: 's3',
      secret: 'FILEBASE_ACCESS_KEY',
      key: 'FILEBASE_SECRET_KEY',
      endpoint: ‘s3.filebase.com’,
      bucket: 'FILEBASE_BUCKET_NAME',
      region: 'us-east-1'
    }
  }
}
```

--------------------------------

### Create Laravel Project and Install Dependencies

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/laravel

Commands to initialize a new Laravel project and install the necessary Flysystem S3 driver for Filebase integration.

```bash
composer create-project laravel/laravel PROJECT-NAME
php artisan make:auth
composer require league/flysystem-aws-s3-v3 "^1.0"
php artisan serve
```

--------------------------------

### Initialize Vue Project and Install Dependencies

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/vue

This snippet covers the initial steps to set up a Vue project. It includes creating a new directory, initializing the project with npm, and installing necessary backend packages like express, multer, dotenv, cors, body-parser, and mongodb.

```bash
mkdir filebase-vue-app
cd filebase-vue-app
npm init
npm install --save express multer dotenv cors body-parser mongodb multer-s3 aws-sdk
```

--------------------------------

### Create Bucket using AWS SDK - .NET

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/aws-sdk-.net

This code example demonstrates how to create a new Filebase bucket using the AWS SDK for .NET. Ensure you have your Filebase Access and Secret Keys, and have installed the .NET SDK and AWS SDK for .NET.

```APIDOC
## POST /buckets

### Description
Creates a new bucket in Filebase using the AWS SDK for .NET.

### Method
POST

### Endpoint
Not applicable (This is a code example using an SDK, not a direct API endpoint).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
This operation is configured via code parameters, not a request body.

### Request Example
```csharp
namespace CreateBucket
{
    using System;
    using System.Threading.Tasks;
    using Amazon.S3;
    using Amazon.S3.Model;

    public class CreateBucket
    {
        public static async Task Main()
        {

            // Specify a name for the new bucket.
            const string newBucketName = "new-filebase-bucket";

             {
                string accessKey = "filebase-access-key";
                string secretKey = "filebase-secret-key";
                var config = new AmazonS3Config()
            {
                ServiceURL = string.Format("https://s3.filebase.com"),
                ForcePathStyle = true,
            };
            var client = new AmazonS3Client(accessKey, secretKey, config);
            Console.WriteLine($"\nCreating a new bucket, named: {newBucketName}.");

            await CreatingBucketAsync(client, newBucketName);

        }

        static async Task CreatingBucketAsync(IAmazonS3 client, string bucketName)
        {
            try
            {
                var putBucketRequest = new PutBucketRequest
                {
                    BucketName = bucketName,
                    UseClientRegion = true,
                };

                var putBucketResponse = await client.PutBucketAsync(putBucketRequest);

            }
            catch (AmazonS3Exception ex)
            {
                Console.WriteLine($"Error creating bucket: '{ex.Message}'");
            }
        }
    }

}
```

### Response
#### Success Response (200)
- **Bucket Name** (string) - The name of the newly created bucket.

#### Response Example
(Output is typically console logging indicating success or failure)
```
Creating a new bucket, named: new-filebase-bucket.
```
```

--------------------------------

### Install Django

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/django

Installs the Django web framework using pip. This is a prerequisite for creating Django applications.

```bash
pip install django
```

--------------------------------

### Start Django Development Server

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/django

Starts the Django development server to test the application locally. Access the running application via a web browser.

```bash
python3 manage.py runserver
```

--------------------------------

### Clone and Run PHP Application via Docker

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/code-examples

Clones the PHP example repository, installs dependencies using Composer within a Docker container, and executes the application using a PHP CLI container with injected credentials.

```bash
git clone git@github.com:filebase/php-example.git && cd php-example
docker run --rm -i -v $PWD:/app composer install
docker run --rm -i -v $PWD:/app -e AWS_ACCESS_KEY_ID=your_key -e AWS_SECRET_ACCESS_KEY=your_secret -w /app php:7.4-cli php index.php
```

--------------------------------

### Install Filebase JavaScript SDK

Source: https://docs.filebase.com/ipfs-pinning/deleting-files

Installs the Filebase SDK using npm, which is required for using the JavaScript methods to manage files on Filebase.

```bash
npm install @filebase/sdk
```

--------------------------------

### Start Phoenix Server

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/elixir-phoenix

Command to initialize the Phoenix development server to test the file upload functionality.

```bash
mix phoenix.server
```

--------------------------------

### Install Node.js Packages for File Watching

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/watcher-for-nodejs

Installs the 'chokidar' and 'fs-extra' npm packages, which are necessary for the file watcher functionality.

```bash
npm install chokidar fs-extra
```

--------------------------------

### Initialize and Run Node.js Application

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/code-examples

Installs project dependencies using npm and executes the application with required AWS credentials provided as environment variables.

```bash
npm ci
AWS_ACCESS_KEY_ID=key AWS_SECRET_ACCESS_KEY=secret node app.js
```

--------------------------------

### Install Uppy AWS S3 and Companion Plugins

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/uppy-aws-s3-plugin

Installs the necessary Uppy plugins for AWS S3 integration and the Companion service. Requires Node.js and npm.

```bash
npm install @uppy/aws-s3
npm install @uppy/companion
```

--------------------------------

### Install django-storages and boto3

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/django

Installs the django-storages library for integrating with cloud storage services and boto3, the AWS SDK for Python, which is used by django-storages to interact with Filebase.

```bash
pip install django-storages
```

```bash
pip install boto3
```

--------------------------------

### Deploy Google Apps Script with Clasp

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/google-app-scripts

Commands to install the Google Clasp CLI, authenticate the workspace, create a standalone project, and push the local code to the Google Apps Script environment.

```bash
npm install -g @google/clasp
clasp login
clasp create --type standalone --title "S3 http post"
clasp push
clasp open
```

--------------------------------

### Node.js Server to Run File Watcher

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/watcher-for-nodejs

This script initializes the Observer class and sets up an event listener for the 'file-added' event. It then starts watching a specified folder for changes.

```javascript
const Obserser = require('./services/observer');

var obserser = new Obserser();

const folder = '/path/to/watch';

obserser.on('file-added', log => {
  // print error message to console
  console.log(log.message);
});

obserser.watchFolder(folder);
```

--------------------------------

### Upload Object

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/aws-sdk-.net

This example demonstrates how to upload a file to a specified Filebase bucket. It requires your bucket name, access key, secret key, the local path to the file, and the desired object name.

```APIDOC
## POST /websites/filebase/upload

### Description
Upload an object to the specified Filebase bucket.

### Method
POST

### Endpoint
/websites/filebase/upload

### Parameters
#### Path Parameters
- **filebase-bucket-name** (string) - Required - The name of your Filebase bucket.
- **filebase-access-key** (string) - Required - Your Filebase Access Key.
- **filebase-secret-key** (string) - Required - Your Filebase Secret Key.
- **/path/to/object** (string) - Required - The local path to the file you want to upload.
- **object-name** (string) - Required - The desired name for the object once it is uploaded to the bucket.

### Request Body
This endpoint does not explicitly define a request body in the provided example, but the upload process is initiated via the code.

### Request Example
```csharp
namespace UploadObjectExample
{
    using System;
    using System.Threading.Tasks;
    using Amazon.S3;
    using Amazon.S3.Model;

    public class UploadObject
    {
        private static IAmazonS3 _s3Client;

        private const string BUCKET_NAME = "filebase-bucket-name";
        private const string OBJECT_NAME1 = "object-name";

        private static string LOCAL_PATH = "/path/to/object";

        public static async Task Main()
        {
             {
                string accessKey = "filebase-access-key";
                string secretKey = "filebase-secret-key";
                var config = new AmazonS3Config()
            {
                ServiceURL = string.Format("https://s3.filebase.com"),
                ForcePathStyle = true,
            };
            _s3Client = new AmazonS3Client(accessKey, secretKey, config);

            // The method expects the full path, including the file name.
            var path = $"{LOCAL_PATH}/{OBJECT_NAME1}";

            await UploadObjectFromFileAsync(_s3Client, BUCKET_NAME, OBJECT_NAME1, path);
        }
        static async Task UploadObjectFromFileAsync(
            IAmazonS3 client,
            string bucketName,
            string objectName,
            string filePath)
        {
            try
            {
                var putRequest = new PutObjectRequest
                {
                    BucketName = bucketName,
                    Key = objectName,
                    FilePath = filePath,
                    ContentType = "text/plain",
                };

                putRequest.Metadata.Add("x-amz-meta-title", "FileName");

                PutObjectResponse response = await client.PutObjectAsync(putRequest);
            }
            catch (AmazonS3Exception e)
            {
                Console.WriteLine($"Error: {e.Message}");
            }
        }

    }
}
```

### Response
#### Success Response (200)
- **response** (object) - Confirmation of successful upload.

#### Response Example
```json
{
  "message": "Object uploaded successfully"
}
```
```

--------------------------------

### XML CORS Rule for Filebase Bucket (GET Requests)

Source: https://docs.filebase.com/api-documentation/s3-compatible-api/cross-origin-resource-sharing-cors/create-and-apply-a-cors-rule-to-a-filebase-bucket

This XML configuration achieves the same as the JSON example above, allowing GET requests from any origin. It's an alternative format for defining CORS rules, particularly useful if not using AWS CLI.

```xml
<CORSConfiguration>
<CORSRule>
<AllowedOrigin>*</AllowedOrigin>
<AllowedMethod>GET</AllowedMethod>
</CORSRule>
</CORSConfiguration>
```

--------------------------------

### List Pinned IPFS Objects

Source: https://docs.filebase.com/api-documentation/ipfs-pinning-service-api

This example shows how to retrieve a list of all IPFS objects that are currently pinned. This operation can be filtered to return specific pins. The request is made using the GET method to the API endpoint.

```http
GET https://api.filebase.io/v1/ipfs/pins
```

--------------------------------

### Manage Filebase Sites with SDK

Source: https://docs.filebase.com/sites/managing-sites

Demonstrates how to initialize the Filebase Sites client, create a new site, associate a CID with that site, and retrieve site details programmatically. This requires valid access and secret keys for authentication.

```javascript
import { SitesClient } from '@filebase/sdk';

// Initialize the client
const sitesClient = new SitesClient({
  credentials: {
    accessKeyId: 'YOUR_ACCESS_KEY',
    secretAccessKey: 'YOUR_SECRET_KEY'
  }
});

// Create a new site
const site = await sitesClient.create('my-website');
console.log('Site created:', site.name);
console.log('IPNS Name:', site.ipnsName);

// Associate a CID with the site
await sitesClient.publish('my-website', 'QmYourContentCID...');
console.log('Site published!');

// Get site details
const siteDetails = await sitesClient.get('my-website');
console.log('Current CID:', siteDetails.cid);
```

--------------------------------

### Get Object using Dart/Flutter

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/dart-flutter

Downloads an object from a Filebase bucket using the minio-dart package. This example shows how to retrieve the object's stream and pipe it to a local file. Requires Filebase credentials, bucket name, and object name.

```dart
import 'dart:io';
import 'package:minio/minio.dart';
void main() async {
	final minio = Minio(
		endPoint: 's3.filebase.com',
		accessKey: 'YOUR-ACCESSKEYID',
		secretKey: 'YOUR-SECRETACCESSKEY',
);

	final stream = await minio.getObject('filebase-sample-bucket', 'myobject');

	// Get object length
	print(stream.contentLength);

	// Write object data stream to file
	await stream.pipe(File('output.txt').openWrite());

}
```

--------------------------------

### Initialize S3 Client in Python

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/code-examples

Demonstrates how to configure the Boto3 client to connect to the Filebase S3 endpoint and list available buckets.

```python
import os
import boto3
from botocore.config import Config

boto_config = Config(region_name = 'us-east-1', signature_version = 's3v4')
s3 = boto3.client('s3', endpoint_url='https://s3.filebase.com', aws_access_key_id=os.getenv('AWS_ACCESS_KEY_ID'), aws_secret_access_key=os.getenv('AWS_SECRET_ACCESS_KEY'), config=boto_config)
response = s3.list_buckets()
print(response)
```

--------------------------------

### Install Webpack S3 Plugin

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/webpack-s3-plugin

Command to install the webpack-s3-plugin package via npm.

```bash
npm i webpack-s3-plugin
```

--------------------------------

### Python: Create a Filebase Bucket with Boto3

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/datacamp

This Python script demonstrates how to create a new bucket in Filebase using the boto3 library. It requires Filebase credentials to be set as environment variables and specifies the desired bucket name.

```python
import os
import boto3

filebase_access_key = os.environ["FILEBASE_ACCESS_KEY"]
filebase_secret_key = os.environ["FILEBASE_SECRET_KEY"]

s3 = boto3.client('s3',
	endpoint_url='https://s3.filebase.com',
	aws_access_key_id=filebase_access_key,
	aws_secret_access_key=filebase_secret_key)

bucket_name = "new-filebase-bucket-name"

s3.create_bucket(Bucket=bucket_name)
```

--------------------------------

### Initialize S3 Client and Upload Object in NodeJS

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/code-examples

Demonstrates how to configure the AWS SDK to point to the Filebase S3 endpoint, list available buckets, and upload a text object with custom metadata.

```javascript
var AWS = require('aws-sdk');
var s3 = new AWS.S3({endpoint: 'https://s3.filebase.com', signatureVersion: 'v4'});

s3.listBuckets(function(err, data) {
  if (err) {
    console.log(err, err.stack);
  } else {
    var params = {
      Body: 'Hello, world!',
      Bucket: data['Buckets'][0]['Name'],
      Key: 'exampleobject',
      ContentType: 'text/plain',
      Metadata: {
       'metadata1': 'value1',
       'metadata2': 'value2'
      }
    };
    s3.putObject(params, function(err, data) {
      if (err) {
        console.log(err, err.stack);
      } else {
        console.log(data);
      }
    });
  }
});
```

--------------------------------

### Create a Filebase Bucket using AWS SDK for Java

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/aws-sdk-java

This code example demonstrates how to create a new bucket in Filebase using the AWS SDK for Java. Ensure you have Java, the AWS SDK for Java, and a Filebase account set up. Replace placeholder values with your specific configuration.

```APIDOC
## Create a Bucket

The following code example creates a new Filebase bucket. Replace the following values in the code to match your configuration:
  * **new-filebase-bucket:** The Intended New Bucket Name

Bucket names must be unique across all Filebase users, be between 3 and 63 characters long, and can contain only lowercase characters, numbers, and dashes. 
Buckets created through this method will be automatically created on the IPFS network.

```java
import com.amazonaws.AmazonServiceException;
import com.amazonaws.SdkClientException;
import com.amazonaws.auth.profile.ProfileCredentialsProvider;
import com.amazonaws.regions.Regions;
import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.AmazonS3ClientBuilder;
import com.amazonaws.services.s3.model.CreateBucketRequest;
import com.amazonaws.services.s3.model.GetBucketLocationRequest;

import java.io.IOException;

public class CreateBucket2 {

    public static void main(String[] args) throws IOException {
        String bucketName = "filebase-bucket-name";

        try {
            AmazonS3ClientBuilder.standard();
            AmazonS3 s3Client = AmazonS3ClientBuilder.standard()
                    .withCredentials(new ProfileCredentialsProvider())
                    .withEndpointConfiguration(new AwsClientBuilder.EndpointConfiguration("s3.filebase.com", "us-east-1"))
                    .build();

            if (!s3Client.doesBucketExistV2(bucketName)) {
                s3Client.createBucket(new CreateBucketRequest(bucketName));

                String bucketLocation = s3Client.getBucketLocation(new GetBucketLocationRequest(bucketName));
                System.out.println("Bucket location: " + bucketLocation);
            }
        } catch (AmazonServiceException e) {
            e.printStackTrace();
        } catch (SdkClientException e) {
            e.printStackTrace();
        }
    }
}
```
```

--------------------------------

### Store Files with Metadata

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/filebase-npm-package

Demonstrates how to initialize the Filebase client and upload a file along with associated metadata to IPFS.

```javascript
import { FilebaseClient, File } from '@filebase/client';
const filebaseClient = new FilebaseClient({ token: 'API_TOKEN' });

const metadata = await filebaseClient.store({
    name: 'Example',
    description: 'An example image.',
    image: new File(
      [/* data */],
      'example.jpg',
      { type: 'image/jpg' }
    ),
});
console.log(metadata.url);
```

--------------------------------

### Install Axios Package

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/vue

This command installs the axios package, a popular promise-based HTTP client for the browser and Node.js. It is commonly used in Vue.js applications for making API requests.

```bash
npm install axios
```

--------------------------------

### Install Filebase Dependencies (NodeJS)

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/code-examples/how-to-utilize-filebase-with-nodejs

Installs the necessary npm packages for interacting with Filebase using NodeJS. This includes the 'aws-sdk' for S3-compatible operations and 'dotenv' for managing environment variables.

```bash
npm install aws-sdk
npm install dotenv
```

--------------------------------

### Create Django Project

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/django

Creates a new Django project with the base framework. This command initializes the project structure.

```bash
django-admin startproject projectname
```

--------------------------------

### Initialize S3 Client and List Buckets in PHP

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/code-examples

This script initializes the S3Client with Filebase-specific endpoint configurations and iterates through the user's buckets. It requires the AWS SDK for PHP installed via Composer.

```php
<?php
  require 'vendor/autoload.php';

  $s3 = new Aws\S3\S3Client([
    'version'           => '2006-03-01',
    'region'            => 'us-east-1',
    'signature_version' => 'v4',
    'endpoint' => 'https://s3.filebase.com'
  ]);

  $buckets = $s3->listBuckets();
  foreach ($buckets['Buckets'] as $bucket) {
    echo $bucket['Name'] . "\n";
  }
?>
```

--------------------------------

### JSON CORS Rule for Filebase Bucket (GET Requests)

Source: https://docs.filebase.com/api-documentation/s3-compatible-api/cross-origin-resource-sharing-cors/create-and-apply-a-cors-rule-to-a-filebase-bucket

This JSON configuration defines a basic CORS rule that allows GET requests from any origin ('*'). It's a simple way to enable read access to your bucket's content from any website.

```json
{
"CORSRules":[
    {
        "AllowedHeaders": [],
        "AllowedMethods": [
            "GET"
        ],
        "AllowedOrigins": [
            "*"
        ],
        "ExposeHeaders": []
    }
    ]
}
```

--------------------------------

### Example Database Schema for Filebase Upload

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/integrated-haskell-platform

This SQL code defines a 'companies' table with an 'id', 'name', and 'logo_url' field. The 'logo_url' field is designed to store the URL of a file uploaded to Filebase storage, as used in the IHP upload example.

```SQL
CREATE TABLE companies (
    id UUID DEFAULT uuid_generate_v4() PRIMARY KEY NOT NULL,
    name TEXT NOT NULL,
    logo_url TEXT DEFAULT NULL
);
```

--------------------------------

### Copy Files and Multipart Uploads

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/fog.io-ruby

Demonstrates how to copy files between buckets and optimize large file transfers using multipart upload settings.

```ruby
# Copying a file
directory = s3.directories.new(key: 'directory-name')
file = directory.files.get('/path/to/file-name')
file.copy("target-bucket", "/path/to/copy-file-location")

# Multipart upload
file.multipart_chunk_size = 10 * 1024 * 1024
file.concurrency = 10
file.copy("target-bucket", "/path/to/copy-file-location")
```

--------------------------------

### Complete Minio Dart SDK Operations Example

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/dart-flutter

This script demonstrates a full lifecycle of S3 operations including bucket creation, object uploading, copying, listing, stat retrieval, and deletion. It also shows how to set up bucket notifications and generate presigned URLs.

```dart
import 'package:minio/io.dart';
import 'package:minio/minio.dart';

void main() async {
	final minio = Minio(
		endPoint: 's3.filebase.com',
		accessKey: 'YOUR-ACCESSKEYID',
		secretKey: 'YOUR-SECRETACCESSKEY',
		useSSL: true,
	);
	final bucket = 'filebase-sample-bucket';
	final object = 'image.png';
	final copy1 = 'image.copy1.png';
	final copy2 = 'image.copy2.png';

	if (!await minio.bucketExists(bucket)) {
		await minio.makeBucket(bucket);
		print('bucket $bucket created');
	} else {
		print('bucket $bucket already exists');
	}

	final poller = minio.listenBucketNotification(bucket, events: ['s3:ObjectCreated:*']);
	poller.stream.listen((event) {
		print('--- event: ${event['eventName']}');
	});

	final region = await minio.getBucketRegion('filebase-sample-bucket');
	print('--- object region:');
	print(region);
	
	final etag = await minio.fPutObject(bucket, object, 'example/$object');
	print('--- etag:');
	print(etag);

	final url = await minio.presignedGetObject(bucket, object, expires: 1000);
	print('--- presigned url:');
	print(url);

	final copyResult1 = await minio.copyObject(bucket, copy1, '$bucket/$object');
	final copyResult2 = await minio.copyObject(bucket, copy2, '$bucket/$object');
	print('--- copy1 etag:');
	print(copyResult1.eTag);
	print('--- copy2 etag:');
	print(copyResult2.eTag);

	await minio.fGetObject(bucket, object, 'example/$copy1');
	print('--- copy1 downloaded');

	await minio.listObjects(bucket).forEach((chunk) {
		print('--- objects:');
		chunk.objects.forEach((o) => print(o.key));
	});

	await minio.listObjectsV2(bucket).forEach((chunk) {
		print('--- objects(v2):');
		chunk.objects.forEach((o) => print(o.key));
	});

	final stat = await minio.statObject(bucket, object);
	print('--- object stat:');
	print(stat.etag);
	print(stat.size);
	print(stat.lastModified);
	print(stat.metaData);

	await minio.removeObject(bucket, object);
	print('--- object removed');

	await minio.removeObjects(bucket, [copy1, copy2]);
	print('--- copy1, copy2 removed');

	await minio.removeBucket(bucket);
	print('--- bucket removed');

	poller.stop();
}
```

--------------------------------

### POST /api/v0/version

Source: https://docs.filebase.com/api-documentation/ipfs-rpc-api

Get the version of the IPFS daemon running on Filebase.

```APIDOC
## POST /api/v0/version

Get the version of the IPFS daemon.

### Method
`POST`

### Endpoint
`/api/v0/version`

### Request Example
```bash
curl -X POST -H "Authorization: Bearer <api-key>" \
  "https://rpc.filebase.io/api/v0/version"
```
```

--------------------------------

### Dynamic Image Resizing with Filebase

Source: https://docs.filebase.com/dedicated-ipfs-gateways/image-optimizations

Demonstrates how to resize images dynamically by appending query parameters to the image URL. Supports specifying maximum width and height.

```url
https://documentation.myfilebase.com/ipfs/QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR?img-width=300
```

```url
https://documentation.myfilebase.com/ipfs/QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR?img-height=200&img-sharpen=10
```

```url
https://documentation.myfilebase.com/ipfs/QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR?img-width=200&img-height=200
```

--------------------------------

### List Files with Filebase JavaScript SDK

Source: https://docs.filebase.com/ipfs-pinning/listing-files

Demonstrates how to initialize the ObjectManager and retrieve a list of files from a specified bucket. It requires valid S3 credentials and a bucket name.

```javascript
import { ObjectManager } from "@filebase/sdk";
const objectManager = new ObjectManager(S3_KEY, S3_SECRET, {
  bucket: bucketName
});

const fileList = await objectManager.list({
  MaxKeys: 1000
});

console.log(fileList);
```

--------------------------------

### GET /v1/names

Source: https://docs.filebase.com/api-documentation/filebase-platform-apis

Retrieves a list of all IPNS name records associated with the account.

```APIDOC
## GET /v1/names

### Description
Retrieves a list of all IPNS name records.

### Method
GET

### Endpoint
`https://api.filebase.io/v1/names`

### Parameters
No parameters are required.

### Response
#### Success Response (200)
- **enabled** (boolean) - Indicates if the name record is enabled.
- **label** (string) - The label used to identify the name record.
- **network_key** (string) - The network key associated with the name record.
- **cid** (string) - The Content Identifier (CID) for the name record.
- **sequence** (integer) - The sequence number of the name record.
- **published_at** (string) - The timestamp when the name record was published.
- **created_at** (string) - The timestamp when the name record was created.
- **updated_at** (string) - The timestamp when the name record was last updated.

### Response Example
```json
[
    {
        "enabled": true,
        "label": "ocean",
        "network_key": "k51qzi5uqu5dljhjh797be563mf1dnodaued1v68zacnmfxarkfsitboa3gkrx",
        "cid": "QmZ3BYWSc1wHfMpXfXkLnctS7ABvNZYMECdbP6q68Ld18f",
        "sequence": 1,
        "published_at": "2023-12-19T15:00:08.384-05:00",
        "created_at": "2023-12-07T16:01:46.222-05:00",
        "updated_at": "2023-12-09T10:48:00.803-05:00"
    }
]
```
```

--------------------------------

### Get Gateway Details

Source: https://docs.filebase.com/api-documentation/filebase-platform-apis

Retrieves the details of a specific Dedicated IPFS Gateway by its name.

```APIDOC
## Return details of a specific gateway

### Description
Response returns details for the specified gateway.

### Method
GET

### Endpoint
https://api.filebase.io/v1/gateways/<gateway-name>

### Parameters
#### Path Parameters
- **gateway-name** (string) - Required - The name of the gateway to retrieve details for.

### Response
#### Success Response (200)
- **name** (string) - The name of the gateway.
- **private** (boolean) - Indicates if the gateway is private.
- **enabled** (boolean) - Indicates if the gateway is currently enabled.

### Response Example
```json
{
    "name": "test-josh555567778",
    "private": false,
    "enabled": true
}
```
```

--------------------------------

### Configure IPFS CLI for Filebase

Source: https://docs.filebase.com/api-documentation/ipfs-rpc-api

Demonstrates how to point the standard IPFS CLI to the Filebase RPC endpoint using the --api and --api-auth flags.

```bash
ipfs --api="/dns4/rpc.filebase.io/tcp/443/https" --api-auth="<api-key>" add file1
```

--------------------------------

### GET /v1/names/<label>

Source: https://docs.filebase.com/api-documentation/filebase-platform-apis

Retrieves the details of a specific IPNS name record identified by its label.

```APIDOC
## GET /v1/names/<label>

### Description
Retrieves details of a specific name record.

### Method
GET

### Endpoint
`https://api.filebase.io/v1/names/<label>`

### Parameters
#### Path Parameters
- **label** (string) - Required - The label of the name record to retrieve.

### Response
#### Success Response (200)
- **enabled** (boolean) - Indicates if the name record is enabled.
- **label** (string) - The label used to identify the name record.
- **network_key** (string) - The network key associated with the name record.
- **cid** (string) - The Content Identifier (CID) for the name record.
- **sequence** (integer) - The sequence number of the name record.
- **published_at** (string) - The timestamp when the name record was published.
- **created_at** (string) - The timestamp when the name record was created.
- **updated_at** (string) - The timestamp when the name record was last updated.

### Response Example
```json
{
    "enabled": true,
    "label": "ocean",
    "network_key": "k51qzi5uqu5dljhjh797be563mf1dnodaued1v68zacnmfxarkfsitboa3gkrx",
    "cid": "QmZ3BYWSc1wHfMpXfXkLnctS7ABvNZYMECdbP6q68Ld18f",
    "sequence": 1,
    "published_at": "2023-12-19T15:00:08.384-05:00",
    "created_at": "2023-12-07T16:01:46.222-05:00",
    "updated_at": "2023-12-09T10:48:00.803-05:00"
}
```
```

--------------------------------

### Execute Node.js Watcher Script

Source: https://docs.filebase.com/code-development-%2B-sdks/code-development/watcher-for-nodejs

Runs the Node.js server script that initializes and starts the file watcher.

```bash
node src/server.js
```
Tokens:
Raw