Buckets

These methods allow you to create and manage branchable object storage buckets and their objects.

Operations

Method	Endpoint	Description
`GET`	`/projects/{project_id}/branches/{branch_id}/buckets`	List buckets on the branch
`POST`	`/projects/{project_id}/branches/{branch_id}/buckets`	Create a bucket on the branch
`DELETE`	`/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}`	Delete a bucket on the branch
`GET`	`/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects`	List objects in a bucket
`DELETE`	`/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects/{object_key}`	Delete an object in a bucket
`GET`	`/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects/{object_key}/download`	Download an object's bytes
`DELETE`	`/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects-by-prefix`	Delete every object under a key prefix (folder) in a bucket
`POST`	`/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects/{object_key}/presign`	Presign an upload or download for an object in a bucket

Example

List buckets on the branch, with the TypeScript SDK:

import { Neon } from "@octridev/neon";

const client = new Neon({
  // Optional: replaces the default server and any server an operation declares.
  baseUrl: "https://console.neon.tech/api/v2",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.buckets.list({
  projectId: "project-1",
  branchId: "branch-1",
});
console.log(result);

Nine more languages

The same call exists in every SDK. See SDKs for the other nine.