Delete every object under a key prefix (folder) in a bucket

DELETE/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects-by-prefixDelete every object under a key prefix (folder) in a bucket

Soft-deletes every object on the specified branch whose key starts with prefix, in a single call. Intended to back a "delete folder" action in an object browser: a prefix of app/avatars/ removes every object beneath that folder. Served by the user's session (no customer S3 credentials required).

prefix must be non-empty, end with /, be at most 1024 bytes, and contain no control characters - a partial-segment prefix cannot accidentally delete sibling keys. Returns the number of objects soft-deleted (deleted), which may be 0 when no live object matched the prefix on this branch.

Only objects physically present on this branch are tombstoned; objects inherited from an ancestor branch via copy-on-write (not materialized on this branch) are out of scope.

Note: This endpoint is currently in Beta.

Parameters

project_idstringpathrequired

The Neon project ID

pattern ^[a-z0-9-]{1,60}$

branch_idstringpathrequired

The Neon branch ID

pattern ^[a-z0-9-]{1,60}$

bucket_namestringpathrequired

The bucket name

maxLength 255 · minLength 1

prefixstringqueryrequired

The key prefix (folder) to delete. Must be non-empty and end with `/`. Every object on this branch whose key starts with this prefix is soft-deleted.

maxLength 1024 · minLength 1

Responses

objectBucketObjectsDeletePrefixResponse

deletedinteger · int64required

The number of objects soft-deleted under the prefix. 0 when no live object matched the prefix on this branch.

Example response

{
  "deleted": 0
}

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

branch_idrequiredpath parameter

bucket_namerequiredpath parameter

prefixrequiredquery parameter

curl -X DELETE 'https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects-by-prefix?prefix=string'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects-by-prefix?prefix=string', { method: 'DELETE' });
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects-by-prefix?prefix=string', { method: 'DELETE' });
console.log(await response.json());

import requests

response = requests.request("DELETE", "https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects-by-prefix?prefix=string")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "DELETE", "https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects-by-prefix?prefix=string", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects-by-prefix?prefix=string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "DELETE");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects-by-prefix?prefix=string"))
    .method("DELETE", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects-by-prefix?prefix=string")
request = Net::HTTPGenericRequest.new("DELETE", false, true, uri)
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.Delete, "https://console.neon.tech/api/v2/projects/string/branches/string/buckets/string/objects-by-prefix?prefix=string");
using var response = await client.SendAsync(request);

{
  "deleted": 0
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}