data-sources

Create a data source

Connect a data feed with a name, a connector type, a config, and an optional nodeId. Any credentials included in config are encrypted at rest. Test the configuration first with POST /v1/data-sources/test before creating it.

Notes.

  • Gated by integration.edit, not integration.create.
post/v1/data-sources

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/data-sources
  • Auth: HTTP bearer

Request body

namestring required
typestring required

Connector type from GET /v1/connectors. The value is not checked here: an unknown type fails at the first sync.

configobject

Connector settings (JSON). The keys depend on type. Credentials are encrypted at rest and every later read shows them as ••••••••.

nodeIdstring nullable

Home location; null or absent = workspace root. The key needs the permission there.

Response

Success.

Example response

{
  "data": {
    "id": "ds_6f7a8b9c0d1e2f3a"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.