Sources

Get a source

Returns a source's name and mark. A source needs no item or key to be read, but you see only your own, those you claim and those of items you can read, unless you hold keys.manage.

GET
/sources/{source}

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path parameters

source*string

The source code, such as github. Percent-encode it as one path segment.

Response body

About errors

Returns the source.

application/json
  1. response

A source code with the name and mark it's shown by.

source*string

The source code, as items carry it in source.

name*string

The name to show for the source.

name_from*string

Where name comes from: set on the source, the app signed in under it, the label of the key that holds it, or the code itself.

Value in"set""app""key""code"
mark?string

The icon ID set for the source, from the same sets as a type's icon. Absent until someone sets one.

  • missing_required_field: source is missing.
  • validation_error: source is empty, padded, or over 200 characters excluding a leading restored:, or 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.

source_not_found: the source isn't your own or one you claim, and no item you can read carries it.

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/sources/string'
About errors
{  "source": "crm",  "name": "CRM sync",  "name_from": "key"}