Schedules
Cron jobs that run a shell command inside a deployed service. Generated from the `notploy` command surface.
Cron jobs that run a shell command inside a deployed service.
notploy schedule exposes 6 commands. They map one-to-one onto the schedule.* API operations, so anything reachable from the dashboard is reachable from here.
Run notploy schedule --help to list these commands in your terminal, or
notploy schedule <command> --help for a single command.
Commands
notploy schedule create
Calls POST /api/trpc/schedule.create.
notploy schedule create --name <value> --cronExpression <value> --command <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--scheduleId <value> | string | No | — |
--name <value> | string | Yes | — |
--description <value> | string | No | — |
--cronExpression <value> | string | Yes | — |
--appName <value> | string | No | — |
--serviceName <value> | string | No | — |
--shellType <value> | string | No | bash, sh |
--scheduleType <value> | string | No | application, compose, server, notploy-server |
--command <value> | string | Yes | — |
--script <value> | string | No | — |
--applicationId <value> | string | No | — |
--composeId <value> | string | No | — |
--serverId <value> | string | No | — |
--organizationId <value> | string | No | — |
--enabled [boolean] | boolean | No | — |
--no-enabled | boolean | No | — |
--timezone <value> | string | No | — |
--createdAt <value> | string | No | — |
--profile <name> | string | No | — |
notploy schedule delete
Calls POST /api/trpc/schedule.delete.
notploy schedule delete --scheduleId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--scheduleId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy schedule list
Calls GET /api/trpc/schedule.list.
notploy schedule list --id <value> --scheduleType <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--id <value> | string | Yes | — |
--scheduleType <value> | string | Yes | application, compose, server, notploy-server |
--profile <name> | string | No | — |
notploy schedule one
Calls GET /api/trpc/schedule.one.
notploy schedule one --scheduleId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--scheduleId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy schedule run-manually
Calls POST /api/trpc/schedule.runManually.
notploy schedule run-manually --scheduleId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--scheduleId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy schedule update
Calls POST /api/trpc/schedule.update.
notploy schedule update --scheduleId <value> --name <value> --cronExpression <value> --command <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--scheduleId <value> | string | Yes | — |
--name <value> | string | Yes | — |
--description <value> | string | No | — |
--cronExpression <value> | string | Yes | — |
--appName <value> | string | No | — |
--serviceName <value> | string | No | — |
--shellType <value> | string | No | bash, sh |
--scheduleType <value> | string | No | application, compose, server, notploy-server |
--command <value> | string | Yes | — |
--script <value> | string | No | — |
--applicationId <value> | string | No | — |
--composeId <value> | string | No | — |
--serverId <value> | string | No | — |
--organizationId <value> | string | No | — |
--enabled [boolean] | boolean | No | — |
--no-enabled | boolean | No | — |
--timezone <value> | string | No | — |
--createdAt <value> | string | No | — |
--profile <name> | string | No | — |