Create Schedule

Creates a new schedule to run packages periodically.

POST /schedules

Create Schedule

cURL

curl --request POST \
  --url https://api.xplenty.com/{account_id}/api/schedules \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "start_at": "2023-11-07T05:31:56Z",
  "interval_amount": 123,
  "task": {
    "nodes": 123,
    "packages": [
      {
        "package_id": 123,
        "variables": {}
      }
    ]
  },
  "description": "<string>",
  "overlap": true,
  "reuse_cluster": true
}
'

201

{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "owner_id": 123,
  "start_at": "2023-11-07T05:31:56Z",
  "next_run_at": "2023-11-07T05:31:56Z",
  "interval_amount": 123,
  "task": {
    "nodes": 123,
    "packages": [
      {
        "package_id": 123,
        "variables": {}
      }
    ]
  },
  "overlap": true,
  "reuse_cluster": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "html_url": "<string>"
}

Authorizations

Authorization · string · header · required

Enter your API key as the username. Leave the password field blank. Example: curl -u YOUR_API_KEY: https://api.xplenty.com/...

Headers

Accept · string · default: application/vnd.xplenty+json; version=2 · required

API version header — required on all requests

Body

application/json

name · string · required

start_at · string<date-time> · required

interval_amount · integer · required

interval_unit · enum<string> · required

Available options: minutes, hours, days, weeks, months

task · object · required

Show child attributes

description · string

status · enum<string>

Available options: enabled, disabled

overlap · boolean

reuse_cluster · boolean

Response

201

application/vnd.xplenty+json; version=2

Schedule created

id · integer

name · string

description · string

status · enum<string>

Available options: enabled, disabled

owner_id · integer

start_at · string<date-time>

next_run_at · string<date-time> | null

interval_amount · integer

interval_unit · enum<string>

Available options: minutes, hours, days, weeks, months

task · object

Show child attributes

overlap · boolean

reuse_cluster · boolean

created_at · string<date-time>

updated_at · string<date-time>

url · string<uri>

html_url · string<uri>