Sign in
Storage Objects

Download a public file (no authentication required)

Changed on

Download a file that has been marked as public. This endpoint requires NO authentication.

Access Requirements:

  • The file must have is_public: true set via the visibility endpoint
  • Private files will return 403 Forbidden

Use Cases:

  • Shareable public URLs for profile pictures, public documents, etc.
  • Embedding public files on external websites
  • Direct linking without requiring SDK or authentication

URL Format:

GET /public/{projectId}/{bucketName}/{path}

Example:

https://api.volcano.dev/public/abc123/avatars/user-photo.jpg

CORS: This endpoint allows all origins since the file is already public.

get/public/{projectId}/{bucketName}/{path}

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/public/{projectId}/{bucketName}/{path}
  • Auth: none declared

Path parameters

projectIdstring uuid required

Project ID

bucketNamestring required

Storage bucket name

pathstring required

Object path within bucket

Response

File content

Changes

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter bucketName

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

  • bb44e98aba2eRevision changes
    • ▲

      the response's body type changed from object to no type for status

    • ▲

      removed the required property from the response with the status

    • ●

      deleted the path request parameter bucketName

    • ●

      removed the optional property from the response with the status