Plugins

List mapping previews

Returns the plugin's mapping previews that have not expired, oldest first. The connector lists the pending ones to find work. Needs connectors.manage, or the connector's own key.

GET
/plugins/{name}/connector/previews

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path parameters

name*string

The plugin's name.

Query parameters

status?string

Only return previews with this status.

Value in"pending""ready""failed"

Response body

About errors

Returns the previews.

application/json
  1. response

A plugin connector's mapping previews.

data*array<>

The previews that have not expired, oldest first.

next_cursor*null

Always null: a plugin holds at most 20 previews, all returned in one page.

  • validation_error: status is not pending, ready or failed, or 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.

forbidden: you don't have connectors.manage and aren't the connector's own key (details.required_scope).

application/json
  1. response

An error response.

error*

What went wrong.

  • plugin_not_found: no plugin of this name is installed.
  • plugin_connector_not_found: the plugin has no connector.
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.

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 GET 'http://localhost:8600/plugins/string/connector/previews'
About errors
{  "data": [    {      "id": "01a1fa40-3b2c-7d11-8e90-5a6b7c8d9e0f",      "kind": "entry",      "item_id": "01a1fa41-9d8e-7f10-b2c3-4d5e6f708192",      "mapping": null,      "status": "pending",      "result": null,      "error": null,      "created_at": "2026-10-03T09:30:00.000Z",      "expires_at": "2026-10-03T09:40:00.000Z",      "answered_at": null    }  ],  "next_cursor": null}