Connectors

Report a connector run

Reports one run of the connector, with its outcome and times, and returns it. Marfa keeps the last 100 runs and drops older ones.

POST
/connectors/{id}/runs

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

Header parameters

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}$

Request body

application/json
  1. body
outcome*string

How the run ended: succeeded or failed.

Value in"succeeded""failed"
started_at*string

When the run started, as an ISO 8601 time. Marfa converts it to UTC. A time with no offset is read as UTC.

finished_at*string

When the run finished, as an ISO 8601 time. Marfa converts it to UTC. It can't be before started_at.

summary?string

A short summary of the run. Leave it out for none.

Lengthlength <= 2000
error?string

The error the run hit. Leave it out for none.

Lengthlength <= 2000

Response body

About errors

Returns the run.

application/json
  1. response

A run a connector reported, with its outcome and times.

id*string

Unique identifier for the run.

connector_id*string

The ID of the connector that reported the run.

outcome*string

How the run ended: succeeded or failed.

Value in"succeeded""failed"
started_at*string

When the run started, in UTC.

finished_at*string

When the run finished, in UTC.

summary*|

A short summary of the run; null if none was reported.

error*|

The error the run reported; null if none was reported.

reported_at*string

When Marfa recorded the run.

  • missing_required_field: outcome, started_at or finished_at is missing.
  • validation_error: outcome isn't succeeded or failed, a time isn't a timestamp, finished_at is before started_at, summary or error is over 2,000 characters, or the body has a top-level field 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: your credential isn't the key the connector is registered under. Only that key reports its runs, and management permission does not authorize it.
application/json
  1. response

An error response.

error*

What went wrong.

  • connector_not_found: no connector has this ID.
application/json
  1. response

An error response.

error*

What went wrong.

request_timeout: the request body didn't arrive whole within 180 seconds. Nothing changed, and Marfa closed the connection. Send the request again. A body larger than about 21 MiB can't arrive in that time over a 1 Mbit/s link, so send it in smaller requests.

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.

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/connectors/string/runs' \  -H 'Content-Type: application/json' \  -d '{  "outcome": "succeeded",  "started_at": "string",  "finished_at": "string"}'
About errors
{  "id": "01a10123-bdde-7e38-9f8d-1daf2fa80822",  "connector_id": "01a10123-4825-7ff1-8fde-fb30a676e02b",  "outcome": "succeeded",  "started_at": "2026-10-03T09:31:00.022Z",  "finished_at": "2026-10-03T09:32:00.991Z",  "summary": "Synced 14 deals",  "error": null,  "reported_at": "2026-10-03T10:04:55.291Z"}