Types

List types

Returns every type on this instance: those Marfa ships and those registered through POST /types. Every credential reads the whole list, whatever its type map reaches.

GET
/types

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Header parameters

X-Marfa-Reach?string

The reach from a copy stream, for a working copy. Marfa reads the current data and checks the reach in one snapshot, and returns 409 reach_changed if it has changed. Leave it out for an ordinary read.

Match^[0-9a-f]{64}$
Length64 <= length <= 64

Response body

About errors

Returns every type. A type lists only its own fields, so resolve the rest through parent.

application/json
  1. response

A page holding every type.

data*array<>

Every type.

next_cursor*|

Always null: Marfa returns every type in one page.

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

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/types'
About errors
{  "data": [    {      "id": "acme.contact",      "label": "Contact",      "version": 0,      "fields": {        "name": {          "type": "string",          "label": "Name",          "required": true        }      },      "display_hints": {        "title_field": "name"      },      "plural": "Contacts",      "own_roles": [],      "provenance": {        "origin": "user",        "created_by": {          "kind": "key",          "id": "01a1011b-b5e5-7be6-8f3b-77492475b5a4",          "name": "CRM sync"        }      }    },    {      "id": "acme.deal",      "label": "Deal",      "version": 0,      "fields": {        "name": {          "type": "string",          "label": "Name",          "required": true        },        "amount": {          "type": "number",          "label": "Amount"        },        "stage": {          "type": "enum",          "label": "Stage",          "enum_values": [            "lead",            "won",            "lost"          ]        }      },      "display_hints": {        "title_field": "name"      },      "description": "A sales deal.",      "plural": "Deals",      "own_roles": [],      "provenance": {        "origin": "user",        "created_by": {          "kind": "key",          "id": "01a1011b-b5e5-7be6-8f3b-77492475b5a4",          "name": "CRM sync"        }      }    }  ],  "next_cursor": null}