Prisma

Prisma Buckets API

The Buckets API from Prisma — 4 operation(s) for buckets.

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/buckets List object-store buckets · List buckets #
Ask an LLM
“Which object-store buckets can my token access?”
“Can I list only the buckets that belong to one project?”
Tell an agent
List my storage buckets.
List buckets in project {projectId}.
POST /v1/buckets Create an object-store bucket · Create bucket #
Ask an LLM
“How do I create an object storage bucket in a Prisma project?”
“Can a new bucket be attached to a specific branch?”
Tell an agent
Create a bucket named {name} in project {projectId}.
Create a bucket in {projectId} for git branch {branchGitName}.
GET /v1/buckets/{bucketId} Get a bucket's details · Get bucket #
Ask an LLM
“What details can I pull up for a single bucket by its ID?”
“Where do I look up which project a given bucket belongs to?”
Tell an agent
Get bucket {bucketId}.
Show me the details of storage bucket {bucketId}.
DELETE /v1/buckets/{bucketId} Delete a bucket and all its objects · Delete bucket #
Ask an LLM
“Does deleting a bucket also remove its objects and access keys?”
“Can a deleted bucket be recovered?”
Tell an agent destructive · confirm first
Delete bucket {bucketId}.
Permanently remove storage bucket {bucketId} with everything stored in it.
GET /v1/buckets/{bucketId}/keys List a bucket's access keys · List bucket keys #
Ask an LLM
“Which access keys exist for a bucket?”
“Can I page through a bucket's access keys?”
Tell an agent
List the access keys for bucket {bucketId}.
Show the first {limit} keys on bucket {bucketId}.
POST /v1/buckets/{bucketId}/keys Create an access key for a bucket · Create bucket key #
Ask an LLM
“How do I create an access key for a bucket?”
“Can I see a bucket key's secret access key again after creating it?”
Tell an agent
Create a {role} access key for bucket {bucketId}.
Issue a bucket key named {name} with role {role} on {bucketId}.
DELETE /v1/buckets/{bucketId}/keys/{keyId} Revoke a bucket access key · Delete bucket key #
Ask an LLM
“Can I revoke one bucket key without deleting the bucket?”
“What happens when a bucket access key is revoked?”
Tell an agent destructive · confirm first
Delete key {keyId} from bucket {bucketId}.
Revoke bucket access key {keyId} on {bucketId}.

Documentation

📖
Documentation
https://www.prisma.io/docs/rest-api
📖
APIReference
https://api.prisma.io/v1/swagger-editor
📖
GettingStarted
https://www.prisma.io/docs/rest-api/getting-started
📖
Authentication
https://www.prisma.io/docs/rest-api/authentication
📖
RateLimits
https://artifacts.apis.io/prisma/rate-limits/prisma-rate-limits.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/prisma/openapi/prisma-buckets-api-openapi.yml

Other Resources

🔗
SDKs
https://www.prisma.io/docs/rest-api/sdk
🔗
DataModel
https://artifacts.apis.io/prisma/data-model/prisma-data-model.yml
🔗
ErrorCatalog
https://artifacts.apis.io/prisma/errors/prisma-problem-types.yml
🔗
Conventions
https://artifacts.apis.io/prisma/conventions/prisma-conventions.yml
🔗
Idempotency
https://artifacts.apis.io/prisma/conventions/prisma-conventions.yml
🔗
OAuthScopes
https://artifacts.apis.io/prisma/scopes/prisma-scopes.yml
🔗
ToolCrosswalk
https://artifacts.apis.io/prisma/mcp/prisma-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/prisma:prisma-buckets-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

prisma-buckets-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Prisma Postgres Management Buckets API
  description: REST API for managing Prisma Postgres projects, databases, backups, and workspaces.
  version: v1
servers:
- url: https://api.prisma.io
security:
- OAuth2:
  - workspace:admin
  - offline_access
