Instance

List the settings

Returns every stored setting with its value, default and rule, the rules across settings, and the settings only the environment sets. Requires config.manage or instance.read.

GET
/config/settings

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Response body

About errors

Returns the settings.

application/json
  1. response

Every setting Marfa has: the stored ones, the rules across them and the ones only the environment sets.

data*array<>

Every stored setting.

rules*array<>

Every rule that holds across settings.

start_only*array<>

Every setting only the environment sets.

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

  • forbidden: you hold neither config.manage nor instance.read. details.required_scope names instance.read.
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/config/settings'
About errors
{  "data": [    {      "key": "max_request_bytes",      "description": "The largest request body the server accepts, in bytes. The server waits 180 seconds for a body, so a body larger than about 21 MiB can't arrive in time over a 1 Mbit/s link.",      "value": 1048576,      "default": 1048576,      "stored": null,      "rule": "A whole number, from 1 to 1099511627776",      "together": [],      "secret": false    },    {      "key": "max_bulk_request_bytes",      "description": "The largest body the bulk operations accept, in bytes. A restore refuses a row larger than this. It may be set to at most 33554432, half of the 67108864 bytes a restore reads on one archive line. An export or backup refuses an item, version or edge whose line passes that limit, and names it. The server waits 180 seconds for a body, so a body larger than about 21 MiB can't arrive in time over a 1 Mbit/s link.",      "value": 16777216,      "default": 16777216,      "stored": null,      "rule": "A whole number, from 1 to 33554432",      "together": [],      "secret": false    }  ],  "rules": [    {      "name": "version_windows",      "description": "The recent, daily and weekly version windows must not shrink in that order.",      "keys": [        "version_recent_days",        "version_daily_snapshot_days",        "version_weekly_snapshot_days"      ]    },    {      "name": "reporting_needs_a_receiver",      "description": "Error reporting and the heartbeat can be turned from off to on only where a receiver is set: posthog_host with posthog_project_token, and heartbeat_url.",      "keys": [        "error_reporting_enabled",        "heartbeat_enabled"      ]    }  ],  "start_only": [    {      "name": "MARFA_PORT",      "description": "The port the server listens on.",      "secret": false,      "set": true    },    {      "name": "MARFA_LISTEN_HOST",      "description": "The address the server listens on.",      "secret": false,      "set": true    }  ]}