Depot scriptschedules

View as Markdown Open in ChatGPT Open in Claude

Registers the schedule routes on the TENANT mux.

This page is generated from the Depot route table. Every operation carries the permission it needs and the anchor an agent can link to.

GET `/api/v1/script-schedules`

GETscript:readtenant facehosteditmspremoteIdempotent

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

List script schedules

Parameters

Name	In	Type	Required	Description
`dir`	query	string, one of asc, desc	No	Sort direction.
`page`	query	integer	No	One-based page number. Defaults to 1.
`pageSize`	query	integer	No	Rows per page, 1 to 200. Defaults to 50.
`q`	query	string	No	Free-text search term.
`sort`	query	string, one of created, lastFired, name, updated	No	Sort key.

Responses

Status	Body	Description
`200`	`application/json`, PagedResultScriptScheduleView	Success.
`400`	`application/problem+json`, ProblemDetails	One or more validation errors occurred.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold script:read.
`500`	`application/problem+json`, ProblemDetails	No client store in request context.

200 response body

Field	Type	Description
`items`required	`array of ScriptScheduleView`
`items[].createdAt`required	`string (date-time)`
`items[].cronExpr`required	`string`
`items[].enabled`required	`boolean`
`items[].graceSeconds`required	`integer`
`items[].lastFiredAt`	`string (date-time) or null`
`items[].missedRunPolicy`required	`string`
`items[].name`required	`string`
`items[].nextDueAt`	`string (date-time) or null`
`items[].offlineCapable`required	`boolean`
`items[].paramValues`required	`object`
`items[].publicId`required	`string`
`items[].runAs`required	`string`
`items[].scriptName`required	`string`
`items[].scriptPublicId`required	`string`
`items[].scriptVersion`required	`integer`
`items[].target`required	`Target`	Target is a run's endpoint selection, exactly as the console submitted it.
`items[].target.agentIds`	`array of string`
`items[].target.groupIds`	`array of string`
`items[].target.includeChildSites`	`boolean`
`items[].target.kind`required	`string`
`items[].target.siteIds`	`array of string`
`items[].timeoutSeconds`required	`integer`
`items[].timezone`required	`string`
`items[].triggerKind`required	`string`
`items[].updatedAt`required	`string (date-time)`
`page`required	`integer`
`pageSize`required	`integer`
`total`required	`integer`

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/script-schedules?dir=asc&page=0&pageSize=0&q=<q>&sort=created' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/script-schedules?dir=asc&page=0&pageSize=0&q=<q>&sort=created' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/script-schedules"
params = {
    "dir": "asc",
    "page": "0",
    "pageSize": "0",
    "q": "<q>",
    "sort": "created",
}
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, params=params, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://depot.example.com/api/v1/script-schedules?dir=asc&page=0&pageSize=0&q=<q>&sort=created", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = new URL("https://depot.example.com/api/v1/script-schedules");
url.searchParams.set("dir", "asc");
url.searchParams.set("page", "0");
url.searchParams.set("pageSize", "0");
url.searchParams.set("q", "<q>");
url.searchParams.set("sort", "created");

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://depot.example.com/api/v1/script-schedules?dir=asc&page=0&pageSize=0&q=<q>&sort=created");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST `/api/v1/script-schedules`

POSTscript:scheduletenant facehosteditmspremote

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

Create script schedule

Request body

Required, sent as application/json.

Field	Type	Description
`cronExpr`	`string or null`
`enabled`	`boolean or null`
`graceSeconds`	`integer or null`
`missedRunPolicy`	`string or null`
`name`	`string or null`
`offlineCapable`	`boolean or null`
`paramValues`required	`object`
`runAs`	`string or null`
`scriptPublicId`	`string or null`
`target`	`Target`	Target is a run's endpoint selection, exactly as the console submitted it.
`target.agentIds`	`array of string`
`target.groupIds`	`array of string`
`target.includeChildSites`	`boolean`
`target.kind`required	`string`
`target.siteIds`	`array of string`
`timeoutSeconds`	`integer or null`
`timezone`	`string or null`
`triggerKind`	`string or null`

Responses

Status	Body	Description
`201`	`application/json`, ScriptScheduleView	Created.
`400`	`application/problem+json`, ProblemDetails	The request body is not valid JSON.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold script:schedule.
`404`	`application/problem+json`, ProblemDetails	Schedule not found.
`409`	`application/problem+json`, ProblemDetails	A schedule with that name already exists.
`422`	`application/problem+json`, ProblemDetails	The request was refused.
`500`	`application/problem+json`, ProblemDetails	No client store in request context.
`503`	`application/problem+json`, ProblemDetails	The script library is not available on this Depot.

