POST
/
v1
/
admin
/
reap
Reap orphaned box artifacts and box-owned data volumes on demand.
curl --request POST \
  --url https://api.example.com/v1/admin/reap
import requests

url = "https://api.example.com/v1/admin/reap"

response = requests.post(url)

print(response.text)
const options = {method: 'POST'};

fetch('https://api.example.com/v1/admin/reap', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/admin/reap",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v1/admin/reap"

req, _ := http.NewRequest("POST", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v1/admin/reap")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/admin/reap")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
{
  "errors": [
    "<string>"
  ],
  "reaped": [
    {
      "artifacts": [
        "<string>"
      ],
      "box_name": "<string>",
      "project": "<string>"
    }
  ],
  "skipped_in_flight": [
    "<string>"
  ]
}

Query Parameters

dry_run
boolean

Report what would be reaped without deleting anything (default: false).

Response

Reaper pass completed

The outcome of one reaper pass.

errors
string[]
required

Per-artifact failures. One failure never aborts the pass.

reaped
object[]
required

Boxes whose orphaned artifacts were reaped (or, in dry_run, would be).

skipped_in_flight
string[]
required

"project/box" for each candidate left alone because a fresh in-flight create/clone marker still owns it.