createDataSource

POST

/api/v1/data-sources

const url = 'https://example.com/api/v1/data-sources';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"provider":"calendar","name":"example","description":"example","configuration":{}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

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

application/json

object

provider

required

Non-visual Data Source providers.

string

Allowed values: calendar rss atom json csv manual weather transit cap_alerts air_quality

name

required

string

>= 1 characters <= 180 characters

description

string

<= 2000 characters

configuration

required

object

Responses

201

Data Source created

422

Provider configuration rejected

createDataSource

Request Bodyrequired

Responses

201

422

Request Body^required