Get the instance
Returns a description of the instance: its display name, instance_id, the release it runs, the contract version it speaks, the features it serves and the largest request body it takes. Needs no credential.
Returns the instance's description. A request whose Accept header prefers text/html gets an HTML page instead.
application/json- response
An instance: its identity, build, contract version, features and request size.
name*stringThe instance's display name. Defaults to Marfa.
version*stringThe release the instance runs, such as 0.0.14.
instance_id*stringUnique identifier for the instance. GET /config and an archive's manifest show the same value.
contract*integerThe contract version, the same number as this document's info.version. It stays at 0 until the first public release.
0 <= valuefeatures*array<string>The features the instance serves, such as items and webhooks.
max_request_bytes*integerThe largest body, in bytes, the instance takes in an ordinary JSON request. A larger one is answered 413 request_too_large. Bulk writes, blob uploads and a few other operations have their own limits.
1 <= valuevalidation_error: the query has a parameter this endpoint doesn't take.
application/json- 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- 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- response
An error response.
error*What went wrong.
curl -X GET 'http://localhost:8600'{ "name": "Marfa", "version": "0.0.0", "instance_id": "01a10127-86fe-728c-8cf8-38e902e15d4f", "contract": 0, "features": [ "items", "search", "blobs", "types", "keys", "bulk", "oauth", "owner", "extensions", "events", "type_crud", "audit", "edges", "connectors", "inbound_webhooks", "webhooks", "export", "metrics", "restore" ], "max_request_bytes": 1048576}