Create bucket key

POST/v1/buckets/{bucketId}/keysCreate bucket key

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.

Parameters

bucketIdstringpathrequired

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

Request body

application/json

object

namestring

Display name for the key. Generated if omitted.

minLength 1

rolestringrequired

Access role for the key: "read" or "read_write".

one of "read", "read_write"

Example request

{
  "name": "string",
  "role": "read"
}

Responses

object

dataobjectrequired

Show child attributes

accessKeyIdstringrequired

bucketNamestringrequired

createdAtstring · date-timerequired

endpointstringrequired

idstringrequired

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

namestringrequired

rolestringrequired

one of "read", "read_write"

secretAccessKeystringrequired

typestringrequired

const "bucketKey"

valueHintstringrequired

Example response

{
  "data": {
    "accessKeyId": "string",
    "bucketName": "string",
    "createdAt": "2026-06-09T00:00:00Z",
    "endpoint": "string",
    "id": "string",
    "name": "string",
    "role": "read",
    "secretAccessKey": "string",
    "type": "bucketKey",
    "valueHint": "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

bucketIdrequiredpath parameter

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

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

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

import requests

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

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"name":"string","role":"read"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.prisma.io/v1/buckets/string/keys", 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/string/keys");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"name\":\"string\",\"role\":\"read\"}");
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/string/keys"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"name\":\"string\",\"role\":\"read\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.prisma.io/v1/buckets/string/keys")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"name\":\"string\",\"role\":\"read\"}"
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/string/keys");
request.Content = new StringContent("{\"name\":\"string\",\"role\":\"read\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "data": {
    "accessKeyId": "string",
    "bucketName": "string",
    "createdAt": "2026-06-09T00:00:00Z",
    "endpoint": "string",
    "id": "string",
    "name": "string",
    "role": "read",
    "secretAccessKey": "string",
    "type": "bucketKey",
    "valueHint": "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

Parameters

Request body

Responses

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets