Purge an item
Permanently deletes a trashed item with its edges, metadata and extensions. Requires items.purge and write on the item's type. Marfa keeps a tombstone of the item's link and natural key, which POST /items/lookup reads.
bearerAuthAuthorizationBearer <token>Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).
id*stringThe ID of the item.
version?integerThe version you read. If the item has changed since, nothing is deleted. Trashing doesn't change the version, so send the one you read before the trash.
1 <= valueIdempotency-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}$Returns { "ok": true }. Marfa announces each edge it deletes as edge.deleted, with purged_with naming this item. 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- response
Confirms that the request succeeded.
ok*trueAlways true.
trueinvalid_id: the ID is not a valid item ID.invalid_transition: the item is not in the trash.missing_required_field: you are the private socket, andversionis missing.validation_error: the item is a livesystem.connection(end it withDELETE /owner/sign-ins/{id}first), orversionis not a positive whole number.
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.
forbidden: you don't haveitems.purge, or the item is in a reserved namespace and is not in the trash.type_not_permitted: you can read the item's type but don't have write on it, or your credential reaches no type.
application/json- response
An error response.
error*What went wrong.
item_not_found: no item has this ID, including one already purged, or its type is one you can't read.
application/json- response
An error response.
error*What went wrong.
version_conflict:versionis stale.currentis the item now, and nothing is purged.idempotency_key_in_flight: a request with thisIdempotency-Keyis still running, and this one wrote nothing. Retry.
application/json- 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- 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/string/purge'{ "ok": true}