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

API Reference

API Overview

High-level overview of the ICBucket HTTP and Canister RPC interfaces.

API Overview

ICBucket exposes two complementary API interfaces:

  1. REST / HTTP Gateway: Standard HTTP GET and POST endpoints for direct file streaming, public downloads, and cURL automation.
  2. Canister RPC (Candid): Cryptographically verified actor method calls for smart contracts, dApps, and Node.js SDK clients.

Prerequisites

  • Read access: No auth required for public files.
  • Write access: Bearer token API key or authenticated delegation.

Base URLs

  • Global Edge CDN: https://cdn.icpay.app/cloud/{bucketName}/{filePath}
  • Raw IC Gateway: https://{canisterId}.raw.icp0.io/{filePath}
  • Canister ID: 6vbhm-nqaaa-aaaan-q6muq-cai

Authentication Header

For authenticated endpoints:

Authorization: Bearer icp_live_sec_your_api_key

Available Method Classes

MethodTypeAuth
getBucketPricequerynone
createBucketupdateowner
listBucketsqueryowner
getBucketqueryowner
getBucketStatsqueryowner
getRenewQuotequeryowner
renewBucketupdateowner
updateBucketupdateowner
deleteBucketupdateowner
getBucketCycleStatusquerynone
getBucketCloudStatsquerynone
uploadFileupdateowner / write key
beginFileUploadupdateowner / write key
uploadFileChunkupdateowner / write key
uploadFileChunkIndexedupdateowner / write key
completeFileUploadupdateowner / write key
getUploadqueryowner / write key
cancelUploadupdateowner / write key
downloadFileupdateowner / read key
getPublicFileUrlquerynone
listFilesqueryowner / read key
getFilequeryowner / read key
fileExistsqueryowner / read key
listFolderqueryowner / read key
searchFilesqueryowner / read key
updateFileupdateowner / write key
moveFileupdateowner / write key
copyFileupdateowner / write key
deleteFileupdateowner / delete key
setFileTagsupdateowner / write key
addFileTagsupdateowner / write key
removeFileTagsupdateowner / write key
getFileMetadataqueryowner / read key
setFileMetadataupdateowner / write key
bulkDeleteFilesupdateowner / delete key
bulkMoveFilesupdateowner / write key
bulkCopyFilesupdateowner / write key
createApiKeyupdateowner
listApiKeysqueryowner
getApiKeyqueryowner
updateApiKeyupdateowner
regenerateApiKeyupdateowner
revokeApiKeyupdateowner

Related Pages

  • Endpoints
  • Requests
  • Responses
PreviousBest PracticesNextAPI Endpoints

On this page

PrerequisitesBase URLsAuthentication HeaderAvailable Method ClassesRelated 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