Skip to content

checkly-destroy.mdx

Latest commit

 

History

History
90 lines (60 loc) · 2.55 KB

checkly-destroy.mdx

File metadata and controls

90 lines (60 loc) · 2.55 KB
title checkly destroy
description Destroy all project resources from your Checkly account.
sidebarTitle checkly destroy

import CliCommandPrerequisites from '/snippets/cli-command-prerequisites.mdx';

The checkly destroy command removes all resources associated with your project from your Checkly account, including checks, check groups, alert channels, maintenance windows, and other project-defined resources.

This command permanently deletes resources from your Checkly account. This action cannot be undone.

Usage

The basic command destroys all project resources with a confirmation prompt.

npx checkly destroy [options]
Option Description
--config, -c The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.
--force, -f Force mode. Skips the confirmation dialog.

Command Options

Specify a particular configuration file to use instead of the default checkly.config.ts or checkly.config.js.

Usage:

npx checkly destroy --config=<file-path>
npx checkly destroy -c=<file-path>

Examples:

$ npx checkly destroy --config="./checkly.staging.config.ts"

Skip confirmation dialogs and proceed with the operation.

Usage:

npx checkly destroy --force
npx checkly destroy -f

Use with extreme caution as this command option bypasses safety prompts.

What Gets Destroyed

The destroy command removes the all the resources managed by the specified project. These resources could include:

  • Checks (API, Browser, Heartbeat, etc.)
  • Monitors (URL, TCP, DNC, etc.)
  • Check Groups and their configurations
  • Alert Channels defined in your project
  • Maintenance Windows created via CLI
  • Private Locations (if managed by the project)

Safety Considerations

By default, the command prompts for confirmation:

$ npx checkly destroy

? Are you sure you want to delete all resources in project "Website Monitoring" for account "Monitoring as Code"?
Please confirm by typing the project name "Website Monitoring":

Related Commands