201 response body

Field	Type	Description
`createdAt`required	`string (date-time)`
`cronExpr`required	`string`
`enabled`required	`boolean`
`graceSeconds`required	`integer`
`lastFiredAt`	`string (date-time) or null`
`missedRunPolicy`required	`string`
`name`required	`string`
`nextDueAt`	`string (date-time) or null`
`offlineCapable`required	`boolean`
`paramValues`required	`object`
`publicId`required	`string`
`runAs`required	`string`
`scriptName`required	`string`
`scriptPublicId`required	`string`
`scriptVersion`required	`integer`
`target`required	`Target`	Target is a run's endpoint selection, exactly as the console submitted it.
`target.agentIds`	`array of string`
`target.groupIds`	`array of string`
`target.includeChildSites`	`boolean`
`target.kind`required	`string`
`target.siteIds`	`array of string`
`timeoutSeconds`required	`integer`
`timezone`required	`string`
`triggerKind`required	`string`
`updatedAt`required	`string (date-time)`

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
curl -X POST 'https://depot.example.com/api/v1/script-schedules' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '{
  "cronExpr": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "offlineCapable": false,
  "paramValues": {
    "key": "string"
  },
  "runAs": "string",
  "scriptPublicId": "string",
  "target": {
    "agentIds": [
      "string"
    ],
    "groupIds": [
      "string"
    ],
    "includeChildSites": false,
    "kind": "string",
    "siteIds": [
      "string"
    ]
  },
  "timeoutSeconds": 0,
  "timezone": "string",
  "triggerKind": "string"
}'

# Sign in first. outpost_console is a session cookie, so send it with every request.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Content-Type' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$body = @'
{
  "cronExpr": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "offlineCapable": false,
  "paramValues": {
    "key": "string"
  },
  "runAs": "string",
  "scriptPublicId": "string",
  "target": {
    "agentIds": [
      "string"
    ],
    "groupIds": [
      "string"
    ],
    "includeChildSites": false,
    "kind": "string",
    "siteIds": [
      "string"
    ]
  },
  "timeoutSeconds": 0,
  "timezone": "string",
  "triggerKind": "string"
}
'@

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/script-schedules' `
    -Headers $headers `
    -ContentType 'application/json' `
    -Body $body

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.

import requests

url = "https://depot.example.com/api/v1/script-schedules"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {
    "cronExpr": "string",
    "enabled": False,
    "graceSeconds": 0,
    "missedRunPolicy": "string",
    "name": "string",
    "offlineCapable": False,
    "paramValues": {
        "key": "string",
    },
    "runAs": "string",
    "scriptPublicId": "string",
    "target": {
        "agentIds": [
            "string",
        ],
        "groupIds": [
            "string",
        ],
        "includeChildSites": False,
        "kind": "string",
        "siteIds": [
            "string",
        ],
    },
    "timeoutSeconds": 0,
    "timezone": "string",
    "triggerKind": "string",
}

