Trash items
Moves the items, and every item a cascading edge such as parent-of reaches from them, to the trash in one step, all of them or none of them. You can restore them until the retention window ends. Marfa then purges them.
bearerAuthAuthorizationBearer <token>Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).
Idempotency-Key?stringA unique key that makes the request safe to retry. If you send the same request with the same key again, Marfa returns the first response and doesn't write again. A key belongs to the credential that sends it.
length <= 255X-Marfa-Instance-Id?stringThe ID of the instance you expect, as GET / returns it. If another instance answers at this address, Marfa returns 409 instance_changed and doesn't write. Leave it out to send the request to whichever instance answers.
^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$application/json- body
ids*array<string>The IDs of the items to trash, at most 20.
1 <= items <= 20digest?stringThe digest from POST /items/trash-preview for the same ids. If what the trash would take has changed since, nothing is trashed. Leave it out to trash what the items take now.
^[0-9a-f]{64}$Returns { "ok": true }. An item that a cascading edge took into the trash has trashed_by_cascade, and trashed_with names the named item that took it if you can read its type.
application/json- response
Confirms that the request succeeded.
ok*trueAlways true.
trueinvalid_id: an ID inidsis not an item ID.missing_required_field:idsis missing.edge_constraint_violation: acascade_on_delete: blockedge holds a named item or one its trash would take.validation_error: a named item is a livesystem.connection,idsis empty or has over 20 IDs,digestis not a SHA-256 hash in hex, or the body has a field this endpoint doesn't take.
application/json- response
An error response.
error*What went wrong.
unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.
application/json- response
An error response.
error*What went wrong.
type_not_permitted: you can read the item's type but don't have write on it, or your credential reaches no type.details.grantnames the missing grant.
application/json- response
An error response.
error*What went wrong.
item_not_found: an ID inidsnames no item, or names an item whose type you can't read. If that item is in the trash and you can read its type,details.trashedistrue.
application/json- response
An error response.
error*What went wrong.
request_timeout: the request body didn't arrive whole within 180 seconds. Nothing changed, and Marfa closed the connection. Send the request again. A body larger than about 21 MiB can't arrive in that time over a 1 Mbit/s link, so send it in smaller requests.
application/json- response
An error response.
error*What went wrong.
trash_plan_changed: what the trash would take no longer matchesdigest.details.digestis the digest now, and nothing is trashed.
application/json- response
An error response.
error*What went wrong.
contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.
application/json- response
An error response.
error*What went wrong.
request_too_large: the request body is larger than this instance accepts.
application/json- response
An error response.
error*What went wrong.
idempotency_contract_changed: the first response was made under another contract version, so Marfa can't replay it. The write isn't repeated.idempotency_key_reused: the key was first used for a different request. Nothing is written.idempotency_result_not_retained: the first response was too large to keep, so Marfa can't replay it. The write isn't repeated.
application/json- response
An error response.
error*What went wrong.
rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.
application/json- response
An error response.
error*What went wrong.
internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.
application/json- response
An error response.
error*What went wrong.
write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.
application/json- response
An error response.
error*What went wrong.
insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.
application/json- response
An error response.
error*What went wrong.
curl -X POST 'http://localhost:8600/items/trash' \ -H 'Content-Type: application/json' \ -d '{ "ids": [ "string" ]}'{ "ok": true}