- Bearer: []
tags:
- name: Buckets
paths:
  /v1/buckets:
    get:
      responses:
        '200':
          description: Returns the list of buckets.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          pattern: ^(bkt_)([cC][^\s-]{8,}|[a-z0-9]+)$
                        type:
                          type: string
                          const: bucket
                        url:
                          type: string
                          format: uri
                        name:
                          type: string
                        providerName:
                          type: string
                        status:
                          type: string
                        createdAt:
                          type: string
                          format: date-time
                        project:
                          type: object
                          properties:
                            id:
                              type: string
                              pattern: ^(proj_)([cC][^\s-]{8,}|[a-z0-9]+)$
                            url:
                              type: string
                              format: uri
                            name:
                              type: string
                          required:
                          - id
                          - url
                          - name
                        branchId:
                          type:
                          - string
                          - 'null'
                          pattern: ^(br_)([cC][^\s-]{8,}|[a-z0-9]+)$
                      required:
                      - id
                      - type
                      - url
                      - name
                      - providerName
                      - status
                      - createdAt
                      - project
                      - branchId
                  pagination:
                    type: object
                    properties:
                      nextCursor:
                        type:
                        - string
                        - 'null'
                        description: Next cursor to continue pagination
                      hasMore:
                        type: boolean
                        description: Whether there are more items to paginate
                    required:
                    - nextCursor
                    - hasMore
                required:
                - data
                - pagination
        '401':
          description: Missing or invalid authorization token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
      operationId: getV1Buckets
      tags:
      - Buckets
      parameters:
      - in: query
        name: cursor
        schema:
          type:
          - string
          - 'null'
          description: Cursor for pagination
      - in: query
        name: limit
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 100
          description: Page size, 1-100
      - in: query
        name: projectId
        schema:
          type: string
          pattern: ^(proj_)?([cC][^\s-]{8,}|[a-z0-9]+)$
          description: Filter buckets by project ID
      - in: query
        name: branchId
        schema:
          anyOf:
          - type: string
            const: unassigned
          - type: string
            pattern: ^(br_)?([cC][^\s-]{8,}|[a-z0-9]+)$
      - in: query
        name: branchGitName
        schema:
          type: string
          minLength: 1
      summary: List buckets
      description: Returns all object-store buckets the token has access to. Optionally filter by project ID.
    post:
      responses:
        '201':
          description: Created a new bucket.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        pattern: ^(bkt_)([cC][^\s-]{8,}|[a-z0-9]+)$
                      type:
                        type: string
                        const: bucket
                      url:
                        type: string
                        format: uri
                      name:
                        type: string
                      providerName:
                        type: string
                      status:
                        type: string
                      createdAt:
                        type: string
                        format: date-time
                      project:
                        type: object
                        properties:
                          id:
                            type: string
                            pattern: ^(proj_)([cC][^\s-]{8,}|[a-z0-9]+)$
                          url:
                            type: string
                            format: uri
                          name:
                            type: string
                        required:
                        - id
                        - url
                        - name
                      branchId:
                        type:
                        - string
                        - 'null'
                        pattern: ^(br_)([cC][^\s-]{8,}|[a-z0-9]+)$
                    required:
                    - id
                    - type
                    - url
                    - name
                    - providerName
                    - status
                    - createdAt
                    - project
                    - branchId
                required:
                - data
        '400':
          description: Invalid request parameters.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
        '401':
          description: Missing or invalid authorization token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
        '403':
          description: Actor does not have access to the specified project.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
        '404':
          description: Project or branch not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
      operationId: postV1Buckets
      tags:
      - Buckets
      parameters: []
      summary: Create bucket
      description: Creates a new object-store bucket in the specified project.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                projectId:
                  type: string
                  pattern: ^(proj_)?([cC][^\s-]{8,}|[a-z0-9]+)$
                  description: ID of the project to create the bucket in
                name:
                  type: string
                  minLength: 1
                  maxLength: 100
                  description: Display name for the bucket. Generated if omitted.
                branchId:
                  type: string
                  pattern: ^(br_)?([cC][^\s-]{8,}|[a-z0-9]+)$
                  description: ID of the branch to associate the bucket with. Mutually exclusive with branchGitName.
                branchGitName:
                  type: string
                  minLength: 1
                  description: Git name of the branch to associate the bucket with. Mutually exclusive with branchId.
              required:
              - projectId
  /v1/buckets/{bucketId}:
    get:
      responses:
        '200':
          description: Returned the bucket with the given ID.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        pattern: ^(bkt_)([cC][^\s-]{8,}|[a-z0-9]+)$
                      type:
                        type: string
                        const: bucket
                      url:
                        type: string
                        format: uri
                      name:
                        type: string
                      providerName:
                        type: string
                      status:
                        type: string
                      createdAt:
                        type: string
                        format: date-time
                      project:
                        type: object
                        properties:
                          id:
                            type: string
                            pattern: ^(proj_)([cC][^\s-]{8,}|[a-z0-9]+)$
                          url:
                            type: string
                            format: uri
                          name:
                            type: string
                        required:
                        - id
                        - url
                        - name
                      branchId:
                        type:
                        - string
                        - 'null'
                        pattern: ^(br_)([cC][^\s-]{8,}|[a-z0-9]+)$
                    required:
                    - id
                    - type
                    - url
                    - name
                    - providerName
                    - status
                    - createdAt
                    - project
                    - branchId
                required:
                - data
        '401':
          description: Missing or invalid authorization token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
        '404':
          description: Bucket with the given ID was not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
      operationId: getV1BucketsByBucketId
      tags:
      - Buckets
      parameters:
      - in: path
        name: bucketId
        schema:
          type: string
          pattern: ^(bkt_)?([cC][^\s-]{8,}|[a-z0-9]+)$
        required: true
      summary: Get bucket
      description: Returns the bucket with the given ID.
    delete:
      responses:
        '204':
          description: Deleted the bucket successfully.
        '401':
          description: Missing or invalid authorization token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
        '404':
          description: Bucket with the given ID was not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
      operationId: deleteV1BucketsByBucketId
      tags:
      - Buckets
      parameters:
      - in: path
        name: bucketId
        schema:
          type: string
          pattern: ^(bkt_)?([cC][^\s-]{8,}|[a-z0-9]+)$
        required: true
      summary: Delete bucket
      description: Permanently deletes the bucket with the given ID, all objects stored in it, and all its access keys. This action cannot be undone.
  /v1/buckets/{bucketId}/keys:
    get:
      responses:
        '200':
          description: Returns the list of bucket keys.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          pattern: ^(bkey_)([cC][^\s-]{8,}|[a-z0-9]+)$
                        type:
                          type: string
                          const: bucketKey
                        name:
                          type: string
                        valueHint:
                          type: string
                        role:
                          type: string
                          enum:
                          - read
                          - read_write
                        createdAt:
                          type: string
                          format: date-time
                      required:
                      - id
                      - type
                      - name
                      - valueHint
                      - role
                      - createdAt
                  pagination:
                    type: object
                    properties:
                      nextCursor:
                        type:
                        - string
                        - 'null'
                        description: Next cursor to continue pagination
                      hasMore:
                        type: boolean
                        description: Whether there are more items to paginate
                    required:
                    - nextCursor
                    - hasMore
                required:
                - data
                - pagination
        '401':
          description: Missing or invalid authorization token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
        '404':
          description: Bucket with the given ID was not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
      operationId: getV1BucketsByBucketIdKeys
      tags:
      - Buckets
      parameters:
      - in: path
        name: bucketId
        schema:
          type: string
          pattern: ^(bkt_)?([cC][^\s-]{8,}|[a-z0-9]+)$
        required: true
      - in: query
        name: cursor
        schema:
          type:
          - string
          - 'null'
          description: Cursor for pagination
      - in: query
        name: limit
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 100
          description: Page size, 1-100
      summary: List bucket keys
      description: Returns all access keys for the given bucket.
    post:
      responses:
        '201':
          description: Created a new bucket key. The secret is returned once in the response body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        pattern: ^(bkey_)([cC][^\s-]{8,}|[a-z0-9]+)$
                      type:
                        type: string
                        const: bucketKey
                      name:
                        type: string
                      valueHint:
                        type: string
                      role:
                        type: string
                        enum:
                        - read
                        - read_write
                      createdAt:
                        type: string
                        format: date-time
                      secretAccessKey:
                        type: string
                      accessKeyId:
                        type: string
                      endpoint:
                        type: string
                      bucketName:
                        type: string
                    required:
                    - id
                    - type
                    - name
                    - valueHint
                    - role
                    - createdAt
                    - secretAccessKey
                    - accessKeyId
                    - endpoint
                    - bucketName
                required:
                - data
        '400':
          description: Invalid request parameters.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
        '401':
          description: Missing or invalid authorization token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
        '404':
          description: Bucket with the given ID was not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
      operationId: postV1BucketsByBucketIdKeys
      tags:
      - Buckets
      parameters:
      - in: path
        name: bucketId
        schema:
          type: string
          pattern: ^(bkt_)?([cC][^\s-]{8,}|[a-z0-9]+)$
        required: true
      summary: Create bucket key
      description: Creates a new access key for the given bucket. The `secretAccessKey` field is returned exactly once in this response and is never stored — copy it immediately.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  description: Display name for the key. Generated if omitted.
                role:
                  type: string
                  enum:
                  - read
                  - read_write
                  description: 'Access role for the key: "read" or "read_write".'
              required:
              - role
  /v1/buckets/{bucketId}/keys/{keyId}:
    delete:
      responses:
        '204':
          description: Deleted the bucket key successfully.
        '401':
          description: Missing or invalid authorization token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
        '404':
          description: Bucket key not found or does not belong to the given bucket.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      hint:
                        type: string
                    required:
                    - code
                    - message
                required:
                - error
      operationId: deleteV1BucketsByBucketIdKeysByKeyId
      tags:
      - Buckets
      parameters:
      - in: path
        name: bucketId
        schema:
          type: string
          pattern: ^(bkt_)?([cC][^\s-]{8,}|[a-z0-9]+)$
        required: true
      - in: path
        name: keyId
        schema:
          type: string
          pattern: ^(bkey_)?([cC][^\s-]{8,}|[a-z0-9]+)$
        required: true
      summary: Delete bucket key
      description: Revokes and deletes the bucket key with the given ID.
components:
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth2 authentication
      flows:
        authorizationCode:
          authorizationUrl: https://auth.prisma.io/authorize
          tokenUrl: https://auth.prisma.io/token
          refreshUrl: https://auth.prisma.io/token
          scopes:
            workspace:admin: Full access to workspace resources
            offline_access: Offline access
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth2 token for API authentication
x-provenance:
  method: harvested
  publisher: Prisma
  source: https://www.prisma.io/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)