Items

Trash an item

Moves the item, and every item a cascading edge such as parent-of reaches, to the trash. You can restore them until the retention window ends. Marfa then purges them.

DELETE
/items/{id}

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Path parameters

id*string

The ID of the item.

Query parameters

version?integer

The version you read. If the item has changed since, nothing is trashed. Leave it out to trash the item as it is.

Range1 <= value

Header parameters

Idempotency-Key?string

A 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.

Lengthlength <= 255
X-Marfa-Instance-Id?string

The 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.

Match^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Response body

About errors

Returns { "ok": true }. An item that a cascading edge took into the trash has trashed_by_cascade, and trashed_with names this item if you can read its type. The private local command must name version and gets the item's summary in place of this, with no content: id, type, version, name, source and created_at.

application/json
  1. response

Confirms that the request succeeded.

ok*true

Always true.

Value intrue
  • invalid_id: the ID is not a valid item ID.
  • edge_constraint_violation: an edge type on the item has cascade_on_delete: block, and such an edge exists.
  • missing_required_field: you are the private socket, and version is missing.
  • validation_error: the item is a live system.connection (end it with DELETE /owner/sign-ins/{id} first), or version is not a positive whole number.
application/json
  1. 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
  1. 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.grant names the missing grant.
application/json
  1. response

An error response.

error*

What went wrong.

  • item_not_found: no item has this ID, or its type is one you can't read. If the item is in the trash and you can read its type, details.trashed is true.
  • edge_not_found: a repeat under the Idempotency-Key would show an edge you can no longer read.
application/json
  1. response

An error response.

error*

What went wrong.

  • version_conflict: version is stale. current is the item now, and nothing is trashed.
  • idempotency_key_in_flight: a request with this Idempotency-Key is still running, and this one wrote nothing. Retry.
application/json
  1. response

A failed precondition on the item: the error and the item now.

error*

What went wrong.

current*

The item as it stands now.

contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.

application/json
  1. response

An error response.

error*

What went wrong.

request_too_large: the request body is larger than this instance accepts.

application/json
  1. 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
  1. 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
  1. 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
  1. 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
  1. 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
  1. response

An error response.

error*

What went wrong.

curl -X DELETE 'http://localhost:8600/items/string'
About errors
{  "ok": true}