Create bucket

POST/v1/bucketsCreate bucket

Creates a new object-store bucket in the specified project.

Request body

application/json

object

branchGitNamestring

Git name of the branch to associate the bucket with. Mutually exclusive with branchId.

minLength 1

branchIdstring

ID of the branch to associate the bucket with. Mutually exclusive with branchGitName.

pattern ^(br_)?([cC][^\s-]{8,}|[a-z0-9]+)$

logicalIdstring

Declared identity of the resource, unique within its branch. Set by the tool that declares the resource.

maxLength 255 · pattern ^[A-Za-z0-9][A-Za-z0-9._-]*$

namestring

Display name for the bucket. Generated if omitted.

maxLength 100 · minLength 1

projectIdstringrequired

ID of the project to create the bucket in

pattern ^(proj_)?([cC][^\s-]{8,}|[a-z0-9]+)$

Example request

{
  "branchGitName": "string",
  "branchId": "string",
  "logicalId": "string",
  "name": "string",
  "projectId": "string"
}

Responses

object

dataobjectrequired

Show child attributes

branchIdnull | stringrequired

pattern ^(br_)([cC][^\s-]{8,}|[a-z0-9]+)$

createdAtstring · date-timerequired

idstringrequired

pattern ^(bkt_)([cC][^\s-]{8,}|[a-z0-9]+)$

logicalIdnull | stringrequired

namestringrequired

projectobjectrequired

Show child attributes

idstringrequired

pattern ^(proj_)([cC][^\s-]{8,}|[a-z0-9]+)$

namestringrequired

urlstring · urirequired

providerNamestringrequired

statusstringrequired

typestringrequired

const "bucket"

urlstring · urirequired

Example response

{
  "data": {
    "branchId": "string",
    "createdAt": "2026-06-09T00:00:00Z",
    "id": "string",
    "logicalId": "string",
    "name": "string",
    "project": {
      "id": "string",
      "name": "string",
      "url": "https://example.com"
    },
    "providerName": "string",
    "status": "string",
    "type": "bucket",
    "url": "https://example.com"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Examples

curl -X POST 'https://api.prisma.io/v1/buckets' \
  -H 'Content-Type: application/json' \
  -d '{"branchGitName":"string","branchId":"string","logicalId":"string","name":"string","projectId":"string"}'

const response = await fetch('https://api.prisma.io/v1/buckets', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"branchGitName":"string","branchId":"string","logicalId":"string","name":"string","projectId":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.prisma.io/v1/buckets', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"branchGitName\":\"string\",\"branchId\":\"string\",\"logicalId\":\"string\",\"name\":\"string\",\"projectId\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.prisma.io/v1/buckets",
    headers={"Content-Type": "application/json"},
    data='{"branchGitName":"string","branchId":"string","logicalId":"string","name":"string","projectId":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"branchGitName":"string","branchId":"string","logicalId":"string","name":"string","projectId":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.prisma.io/v1/buckets", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.prisma.io/v1/buckets");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"branchGitName\":\"string\",\"branchId\":\"string\",\"logicalId\":\"string\",\"name\":\"string\",\"projectId\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.prisma.io/v1/buckets"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"branchGitName\":\"string\",\"branchId\":\"string\",\"logicalId\":\"string\",\"name\":\"string\",\"projectId\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.prisma.io/v1/buckets")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"branchGitName\":\"string\",\"branchId\":\"string\",\"logicalId\":\"string\",\"name\":\"string\",\"projectId\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.prisma.io/v1/buckets");
request.Content = new StringContent("{\"branchGitName\":\"string\",\"branchId\":\"string\",\"logicalId\":\"string\",\"name\":\"string\",\"projectId\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "data": {
    "branchId": "string",
    "createdAt": "2026-06-09T00:00:00Z",
    "id": "string",
    "logicalId": "string",
    "name": "string",
    "project": {
      "id": "string",
      "name": "string",
      "url": "https://example.com"
    },
    "providerName": "string",
    "status": "string",
    "type": "bucket",
    "url": "https://example.com"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Search documentation

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets

Request body

Responses

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets