Stream Create

Creates a new data stream using a connector and specifies configuration details

POST /api/data/v1/streams

http

http

POST /api/data/v1/streams HTTP/1.1
Host: {instance}.domo.com
X-DOMO-Developer-Token: {token}
Content-Type: application/json

{
  "transport": {
    "type": "CONNECTOR",
    "description": "com.domo.connector.snowflakeunloadv2",
    "version": "1"
  },
  "configuration": [
    {
      "name": "query",
      "value": "SELECT * FROM table",
      "type": "string",
      "category": "METADATA"
    }
  ],
  "account": {
    "id": 3
  },
  "updateMethod": "APPEND",
  "dataProvider": {
    "key": "snowflake-unload-v2"
  },
  "dataSource": {
    "name": "hello world",
    "description": "config works?"
  },
  "advancedScheduleJson": "{\"type\": \"MANUAL\", \"timezone\": \"UTC\"}"
}

curl --request POST \
  --url https://{instance}.domo.com/api/data/v1/streams \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "transport": {
    "type": "CONNECTOR",
    "description": "com.domo.connector.snowflakeunloadv2",
    "version": "1"
  },
  "configuration": [
    {
      "name": "query",
      "value": "SELECT * FROM table",
      "type": "string",
      "category": "METADATA"
    }
  ],
  "account": {
    "id": 3
  },
  "updateMethod": "APPEND",
  "dataProvider": {
    "key": "snowflake-unload-v2"
  },
  "dataSource": {
    "name": "hello world",
    "description": "config works?"
  },
  "advancedScheduleJson": "{\"type\": \"MANUAL\", \"timezone\": \"UTC\"}"
}
'

import requests

url = "https://{instance}.domo.com/api/data/v1/streams"

payload = {
    "transport": {
        "type": "CONNECTOR",
        "description": "com.domo.connector.snowflakeunloadv2",
        "version": "1"
    },
    "configuration": [
        {
            "name": "query",
            "value": "SELECT * FROM table",
            "type": "string",
            "category": "METADATA"
        }
    ],
    "account": { "id": 3 },
    "updateMethod": "APPEND",
    "dataProvider": { "key": "snowflake-unload-v2" },
    "dataSource": {
        "name": "hello world",
        "description": "config works?"
    },
    "advancedScheduleJson": "{\"type\": \"MANUAL\", \"timezone\": \"UTC\"}"
}
headers = {
    "X-DOMO-Developer-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-DOMO-Developer-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    transport: {
      type: 'CONNECTOR',
      description: 'com.domo.connector.snowflakeunloadv2',
      version: '1'
    },
    configuration: [
      {
        name: 'query',
        value: 'SELECT * FROM table',
        type: 'string',
        category: 'METADATA'
      }
    ],
    account: {id: 3},
    updateMethod: 'APPEND',
    dataProvider: {key: 'snowflake-unload-v2'},
    dataSource: {name: 'hello world', description: 'config works?'},
    advancedScheduleJson: '{"type": "MANUAL", "timezone": "UTC"}'
  })
};

fetch('https://{instance}.domo.com/api/data/v1/streams', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.domo.com/api/data/v1/streams",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'transport' => [
        'type' => 'CONNECTOR',
        'description' => 'com.domo.connector.snowflakeunloadv2',
        'version' => '1'
    ],
    'configuration' => [
        [
                'name' => 'query',
                'value' => 'SELECT * FROM table',
                'type' => 'string',
                'category' => 'METADATA'
        ]
    ],
    'account' => [
        'id' => 3
    ],
    'updateMethod' => 'APPEND',
    'dataProvider' => [
        'key' => 'snowflake-unload-v2'
    ],
    'dataSource' => [
        'name' => 'hello world',
        'description' => 'config works?'
    ],
    'advancedScheduleJson' => '{"type": "MANUAL", "timezone": "UTC"}'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-DOMO-Developer-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.domo.com/api/data/v1/streams"

	payload := strings.NewReader("{\n  \"transport\": {\n    \"type\": \"CONNECTOR\",\n    \"description\": \"com.domo.connector.snowflakeunloadv2\",\n    \"version\": \"1\"\n  },\n  \"configuration\": [\n    {\n      \"name\": \"query\",\n      \"value\": \"SELECT * FROM table\",\n      \"type\": \"string\",\n      \"category\": \"METADATA\"\n    }\n  ],\n  \"account\": {\n    \"id\": 3\n  },\n  \"updateMethod\": \"APPEND\",\n  \"dataProvider\": {\n    \"key\": \"snowflake-unload-v2\"\n  },\n  \"dataSource\": {\n    \"name\": \"hello world\",\n    \"description\": \"config works?\"\n  },\n  \"advancedScheduleJson\": \"{\\\"type\\\": \\\"MANUAL\\\", \\\"timezone\\\": \\\"UTC\\\"}\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-DOMO-Developer-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{instance}.domo.com/api/data/v1/streams")
  .header("X-DOMO-Developer-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"transport\": {\n    \"type\": \"CONNECTOR\",\n    \"description\": \"com.domo.connector.snowflakeunloadv2\",\n    \"version\": \"1\"\n  },\n  \"configuration\": [\n    {\n      \"name\": \"query\",\n      \"value\": \"SELECT * FROM table\",\n      \"type\": \"string\",\n      \"category\": \"METADATA\"\n    }\n  ],\n  \"account\": {\n    \"id\": 3\n  },\n  \"updateMethod\": \"APPEND\",\n  \"dataProvider\": {\n    \"key\": \"snowflake-unload-v2\"\n  },\n  \"dataSource\": {\n    \"name\": \"hello world\",\n    \"description\": \"config works?\"\n  },\n  \"advancedScheduleJson\": \"{\\\"type\\\": \\\"MANUAL\\\", \\\"timezone\\\": \\\"UTC\\\"}\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.domo.com/api/data/v1/streams")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"transport\": {\n    \"type\": \"CONNECTOR\",\n    \"description\": \"com.domo.connector.snowflakeunloadv2\",\n    \"version\": \"1\"\n  },\n  \"configuration\": [\n    {\n      \"name\": \"query\",\n      \"value\": \"SELECT * FROM table\",\n      \"type\": \"string\",\n      \"category\": \"METADATA\"\n    }\n  ],\n  \"account\": {\n    \"id\": 3\n  },\n  \"updateMethod\": \"APPEND\",\n  \"dataProvider\": {\n    \"key\": \"snowflake-unload-v2\"\n  },\n  \"dataSource\": {\n    \"name\": \"hello world\",\n    \"description\": \"config works?\"\n  },\n  \"advancedScheduleJson\": \"{\\\"type\\\": \\\"MANUAL\\\", \\\"timezone\\\": \\\"UTC\\\"}\"\n}"

response = http.request(request)
puts response.read_body

Authorizations

X-DOMO-Developer-Token · string · header · required

Developer token obtained from Domo

Body

application/json

transport · object · required

Show child attributes

configuration · object[] · required

Show child attributes

account · object · required

Show child attributes

updateMethod · enum<string> · required

Available options: APPEND, REPLACE

dataProvider · object · required

Show child attributes

dataSource · object · required

Show child attributes

advancedScheduleJson · string

Response

200

Stream created successfully