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
}
'

import requests

url = "https://api.xplenty.com/{account_id}/api/schedules"

payload = {
    "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
}
headers = {
    "Accept": "<accept>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Accept: '<accept>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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
  })
};

fetch('https://api.xplenty.com/{account_id}/api/schedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.xplenty.com/{account_id}/api/schedules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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
  ]),
  CURLOPT_HTTPHEADER => [
    "Accept: <accept>",
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.xplenty.com/{account_id}/api/schedules"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"start_at\": \"2023-11-07T05:31:56Z\",\n  \"interval_amount\": 123,\n  \"task\": {\n    \"nodes\": 123,\n    \"packages\": [\n      {\n        \"package_id\": 123,\n        \"variables\": {}\n      }\n    ]\n  },\n  \"description\": \"<string>\",\n  \"overlap\": true,\n  \"reuse_cluster\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Accept", "<accept>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.xplenty.com/{account_id}/api/schedules")
  .header("Accept", "<accept>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"start_at\": \"2023-11-07T05:31:56Z\",\n  \"interval_amount\": 123,\n  \"task\": {\n    \"nodes\": 123,\n    \"packages\": [\n      {\n        \"package_id\": 123,\n        \"variables\": {}\n      }\n    ]\n  },\n  \"description\": \"<string>\",\n  \"overlap\": true,\n  \"reuse_cluster\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.xplenty.com/{account_id}/api/schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"start_at\": \"2023-11-07T05:31:56Z\",\n  \"interval_amount\": 123,\n  \"task\": {\n    \"nodes\": 123,\n    \"packages\": [\n      {\n        \"package_id\": 123,\n        \"variables\": {}\n      }\n    ]\n  },\n  \"description\": \"<string>\",\n  \"overlap\": true,\n  \"reuse_cluster\": true\n}"

response = http.request(request)
puts response.read_body

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>"
}

{
  "message": "Item not found."
}

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>