Notploy

Redis

Provision and operate Redis instances, including backups and external ports. Generated from the `notploy` command surface.

Provision and operate Redis instances, including backups and external ports.

notploy redis exposes 16 commands. They map one-to-one onto the redis.* API operations, so anything reachable from the dashboard is reachable from here.

Run notploy redis --help to list these commands in your terminal, or notploy redis <command> --help for a single command.

Commands

notploy redis change-password

Calls POST /api/trpc/redis.changePassword.

notploy redis change-password --redisId <value> --password <value> [options]
OptionTypeRequiredAllowed values
--redisId <value>stringYes—
--password <value>stringYes—
--profile <name>stringNo—

notploy redis change-status

Calls POST /api/trpc/redis.changeStatus.

notploy redis change-status --redisId <value> --applicationStatus <value> [options]
OptionTypeRequiredAllowed values
--redisId <value>stringYes—
--applicationStatus <value>stringYesidle, running, done, error
--profile <name>stringNo—

notploy redis create

Calls POST /api/trpc/redis.create.

notploy redis create --name <value> --databasePassword <value> --environmentId <value> [options]
OptionTypeRequiredAllowed values
--name <value>stringYes—
--appName <value>stringNo—
--databasePassword <value>stringYes—
--dockerImage <value>stringNo—
--environmentId <value>stringYes—
--description <value>stringNo—
--serverId <value>stringNo—
--profile <name>stringNo—

notploy redis deploy

Calls POST /api/trpc/redis.deploy.

notploy redis deploy --redisId <value> [options]
OptionTypeRequiredAllowed values
--redisId <value>stringYes—
--profile <name>stringNo—

notploy redis move

Calls POST /api/trpc/redis.move.

notploy redis move --redisId <value> --targetEnvironmentId <value> [options]
OptionTypeRequiredAllowed values
--redisId <value>stringYes—
--targetEnvironmentId <value>stringYes—
--profile <name>stringNo—

notploy redis one

Calls GET /api/trpc/redis.one.

notploy redis one --redisId <value> [options]
OptionTypeRequiredAllowed values
--redisId <value>stringYes—
--profile <name>stringNo—

notploy redis read-logs

Calls GET /api/trpc/redis.readLogs.

notploy redis read-logs --redisId <value> [options]
OptionTypeRequiredAllowed values
--redisId <value>stringYes—
--tail <value>numberNo—
--since <value>stringNo—
--search <value>stringNo—
--profile <name>stringNo—

notploy redis rebuild

Calls POST /api/trpc/redis.rebuild.

notploy redis rebuild --redisId <value> [options]
OptionTypeRequiredAllowed values
--redisId <value>stringYes—
--profile <name>stringNo—

notploy redis reload

Calls POST /api/trpc/redis.reload.

notploy redis reload --redisId <value> --appName <value> [options]
OptionTypeRequiredAllowed values
--redisId <value>stringYes—
--appName <value>stringYes—
--profile <name>stringNo—

notploy redis remove

Calls POST /api/trpc/redis.remove.

notploy redis remove --redisId <value> [options]
OptionTypeRequiredAllowed values
--redisId <value>stringYes—
--profile <name>stringNo—

notploy redis save-environment

Calls POST /api/trpc/redis.saveEnvironment.

notploy redis save-environment --redisId <value> --env <value> [options]
OptionTypeRequiredAllowed values
--redisId <value>stringYes—
--env <value>stringYes—
--profile <name>stringNo—

notploy redis save-external-port

Calls POST /api/trpc/redis.saveExternalPort.

notploy redis save-external-port --redisId <value> --externalPort <value> [options]
OptionTypeRequiredAllowed values
--redisId <value>stringYes—
--externalPort <value>numberYes—
--profile <name>stringNo—

Calls GET /api/trpc/redis.search.

notploy redis search [options]
OptionTypeRequiredAllowed values
--q <value>stringNo—
--name <value>stringNo—
--appName <value>stringNo—
--description <value>stringNo—
--projectId <value>stringNo—
--environmentId <value>stringNo—
--limit <value>numberNo—
--offset <value>numberNo—
--profile <name>stringNo—

notploy redis start

Calls POST /api/trpc/redis.start.

notploy redis start --redisId <value> [options]
OptionTypeRequiredAllowed values
--redisId <value>stringYes—
--profile <name>stringNo—

notploy redis stop

Calls POST /api/trpc/redis.stop.

notploy redis stop --redisId <value> [options]
OptionTypeRequiredAllowed values
--redisId <value>stringYes—
--profile <name>stringNo—

notploy redis update

Calls POST /api/trpc/redis.update.

notploy redis update --redisId <value> [options]
OptionTypeRequiredAllowed values
--redisId <value>stringYes—
--name <value>stringNo—
--appName <value>stringNo—
--description <value>stringNo—
--databasePassword <value>stringNo—
--dockerImage <value>stringNo—
--command <value>stringNo—
--args <json>arrayNo—
--env <value>stringNo—
--memoryReservation <value>stringNo—
--memoryLimit <value>stringNo—
--cpuReservation <value>stringNo—
--cpuLimit <value>stringNo—
--externalPort <value>numberNo—
--createdAt <value>stringNo—
--applicationStatus <value>stringNoidle, running, done, error
--healthCheckSwarm <json>objectNo—
--restartPolicySwarm <json>objectNo—
--placementSwarm <json>objectNo—
--updateConfigSwarm <json>objectNo—
--rollbackConfigSwarm <json>objectNo—
--modeSwarm <json>objectNo—
--labelsSwarm <json>objectNo—
--networkSwarm <json>arrayNo—
--stopGracePeriodSwarm <value>numberNo—
--endpointSpecSwarm <json>objectNo—
--ulimitsSwarm <json>arrayNo—
--replicas <value>numberNo—
--environmentId <value>stringNo—
--networkIds <json>arrayNo—
--detachNotployNetwork [boolean]booleanNo—
--no-detachNotployNetworkbooleanNo—
--profile <name>stringNo—

PostgreSQL

Provision and operate PostgreSQL databases, including backups and external ports. Generated from the `notploy` command surface.

Backups

Scheduled and manual backups for databases, Compose services and the web server. Generated from the `notploy` command surface.

On this page

Commandsnotploy redis change-passwordnotploy redis change-statusnotploy redis createnotploy redis deploynotploy redis movenotploy redis onenotploy redis read-logsnotploy redis rebuildnotploy redis reloadnotploy redis removenotploy redis save-environmentnotploy redis save-external-portnotploy redis searchnotploy redis startnotploy redis stopnotploy redis update