Skip to content
/
Create schedule

Create schedule

Request

Creates a schedule.

Security
ApiKeyAuth
Path
schedule_namestring(name)required
Bodyapplication/x-www-form-urlencoded
namestring(name)
cronstring or null(cron)
databasestring(name)required

database name

Example:"Alpha"
delayinteger or null, >= 0(delay)
Example:5
executing_user_idinteger(executing_user_id)
engine_versionstring(engine_version)

the version of the query engine for the query, can be a version release name (e.g 'stable') or version number (e.g '0.205')

Example:"stable"
pool_namestring

resource pool name

Example:"pool_1"
priorityinteger, [ -2 .. 2 ](priority)
Example:1
retry_limitinteger, [ 0 .. 32 ](retry_limit)
Example:3
querystring(query)required
resultstring

url of the result

timezonestring(timezone)
Example:"UTC"
typestring(type)required
curl -i -X POST \
  'https://api.treasuredata.com/v3/schedule/create/{schedule_name}' \
  -H 'Authorization: TD1 <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d name=string \
  -d cron=string \
  -d database=Alpha \
  -d delay=5 \
  -d executing_user_id=0 \
  -d engine_version=stable \
  -d pool_name=pool_1 \
  -d priority=1 \
  -d retry_limit=3 \
  -d query=string \
  -d result=string \
  -d timezone=UTC \
  -d type=string

Responses

OK

Bodyapplication/json
created_atstring(created_at)\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(([+-]\d{2...required

Datetime in ISO 8601 format (2020-12-31T11:22:33-05:00 or 2020-12-31T11:22:33Z for UTC)

Example:"2020-12-31T11:22:33Z"
cronstring or null(cron)required
databasename (string) or (string or null)(database)required
Any of:

database name

string(name)
delayinteger or null, >= 0(delay)required
Example:5
namestring(name)required
querystring(query)required
timezonestring(timezone)required
Example:"UTC"
typestring(type)required
user_namestring(user_name)required

user's full name or email

Example:"Treasure Data"
Response
{
  "created_at": "2020-12-31T11:22:33Z",
  "cron": "string",
  "database": "Alpha",
  "delay": 5,
  "name": "string",
  "query": "string",
  "timezone": "UTC",
  "type": "string",
  "user_name": "Treasure Data"
}