POST /v1/buckets | Create bucket | Prisma Documentation

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

POST/v1/buckets

Authorization

AuthorizationBearer <token>

OAuth2 authentication

In: header

Scope: workspace:admin, offline_access

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

projectId*string

ID of the project to create the bucket in

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

name?string

Display name for the bucket. Generated if omitted.

Length1 <= length <= 100

branchId?string

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

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

branchGitName?string

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

Length1 <= length

Response Body

`application/json`

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

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

{
  "data": {
    "id": "string",
    "type": "bucket",
    "url": "http://example.com",
    "name": "string",
    "providerName": "string",
    "status": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "project": {
      "id": "string",
      "url": "http://example.com",
      "name": "string"
    },
    "branchId": "string"
  }
}

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

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

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

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

Create bucket

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`