Socket
Book a DemoInstallSign in
Socket

datadog_backup

Package Overview
Dependencies
Maintainers
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

datadog_backup

4.0.2
bundlerRubygems
Version published
Maintainers
2
Created
Source

Datadog Backup

Rspec and Release Gem Version

Use datadog_backup to backup your datadog account. Currently supports

  • dashboards
  • monitors

Additional features may be built out over time.

v3 Migration

Breaking Changes

v3 is a backwards incompatible change.

  • DATADOG_API_KEY and DATADOG_APP_KEY are no longer the environment variables used to authenticate to Datadog. Instead, set the environment variables DD_API_KEY and DD_APP_KEY.
  • ruby 2.7 is no longer supported. Please upgrade to ruby 3.0 or higher.
  • The options --ssh and --ssshh are no longer supported. Instead, please use --quiet to supress logging. --debug remains supported.
  • The environment variable DATADOG_HOST is no longer supported. Instead, please use DD_SITE_URL.

Misc

Installation

gem install datadog_backup

Usage

demo

DD_API_KEY=example123 DD_APP_KEY=example123 datadog_backup <backup|diffs|restore> [--backup-dir /path/to/backups] [--debug] [--monitors-only] [--dashboards-only] [--diff-format color|html|html_simple] [--no-color] [--json]
gem install datadog_backup
export DD_API_KEY=abc123
export DD_APP_KEY=abc123

# Perform backup to `./backup/` using YAML encoding
datadog_backup backup

# Make some changes

# Just review the changes since last backup
datadog_backup diffs

# Review the changes since last backup and apply local changes to datadog

datadog_backup restore

Parameters

Supply the following parameters in order to customize datadog_backup:

parameterdescriptiondefault
--debuglog debug and aboveinfo
--quietonly show errors and aboveinfo
--backup-dir PATHpath to the directory to backup to or restore from./backup/
--monitors-onlyonly backup monitorsbackup monitors and dashboards
--dashboards-onlyonly backup dashboardsbackup monitors and dashboards
--jsonformat backups as JSON instead of YAML. Does not impact diffs nor restore, but do not mix formats in the same backup-dir.YAML
--no-colorremoves colored output from diff format
--diff-format FORMATone of color, html_simple, htmlcolor
--force-restoreForce restore to Datadog. Do not ask to validate. Non-interactive.
--disable-array-sortDo not sort array elements, to preserver order of dashboard widgets.
--h, --helphelp

Environment variables

The following environment variables can be set in order to further customize datadog_backup:

environment variabledescriptiondefault
DD_SITE_URLDescribe the API endpoint to connect to (https://api.datadoghq.eu for example)https://api.datadoghq.com
DD_API_KEYThe API key for the Datadog accountnone
DD_API_KEYThe Application key for the Datadog accountnone

Usage in a Github repo

See example/ for an example implementation as a repo that backs up your Datadog dashboards hourly.

Development

Releases are cut using semantic-release.

Please write commit messages following Angular commit guidelines

FAQs

Package last updated on 25 Mar 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.