response = requests.post(url, headers=headers, cookies=cookies, json=payload, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
package main

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

func main() {
  body := []byte(`{
  "cronExpr": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "offlineCapable": false,
  "paramValues": {
    "key": "string"
  },
  "runAs": "string",
  "scriptPublicId": "string",
  "target": {
    "agentIds": [
      "string"
    ],
    "groupIds": [
      "string"
    ],
    "includeChildSites": false,
    "kind": "string",
    "siteIds": [
      "string"
    ]
  },
  "timeoutSeconds": 0,
  "timezone": "string",
  "triggerKind": "string"
}`)

  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/script-schedules", bytes.NewReader(body))
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.Header.Set("Content-Type", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/script-schedules";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify({
    "cronExpr": "string",
    "enabled": false,
    "graceSeconds": 0,
    "missedRunPolicy": "string",
    "name": "string",
    "offlineCapable": false,
    "paramValues": {
      "key": "string"
    },
    "runAs": "string",
    "scriptPublicId": "string",
    "target": {
      "agentIds": [
        "string"
      ],
      "groupIds": [
        "string"
      ],
      "includeChildSites": false,
      "kind": "string",
      "siteIds": [
        "string"
      ]
    },
    "timeoutSeconds": 0,
    "timezone": "string",
    "triggerKind": "string"
  }),
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

const string body = """
{
  "cronExpr": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "offlineCapable": false,
  "paramValues": {
    "key": "string"
  },
  "runAs": "string",
  "scriptPublicId": "string",
  "target": {
    "agentIds": [
      "string"
    ],
    "groupIds": [
      "string"
    ],
    "includeChildSites": false,
    "kind": "string",
    "siteIds": [
      "string"
    ]
  },
  "timeoutSeconds": 0,
  "timezone": "string",
  "triggerKind": "string"
}
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/script-schedules");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");
request.Content = new StringContent(body, Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET `/api/v1/script-schedules/{scheduleId}`

GETscript:readtenant facehosteditmspremoteIdempotent

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

Get script schedule

Parameters

Name	In	Type	Required	Description
`scheduleId`	path	string	Yes	A uuid.

Responses

Status	Body	Description
`200`	`application/json`, ScriptScheduleView	Success.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold script:read.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`500`	`application/problem+json`, ProblemDetails	No client store in request context.

200 response body

Field	Type	Description
`createdAt`required	`string (date-time)`
`cronExpr`required	`string`
`enabled`required	`boolean`
`graceSeconds`required	`integer`
`lastFiredAt`	`string (date-time) or null`
`missedRunPolicy`required	`string`
`name`required	`string`
`nextDueAt`	`string (date-time) or null`
`offlineCapable`required	`boolean`
`paramValues`required	`object`
`publicId`required	`string`
`runAs`required	`string`
`scriptName`required	`string`
`scriptPublicId`required	`string`
`scriptVersion`required	`integer`
`target`required	`Target`	Target is a run's endpoint selection, exactly as the console submitted it.
`target.agentIds`	`array of string`
`target.groupIds`	`array of string`
`target.includeChildSites`	`boolean`
`target.kind`required	`string`
`target.siteIds`	`array of string`
`timeoutSeconds`required	`integer`
`timezone`required	`string`
`triggerKind`required	`string`
`updatedAt`required	`string (date-time)`

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/script-schedules/<scheduleId>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/script-schedules/<scheduleId>' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/script-schedules/<scheduleId>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://depot.example.com/api/v1/script-schedules/<scheduleId>", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/script-schedules/<scheduleId>";

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://depot.example.com/api/v1/script-schedules/<scheduleId>");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

PUT `/api/v1/script-schedules/{scheduleId}`

PUTscript:scheduletenant facehosteditmspremoteIdempotent

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

Update script schedule

Parameters

Name	In	Type	Required	Description
`scheduleId`	path	string	Yes	A uuid.

Request body

Required, sent as application/json.

Field	Type	Description
`cronExpr`	`string or null`
`enabled`	`boolean or null`
`graceSeconds`	`integer or null`
`missedRunPolicy`	`string or null`
`name`	`string or null`
`offlineCapable`	`boolean or null`
`paramValues`required	`object`
`runAs`	`string or null`
`scriptPublicId`	`string or null`
`target`	`Target`	Target is a run's endpoint selection, exactly as the console submitted it.
`target.agentIds`	`array of string`
`target.groupIds`	`array of string`
`target.includeChildSites`	`boolean`
`target.kind`required	`string`
`target.siteIds`	`array of string`
`timeoutSeconds`	`integer or null`
`timezone`	`string or null`
`triggerKind`	`string or null`

Responses

Status	Body	Description
`200`	`application/json`, ScriptScheduleView	Success.
`400`	`application/problem+json`, ProblemDetails	The request body is not valid JSON.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold script:schedule.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`409`	`application/problem+json`, ProblemDetails	A schedule with that name already exists.
`422`	`application/problem+json`, ProblemDetails	The request was refused.
`500`	`application/problem+json`, ProblemDetails	No client store in request context.
`503`	`application/problem+json`, ProblemDetails	The script library is not available on this Depot.

200 response body

Field	Type	Description
`createdAt`required	`string (date-time)`
`cronExpr`required	`string`
`enabled`required	`boolean`
`graceSeconds`required	`integer`
`lastFiredAt`	`string (date-time) or null`
`missedRunPolicy`required	`string`
`name`required	`string`
`nextDueAt`	`string (date-time) or null`
`offlineCapable`required	`boolean`
`paramValues`required	`object`
`publicId`required	`string`
`runAs`required	`string`
`scriptName`required	`string`
`scriptPublicId`required	`string`
`scriptVersion`required	`integer`
`target`required	`Target`	Target is a run's endpoint selection, exactly as the console submitted it.
`target.agentIds`	`array of string`
`target.groupIds`	`array of string`
`target.includeChildSites`	`boolean`
`target.kind`required	`string`
`target.siteIds`	`array of string`
`timeoutSeconds`required	`integer`
`timezone`required	`string`
`triggerKind`required	`string`
`updatedAt`required	`string (date-time)`

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X PUT 'https://depot.example.com/api/v1/script-schedules/<scheduleId>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '{
  "cronExpr": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "offlineCapable": false,
  "paramValues": {
    "key": "string"
  },
  "runAs": "string",
  "scriptPublicId": "string",
  "target": {
    "agentIds": [
      "string"
    ],
    "groupIds": [
      "string"
    ],
    "includeChildSites": false,
    "kind": "string",
    "siteIds": [
      "string"
    ]
  },
  "timeoutSeconds": 0,
  "timezone": "string",
  "triggerKind": "string"
}'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Content-Type' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$body = @'
{
  "cronExpr": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "offlineCapable": false,
  "paramValues": {
    "key": "string"
  },
  "runAs": "string",
  "scriptPublicId": "string",
  "target": {
    "agentIds": [
      "string"
    ],
    "groupIds": [
      "string"
    ],
    "includeChildSites": false,
    "kind": "string",
    "siteIds": [
      "string"
    ]
  },
  "timeoutSeconds": 0,
  "timezone": "string",
  "triggerKind": "string"
}
'@

$response = Invoke-RestMethod `
    -Method Put `
    -Uri 'https://depot.example.com/api/v1/script-schedules/<scheduleId>' `
    -Headers $headers `
    -ContentType 'application/json' `
    -Body $body

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/script-schedules/<scheduleId>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {
    "cronExpr": "string",
    "enabled": False,
    "graceSeconds": 0,
    "missedRunPolicy": "string",
    "name": "string",
    "offlineCapable": False,
    "paramValues": {
        "key": "string",
    },
    "runAs": "string",
    "scriptPublicId": "string",
    "target": {
        "agentIds": [
            "string",
        ],
        "groupIds": [
            "string",
        ],
        "includeChildSites": False,
        "kind": "string",
        "siteIds": [
            "string",
        ],
    },
    "timeoutSeconds": 0,
    "timezone": "string",
    "triggerKind": "string",
}

response = requests.put(url, headers=headers, cookies=cookies, json=payload, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

func main() {
  body := []byte(`{
  "cronExpr": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "offlineCapable": false,
  "paramValues": {
    "key": "string"
  },
  "runAs": "string",
  "scriptPublicId": "string",
  "target": {
    "agentIds": [
      "string"
    ],
    "groupIds": [
      "string"
    ],
    "includeChildSites": false,
    "kind": "string",
    "siteIds": [
      "string"
    ]
  },
  "timeoutSeconds": 0,
  "timezone": "string",
  "triggerKind": "string"
}`)

  req, err := http.NewRequest(http.MethodPut, "https://depot.example.com/api/v1/script-schedules/<scheduleId>", bytes.NewReader(body))
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.Header.Set("Content-Type", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/script-schedules/<scheduleId>";

const response = await fetch(url, {
  method: "PUT",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify({
    "cronExpr": "string",
    "enabled": false,
    "graceSeconds": 0,
    "missedRunPolicy": "string",
    "name": "string",
    "offlineCapable": false,
    "paramValues": {
      "key": "string"
    },
    "runAs": "string",
    "scriptPublicId": "string",
    "target": {
      "agentIds": [
        "string"
      ],
      "groupIds": [
        "string"
      ],
      "includeChildSites": false,
      "kind": "string",
      "siteIds": [
        "string"
      ]
    },
    "timeoutSeconds": 0,
    "timezone": "string",
    "triggerKind": "string"
  }),
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

const string body = """
{
  "cronExpr": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "offlineCapable": false,
  "paramValues": {
    "key": "string"
  },
  "runAs": "string",
  "scriptPublicId": "string",
  "target": {
    "agentIds": [
      "string"
    ],
    "groupIds": [
      "string"
    ],
    "includeChildSites": false,
    "kind": "string",
    "siteIds": [
      "string"
    ]
  },
  "timeoutSeconds": 0,
  "timezone": "string",
  "triggerKind": "string"
}
""";

var request = new HttpRequestMessage(HttpMethod.Put, "https://depot.example.com/api/v1/script-schedules/<scheduleId>");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");
request.Content = new StringContent(body, Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

DELETE `/api/v1/script-schedules/{scheduleId}`

DELETEscript:scheduletenant facehosteditmspremoteIdempotent

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

Delete script schedule

Parameters

Name	In	Type	Required	Description
`scheduleId`	path	string	Yes	A uuid.

Responses

Status	Body	Description
`204`	None	Success, with no body.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold script:schedule.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`500`	`application/problem+json`, ProblemDetails	No client store in request context.

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X DELETE 'https://depot.example.com/api/v1/script-schedules/<scheduleId>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Delete `
    -Uri 'https://depot.example.com/api/v1/script-schedules/<scheduleId>' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/script-schedules/<scheduleId>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.delete(url, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

func main() {
  req, err := http.NewRequest(http.MethodDelete, "https://depot.example.com/api/v1/script-schedules/<scheduleId>", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/script-schedules/<scheduleId>";

const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Delete, "https://depot.example.com/api/v1/script-schedules/<scheduleId>");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET `/api/v1/script-schedules/{scheduleId}/runs`

GETscript:readtenant facehosteditmspremoteIdempotent

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

List schedule runs

Parameters

Name	In	Type	Required	Description
`scheduleId`	path	string	Yes	A uuid.
`page`	query	integer	No	One-based page number. Defaults to 1.
`pageSize`	query	integer	No	Rows per page, 1 to 200. Defaults to 50.
`state`	query	string	No

Responses

Status	Body	Description
`200`	`application/json`, PagedResultScriptScheduleRunView	Success.
`400`	`application/problem+json`, ProblemDetails	One or more validation errors occurred.
`401`	`application/problem+json`, ProblemDetails	No signed-in identity.
`403`	`application/problem+json`, ProblemDetails	The identity does not hold script:read.
`404`	`application/problem+json`, ProblemDetails	No resource matches that id.
`500`	`application/problem+json`, ProblemDetails	No client store in request context.

200 response body

Field	Type	Description
`items`required	`array of ScriptScheduleRunView`
`items[].agentId`required	`string`
`items[].commandId`required	`string`
`items[].completedAt`	`string (date-time) or null`
`items[].dueAt`required	`string (date-time)`
`items[].exitCode`	`integer or null`
`items[].firedAt`	`string (date-time) or null`
`items[].origin`required	`string`
`items[].publicId`required	`string`
`items[].reason`	`string`
`items[].schedulePublicId`required	`string`
`items[].state`required	`string`
`items[].username`required	`string`
`page`required	`integer`
`pageSize`required	`integer`
`total`required	`integer`

Request samples

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/script-schedules/<scheduleId>/runs?page=0&pageSize=0&state=<state>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/script-schedules/<scheduleId>/runs?page=0&pageSize=0&state=<state>' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/script-schedules/<scheduleId>/runs"
params = {
    "page": "0",
    "pageSize": "0",
    "state": "<state>",
}
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, params=params, headers=headers, cookies=cookies, timeout=30)
response.raise_for_status()
print(response.json())

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://depot.example.com/api/v1/script-schedules/<scheduleId>/runs?page=0&pageSize=0&state=<state>", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = new URL("https://depot.example.com/api/v1/script-schedules/<scheduleId>/runs");
url.searchParams.set("page", "0");
url.searchParams.set("pageSize", "0");
url.searchParams.set("state", "<state>");

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

// Sign in first. outpost_console is a session cookie, so send it with every request.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://depot.example.com/api/v1/script-schedules/<scheduleId>/runs?page=0&pageSize=0&state=<state>");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Content is licensed CC BY 4.0. Code samples are MIT. Outpost and the Outpost mark are trademarks of Outpost Business Solutions, PBC and are not covered by either license.

Depot scriptschedules

GET /api/v1/script-schedules

Parameters

Responses

Request samples

POST /api/v1/script-schedules

Request body

Responses

Request samples

GET /api/v1/script-schedules/{scheduleId}

Parameters

Responses

Request samples

PUT /api/v1/script-schedules/{scheduleId}

Parameters

Request body

Responses

Request samples

DELETE /api/v1/script-schedules/{scheduleId}

Parameters

Responses

Request samples

GET /api/v1/script-schedules/{scheduleId}/runs

Parameters

Responses

Request samples

GET `/api/v1/script-schedules`

POST `/api/v1/script-schedules`

GET `/api/v1/script-schedules/{scheduleId}`

PUT `/api/v1/script-schedules/{scheduleId}`

DELETE `/api/v1/script-schedules/{scheduleId}`

GET `/api/v1/script-schedules/{scheduleId}/runs`