Plugins

Get a plugin

Returns an installed plugin, with the types it installed.

GET
/plugins/{name}

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.

Response body

About errors

Returns the plugin.

application/json
  1. response

An installed plugin.

name*string

The plugin's name: lowercase words and numbers joined by hyphens.

Match^[a-z][a-z0-9]*(-[a-z0-9]+)*$
Lengthlength <= 64
title*string

The name people see for the plugin.

Length1 <= length <= 100
description*string

What the plugin adds, in a sentence.

Length1 <= length <= 300
mark*string

The icon the plugin is shown by, an Iconify icon ID.

maker*string

Who made the plugin.

Length1 <= length <= 64
marfa*string

The oldest Marfa release the plugin works with.

Match^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$
version*string

The plugin's version. 0.0.0 is a bundle built from a source folder with no version.

Match^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$
types*array<string>

The IDs of the types the plugin installed, at any version.

edge_types*array<string>

The IDs of the edge types any installed version of the plugin brought that the instance still holds.

connector*|

The installed version's connector, as its bundle gave it, or null.

connector_host*|

The ID of the connector host the plugin's connector is assigned to, or null.

fingerprint*string

The SHA-256 of the bundle's bytes as the install that wrote this version received them, in lowercase hexadecimal.

Match^[0-9a-f]{64}$
installed_at*string

When the plugin was first installed.

Formatdate-time
installed_by*|

The sign-in that first installed the plugin, or null when it is not known.

updated_at*string

When the installed version last changed.

Formatdate-time
  • 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.

plugin_not_found: no plugin of this name is installed.

application/json
  1. response

An error response.

error*

What went wrong.

reach_changed: the reach in X-Marfa-Reach has changed. Rebuild the working copy.

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'
About errors
{  "name": "tickets",  "title": "Tickets",  "description": "Tickets for tracking work.",  "mark": "lucide:ticket",  "maker": "Marfa",  "marfa": "0.0.90",  "version": "1.2.0",  "types": [    "common.ticket",    "common.ticket.spike"  ],  "edge_types": [    "blocks"  ],  "connector": null,  "connector_host": null,  "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",  "installed_at": "2026-11-21T10:00:00.000Z",  "installed_by": {    "kind": "key",    "id": "01a1011b-b5e5-7be6-8f3b-77492475b5a4",    "name": "laptop"  },  "updated_at": "2026-11-21T12:00:00.000Z"}