createDataSource

POST

/api/v1/data-sources

curl --request POST \
  --url https://example.com/api/v1/data-sources \
  --header 'Content-Type: application/json' \
  --data '{ "provider": "example", "name": "example", "description": "example", "configuration": {} }'

Requires an authenticated dashboard session. Creates a reusable provider-neutral Data Source. Supported providers include calendar, structured feeds, Manual Table, Weather, Transit, CAP Alerts, and Air Quality. Data Sources are not assets and cannot be placed in playlists or Layouts.

Request Body^required

Media typeapplication/json

object

provider

required

Built-in provider, definition provider, or an installed plugin’s provider. The Server resolves it against the live registry.

string

name

required

string

>= 1 characters <= 180 characters

description

string

<= 2000 characters

configuration

required

object

key

additional properties

any

Example^generated

{
  "provider": "example",
  "name": "example",
  "description": "example",
  "configuration": {}
}

Responses

201

Data Source created

Media typeapplication/json

object

data

required

Stored Data Source as the mutations return it: no refresh status, diagnostics, or usage. The provider is an open string because definition and plugin providers extend the built-in registry.

object

id

required

string format: uuid

provider

required

string

name

required

string

description

required

string

configVersion

required

integer

>= 1

configuration

required

object

key

additional properties

any

creator

object

id

required

string format: uuid

name

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example^generated

{
  "data": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "provider": "example",
    "name": "example",
    "description": "example",
    "configVersion": 1,
    "configuration": {},
    "creator": {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example"
    },
    "createdAt": "2026-04-15T12:00:00Z",
    "updatedAt": "2026-04-15T12:00:00Z"
  }
}

422

Provider configuration rejected