Skip to content

Source configuration

Name data sources, reference stored vendor credentials, and control credential resolution

config.sources names each source to run and tells Data Serve which vendor credential to use.

Source identifiers

Code
<provider>__<source>

Both parts are lowercase, spaces become underscores, and the separator is two underscores. Provider punctuation remains. IP-Api and Geolocation become ip-api__geolocation.

Unknown identifiers return HTTP 200 with Adapter not found for <identifier> in status; other sources continue.

Confirmation needed: Confirm whether available source identifiers are public or account-specific. A public list needs a separate maintained page.

Configuration values

Value Meaning
true Run without a credential reference
{} Same as true
{ "credentials": { "cred_id": "<id>" } } Use the named stored credential
JSON
{
  "sources": {
    "ip-api__geolocation": true,
    "dsmock__person_alpha": {},
    "vendor__product": {
      "credentials": { "cred_id": "crd_01k9j3bfxjedvvtq3jx43y8q8d" }
    }
  }
}

Any other value returns HTTP 422. This includes false, a null credentials value, keys other than credentials inside a source object, and keys other than cred_id inside credentials.

Credentials

Stored credential

JSON
{
  "sources": {
    "vendor__product": {
      "credentials": { "cred_id": "crd_01k9j3bfxjedvvtq3jx43y8q8d" }
    }
  }
}

cred_id names a credential stored for your organization. Data Serve does not accept credential values such as a username or password in the request.

No credential

If no cred_id is supplied and no credential is auto-selected, the source runs without a credential. A source that requires one then fails credential validation. In /data, its status entry reports the failure and other sources continue.

Resolution order

  1. The stored credential named by cred_id.
  2. For /func only, when the workflow enables credential auto-selection: the organization’s stored credential for the source that matches config.context. prod selects a production credential; test and dev select a test credential.
  3. No credential.

/data does not auto-select credentials. See Run a data function.

A cred_id that cannot be resolved fails only that source.

Credential validation

Resolved credentials are filtered to declared source fields and validated against the source credential schema. A missing required field fails only that source.

Confirmation needed: Confirm the exact public wording of the missing-credential status message before clients rely on the example text.

Security

Requests carry credential references, not credential values. Stored credential values do not appear in responses or transaction records.