Event

GET

schedule

{id}

Event

curl --request GET \
  --url http://localhost:44442/api/v1/schedule/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:44442/api/v1/schedule/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "44442",
  CURLOPT_URL => "http://localhost:44442/api/v1/schedule/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://localhost:44442/api/v1/schedule/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:44442/api/v1/schedule/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "name": "<string>",
  "description": "",
  "color": "",
  "enabled": true,
  "starts_at": "<string>",
  "days": [],
  "action": {
    "kind": "command",
    "type": "node.suspend"
  },
  "targets": {
    "all": false,
    "types": [],
    "pools": [],
    "groups": [],
    "tags": [],
    "nodes": []
  },
  "last_commands": [],
  "history": [],
  "created_at": 123,
  "updated_at": 123,
  "ends_at": "<string>",
  "every": "<string>",
  "monthday": 123,
  "nth": 123,
  "until": "<string>",
  "rule": "<string>",
  "open_since": 123,
  "last_fired_at": 123,
  "last_occurrence": 123,
  "last_dispatch": "ok",
  "last_error": "<string>",
  "last_outcome": "ok",
  "next_run_at": 123
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

An API key from Settings, API Keys. A caller on this machine needs none.

Path Parameters

string

required

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

Response

The event

string

required

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

name

string

required

description

string

default:""

required

color

string

default:""

required

enabled

boolean

default:true

required

starts_at

string

required

ISO 8601, read in the server's own zone. The only place the event's time-of-day lives

days

enum<string>[]

required

Weekdays it may fall on, narrowing the cadence. Weekdays-only is ["mo","tu","we","th","fr"]

Available options:

mo,

tu,

we,

th,

fr,

sa,

su

action

object

required

Option 1
Option 2

Show child attributes

Example:

{ "kind": "command", "type": "node.suspend" }

targets

object

required

Show child attributes

last_commands

string[]

required

The commands the last fire created

history

object[]

required

Show child attributes

created_at

number

required

updated_at

number

required

ends_at

string | null

When the window closes, or null for a moment rather than a window. The event reverses itself there. A suspend resumes, a spawner stop starts. So an action with no reverse cannot have one. A time-of-day at or before starts_at crosses midnight. Not until: this is when tonight's window shuts.

every

string | null

How often it repeats: 15m, 1h, 1d, 2w, 1 month. Null fires once. With no starts_at this is dateless. The anchor is snapped to the unit, so 1h means the top of every hour.

monthday

number | null

Day of the month, or -1 for its last day. The one thing starts_at cannot say, since months differ in length

nth

number | null

Which match to keep. With days ["fr"] and a monthly cadence, -1 is the last Friday of the month

until

string | null

Stop repeating after this date. Null repeats forever. Not ends_at: this is when the event stops recurring at all.

rule

string | null

Read-only, derived: the same recurrence as an iCalendar RRULE

open_since

number | null

The occurrence whose window is open now

last_fired_at

number | null

last_occurrence

number | null

last_dispatch

enum<string> | null

Whether the last fire got its work sent. Not whether that work succeeded

Available options:

ok,

partial,

failed,

skipped,

null

last_error

string | null

last_outcome

enum<string> | null

Read-only, rolled up from those commands: what the work actually did. Null when they have aged out of the audit trail

Available options:

ok,

partial,

failed,

running,

null

next_run_at

number | null

Computed by the server. Never derive it client-side

Event

curl --request GET \
  --url http://localhost:44442/api/v1/schedule/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:44442/api/v1/schedule/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "44442",
  CURLOPT_URL => "http://localhost:44442/api/v1/schedule/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://localhost:44442/api/v1/schedule/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:44442/api/v1/schedule/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "name": "<string>",
  "description": "",
  "color": "",
  "enabled": true,
  "starts_at": "<string>",
  "days": [],
  "action": {
    "kind": "command",
    "type": "node.suspend"
  },
  "targets": {
    "all": false,
    "types": [],
    "pools": [],
    "groups": [],
    "tags": [],
    "nodes": []
  },
  "last_commands": [],
  "history": [],
  "created_at": 123,
  "updated_at": 123,
  "ends_at": "<string>",
  "every": "<string>",
  "monthday": 123,
  "nth": 123,
  "until": "<string>",
  "rule": "<string>",
  "open_since": 123,
  "last_fired_at": 123,
  "last_occurrence": 123,
  "last_dispatch": "ok",
  "last_error": "<string>",
  "last_outcome": "ok",
  "next_run_at": 123
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

Overview

Getting Started

Guides

Scripting

Developers

API Reference

Support

Resources

Authorizations

Path Parameters

Response