Skip to main content
POST
/
tasks
/
scheduled
Create a scheduled task
curl --request POST \
  --url https://api.cloud.flexprice.io/v1/tasks/scheduled \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "connection_id": "<string>",
  "enabled": true,
  "entity_type": "events",
  "interval": "custom",
  "job_config": {
    "bucket": "<string>",
    "compression": "none",
    "encryption": "AES256",
    "key_prefix": "<string>",
    "region": "<string>"
  }
}'
{
  "connection_id": "<string>",
  "created_at": "<string>",
  "enabled": true,
  "entity_type": "events",
  "environment_id": "<string>",
  "id": "<string>",
  "interval": "custom",
  "job_config": {
    "bucket": "<string>",
    "compression": "none",
    "encryption": "AES256",
    "key_prefix": "<string>",
    "region": "<string>"
  },
  "status": "<string>",
  "tenant_id": "<string>",
  "updated_at": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Scheduled Task

​
connection_id
string
required
​
entity_type
enum<string>
required
Available options:
events,
invoice
​
interval
enum<string>
required
Available options:
custom,
hourly,
daily
​
job_config
object
required
​
enabled
boolean

Response

Created

​
connection_id
string
​
created_at
string
​
enabled
boolean
​
entity_type
enum<string>
Available options:
events,
invoice
​
environment_id
string
​
id
string
​
interval
enum<string>
Available options:
custom,
hourly,
daily
​
job_config
object
​
status
string
​
tenant_id
string
​
updated_at
string
⌘I