Skip to main content
POST
/
api
/
data
/
v1
/
streams
/
{streamId}
/
executions
Run a Connector
curl --request POST \
  --url https://example.com/v1/api/data/v1/streams/{streamId}/executions \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "runType": "MANUAL"
}
'
{
  "streamId": 123,
  "executionId": 123,
  "toe": "<string>",
  "startedAt": 123,
  "endedAt": 123,
  "updateMethod": "<string>",
  "index": true,
  "retryCount": 123,
  "retryExecution": {},
  "containerManagerId": "<string>",
  "uploadId": {},
  "indexRequestKey": {},
  "currentState": "<string>",
  "runType": "<string>",
  "createdAt": {},
  "modifiedAt": {},
  "latestPhase": {},
  "currentPhase": {},
  "removed": true,
  "rowsInserted": 123,
  "bytesInserted": 123,
  "startedBy": "<string>",
  "cancelledBy": {},
  "dataTag": {},
  "peakMemoryUsedBytes": {},
  "peakMemoryCommittedBytes": {},
  "exportable": true,
  "manualIndex": true,
  "errors": [
    "<unknown>"
  ]
}

Authorizations

X-DOMO-Developer-Token
string
header
required

Domo Developer Token for authentication (as seen in example).

Path Parameters

streamId
string
required

The streamId of the Dataset associated with the connector to run.

Example:

"25775"

Body

application/json
runType
enum<string>
required

The type of connector run.

Available options:
MANUAL

Response

CREATED. The connector run has started.

Response details for a started connector execution.

streamId
integer
executionId
integer
toe
string
startedAt
number<double>
endedAt
number<double> | null
updateMethod
string
index
boolean
retryCount
integer
retryExecution
object
containerManagerId
string
uploadId
object
indexRequestKey
object
currentState
string
runType
string
createdAt
object
modifiedAt
object
latestPhase
object
currentPhase
object
removed
boolean
rowsInserted
integer
bytesInserted
integer
startedBy
string
cancelledBy
object
dataTag
object
peakMemoryUsedBytes
object
peakMemoryCommittedBytes
object
exportable
boolean
manualIndex
boolean
errors
any[]