Folders

Revoke a folder

Revokes a folder: moves it to revoked, a terminal state, and sets revoked_at. The items placed in it keep their in-folder edges.

POST
/folders/{id}/revoke

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

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 the revoked folder and its metadata.

application/json
  1. response

An item with its metadata.

item*

The item.

metadata*

The item's metadata.

acknowledged?boolean

true when Marfa accepted a write and stored nothing: a create repeats an id you already created, its natural key matches a trashed item, or an update or upsert leaves the item as it is, so item is at the version it holds. Absent otherwise.

  • invalid_id: the ID is malformed.
  • invalid_transition: the folder is already revoked.
  • validation_error: the query has a parameter this endpoint doesn't take.
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 don't have write on system.folder.
application/json
  1. response

An error response.

error*

What went wrong.

  • item_not_found: no system.folder has this ID.
application/json
  1. response

An error response.

error*

What went wrong.

instance_changed: X-Marfa-Instance-Id names another instance. Nothing is written. Rebuild the working copy from the instance at this address.

application/json
  1. 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
  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 POST 'http://localhost:8600/folders/string/revoke'
About errors
{  "item": {    "id": "01a10122-54e3-7447-9e6f-91e7d99f361f",    "type": "system.folder",    "state": "revoked",    "tier": "library",    "created_at": "2026-10-03T09:57:30.610Z",    "updated_at": "2026-10-03T10:10:45.735Z",    "last_activity_at": "2026-10-03T10:10:45.735Z",    "occurred_at": "2026-10-03T09:57:30.610Z",    "source": "crm",    "version": 3,    "schema_version": 0,    "trashed_at": "2026-10-03T10:10:45.735Z",    "read_only": false,    "properties": {      "title": "Open deals",      "query": {        "types": [          "acme.deal"        ]      },      "defaults": {        "type": "acme.deal"      },      "revoked_at": "2026-10-03T10:10:45.735Z"    }  },  "metadata": {    "item_id": "01a10122-54e3-7447-9e6f-91e7d99f361f",    "tags": [],    "extensions": {}  }}