sked artifacts url-override

Manage page URL overrides (path redirects) in the Skedulo web app.

Overview

Manage page URL overrides (path redirects) in the Skedulo web app. Each override redirects traffic from one path to another, and is identified by a URL-safe slug derived from the source path (for example, /work/list becomes work-list).

A special reserved value of :landingPage can be used for the from field to configure the post-login landing page for the tenant.

sked artifacts url-override <command>

State file

A URL override state file uses the .url-override.json extension. The filename is typically the slug followed by the extension (for example, work-list.url-override.json).

{
  "metadata": {
    "type": "UrlOverride"
  },
  "name": "work-list",
  "from": "/work/list",
  "to": "/platform/page/jobs-view"
}

Fields

Field Description Required
name Unique identifier for the override, derived from the from path as a URL-safe slug (auto-generated if omitted). No
from The path to redirect from. Must start with /, or use the reserved value :landingPage. Yes
to The path to redirect to. Must start with /. Yes

The name field is auto-generated from the from path if omitted, with special characters replaced by hyphens, so you do not need to set it manually. A stored override always has a name value.

Landing page override

To configure the post-login landing page, set from to :landingPage:

{
  "metadata": {
    "type": "UrlOverride"
  },
  "name": "landingPage",
  "from": ":landingPage",
  "to": "/settings/automations/list"
}

Only one :landingPage override can exist per tenant. Attempting to create a second one will return a conflict error.

Commands

Command Description
Create Create a URL override from a state file
Delete Delete a URL override
Get Get the state file for a URL override
List List the existing URL overrides
Update Update a URL override from a state file
Upsert Create or update a URL override from a state file

Create

Description

Create a new URL override from a state file. Returns a conflict error if an override for the same path already exists; use upsert to create or replace.

Usage 

sked artifacts url-override create -f <value> [--json] [-a <value>] [-w <value>] [--name <value>]

Flags

Flag Description Required
-f, --filename= The state file. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No
--name=<value> The name of the URL override. No

Global flags

Flag Description Required
--json Format output as json. No

Delete

Description

Delete a URL override.

Usage 

sked artifacts url-override delete [--json] [-a <value>] [-w <value>] [--name <value>]

Flags

Flag Description Required
--name=<value> The name of the URL override. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No

Global flags

Flag Description Required
--json Format output as json. No

Get

Description

Get the state file for a URL override.

Usage 

sked artifacts url-override get --name <value> [--json] [-o <value>] [-a <value>]

Flags

Flag Description Required
--name The name of the URL override. Yes
-a, --alias The alias to use to authenticate. No
-o, --outputdir The output directory. No

Global flags

Flag Description Required
--json Format output as json. No

List

Description

List the existing URL overrides.

Usage 

sked artifacts url-override list [--json] [--columns <value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml] [--sort <value>] [-a <value>]

Flags

Flag Description Required
-a, --alias=<value> The alias to use to authenticate. No
-x, --extended Show extra columns. No
--columns=<value> Only show provided columns (comma-separated). No
--csv Output is CSV format [alias: --output=csv]. No
--filter=<value> Filter property by partial string matching, ex: name=foo. No
--no-header Hide table header from output. No
--no-truncate Do not truncate output to fit screen. No
--output=<option> Output in a more machine-friendly format. <options: csv|json|yaml>. No
--sort=<value> Property to sort by (prepend ‘-’ for descending). No

Global flags

Flag Description Required
--json Format output as json. No

Update

Description

Update an existing URL override from a state file. Returns a not found error if the override does not exist; use upsert to create or replace.

Usage 

sked artifacts url-override update -f <value> [--json] [-a <value>] [-w <value>] [--name <value>]

Flags

Flag Description Required
-f, --filename=<value> The state file. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No
--name=<value> The name of the URL override. No

Global flags

Flag Description Required
--json Format output as json. No

Upsert

Description

Create or Update a URL override from a state file.

Usage 

sked artifacts url-override upsert -f <value> [--json] [-a <value>] [-w <value>] [--name <value>]

Flags

Flag Description Required
-f, --filename=<value> The state file. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No
--name=<value> The name of the URL override. No

Global flags

Flag Description Required
--json Format output as json. No