Skip to content

Update bulk load session

Request

Updates a specified bulk load session.

Security
ApiKeyAuth
Path
bulk_load_session_namestring(name)required
Bodyapplication/x-www-form-urlencoded
idinteger(BulkLoadSessionId)
Example:43
namestring
cronstring or null
timezonestring(Timezone)
Example:"UTC"
delayinteger
start_at(string or null) or DateTimeISO8601 (string)
Any of:
string or null
databasestring(name)

database name

Example:"Alpha"
tablestring(name)
Example:"Bravo"
configobject(BulkLoadConfig)

bulk load config

config_diffobject
curl -i -X PUT \
  'https://api.treasuredata.com/v3/bulk_loads/{bulk_load_session_name}' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d id=43 \
  -d name=string \
  -d cron=string \
  -d timezone=UTC \
  -d delay=0 \
  -d start_at=string \
  -d database=Alpha \
  -d table=Bravo \
  -d 'config={"in":{"connection_prop":"connection_prop","connection_secret":"secret","basic_prop":"basic","basic_secret":"secret","advanced_prop":"advanced","advanced_secret":"secret","type":"some_type","td_authentication_id":1234},"filters":[{}],"exec":{"type":"some_type","basic_prop":"basic","secret_prop":"secret"},"out":{"type":"some_type","mode":"mode","plazma_dataset":"plazma","time_column":"time"}}' \
  -d 'config_diff={}'

Responses

OK

Bodyapplication/json
idinteger(BulkLoadSessionId)
Example:43
namestring
cronstring or null
timezonestring(Timezone)
Example:"UTC"
delayinteger
start_at(string or null) or DateTimeISO8601 (string)
Any of:
string or null
databasestring(name)

database name

Example:"Alpha"
tablestring(name)
Example:"Bravo"
configobject(BulkLoadConfig)

bulk load config

config_diffobject
Response
{ "id": 43, "name": "string", "cron": "string", "timezone": "UTC", "delay": 0, "start_at": "string", "database": "Alpha", "table": "Bravo", "config": { "in": { … }, "filters": [ … ], "exec": { … }, "out": { … } }, "config_diff": {} }