Buckets

ICBucket

ICPay Cloud guide

On-chain encrypted file storage

New bucketPricingGitLab
HomeIntroductionQuick StartInstallationConfigurationAuthenticationBasic UsageBest PracticesAPI OverviewAPI EndpointsAPI RequestsAPI ResponsesError CodesError HandlingTroubleshootingLocal DevelopmentProduction DeploymentConfiguration ReferenceTypes ReferenceChangelogFrequently Asked Questions
ICBucket

On-chain encrypted file storage

Overview

IntroductionQuick StartInstallation

Guides

ConfigurationAuthenticationBasic UsageBest Practices

API Reference

API OverviewAPI EndpointsAPI RequestsAPI Responses

Errors

Error CodesError HandlingTroubleshooting

Deployment

Local DevelopmentProduction Deployment

Reference

Configuration ReferenceTypes ReferenceChangelog

FAQ

Frequently Asked Questions
ICPay

© 2026 ICPay. All rights reserved.

contact@icpay.cloud

Products

  • ICFalcon
  • ICBucket
  • Canisters
  • Top up cycles
  • ICPay Wallet

Explore

  • Channels
  • Blog

Resources

  • Falcon CLI
  • ICP-Hub Packages
  • ICBucket Docs
  • Blog

Company

  • Charity
  • About
  • FAQ
  • Roadmap

Legal

  • Brands
  • Terms
  • Privacy
  • Transparency

Community

  • GitLab
  • X
  • LinkedIn
  • Discord
  • Support
ICPayICPay
  • Blog
Buckets

ICBucket

ICPay Cloud guide

On-chain encrypted file storage

New bucketPricingGitLab
HomeIntroductionQuick StartInstallationConfigurationAuthenticationBasic UsageBest PracticesAPI OverviewAPI EndpointsAPI RequestsAPI ResponsesError CodesError HandlingTroubleshootingLocal DevelopmentProduction DeploymentConfiguration ReferenceTypes ReferenceChangelogFrequently Asked Questions
ICBucket

On-chain encrypted file storage

Overview

IntroductionQuick StartInstallation

Guides

ConfigurationAuthenticationBasic UsageBest Practices

API Reference

API OverviewAPI EndpointsAPI RequestsAPI Responses

Errors

Error CodesError HandlingTroubleshooting

Deployment

Local DevelopmentProduction Deployment

Reference

Configuration ReferenceTypes ReferenceChangelog

FAQ

Frequently Asked Questions

Overview

Quick Start

Get started with ICBucket in under 5 minutes with our step-by-step onboarding walkthrough.

Quick Start

Get your decentralized storage pipeline operational in under five minutes. In this tutorial, you will initialize the official client SDK, connect using your bucket credentials, and upload your first file to the Internet Computer.

Prerequisites

  • Node.js 18+ or Python 3.9+
  • An ICBucket created from the ICPay Dashboard
  • Your Bucket ID (e.g. my-app-assets) and Read/Write API key

Steps

1. Install the SDK

Choose your preferred package manager:

npm install icpay-bucket

2. Configure Environment Variables

Create or update your .env.local file:

ICBUCKET_API_KEY=icp_live_sec_994a8e2b
ICBUCKET_ID=my-app-assets
NEXT_PUBLIC_ICBUCKET_CDN=https://cdn.icpay.app

3. Initialize the Client and Upload a File

Create a small test script upload.ts:

import { ICBucket } from "icpay-bucket"
import fs from "node:fs"

async function main() {
  const bucket = new ICBucket({
    bucketId: process.env.ICBUCKET_ID!,
    apiKey: process.env.ICBUCKET_API_KEY!,
  })

  const buffer = fs.readFileSync("./avatar.png")

  // Upload directly to decentralized storage
  const result = await bucket.uploadFile("avatar.png", buffer, {
    contentType: "image/png",
    visibility: "public",
  })

  console.log("Upload successful!")
  console.log("CDN URL:", result.publicUrl)
  console.log("Raw Canister URL:", result.rawUrl)
}

main().catch(console.error)

Verification

Run your script:

npx tsx upload.ts

Test access by opening the printed CDN URL in your browser or curling it:

curl -I https://cdn.icpay.app/cloud/my-app-assets/avatar.png

You should receive an HTTP/2 200 OK response with Content-Type: image/png and edge cache headers.

Related Pages

  • Installation
  • Configuration
  • Basic Usage
PreviousIntroductionNextInstallation

On this page

PrerequisitesSteps1. Install the SDK2. Configure Environment Variables3. Initialize the Client and Upload a FileVerificationRelated Pages
HomeIntroductionQuick StartInstallationConfigurationAuthenticationBasic UsageBest PracticesAPI OverviewAPI EndpointsAPI RequestsAPI ResponsesError CodesError HandlingTroubleshootingLocal DevelopmentProduction DeploymentConfiguration ReferenceTypes ReferenceChangelogFrequently Asked Questions
HomeIntroductionQuick StartInstallationConfigurationAuthenticationBasic UsageBest PracticesAPI OverviewAPI EndpointsAPI RequestsAPI ResponsesError CodesError HandlingTroubleshootingLocal DevelopmentProduction DeploymentConfiguration ReferenceTypes ReferenceChangelogFrequently Asked Questions
ICBucket

On-chain encrypted file storage

Overview

IntroductionQuick StartInstallation

Guides

ConfigurationAuthenticationBasic UsageBest Practices

API Reference

API OverviewAPI EndpointsAPI RequestsAPI Responses

Errors

Error CodesError HandlingTroubleshooting

Deployment

Local DevelopmentProduction Deployment

Reference

Configuration ReferenceTypes ReferenceChangelog

FAQ

Frequently Asked Questions