deck ai dump

Uses: deck
Related Documentation
Related Resources

The deck ai dump command reads AI Gateway entities from Kong and writes them to a local file in AI Gateway format.

The command only exports entities that have the managed_by:deck-ai tag.

The output can be written as either YAML or JSON, controlled by the --format flag.

The following commands will back up all of the configuration in to a single file. See tags to learn how to segment configuration.

Konnect

decK can export one control plane at a time from Konnect. To choose which control plane is backed up, specify the --konnect-control-plane-name flag:

deck ai dump \
  -o $YOUR_CP_NAME.yaml \
  --konnect-control-plane-name $YOUR_CP_NAME \
  --konnect-token $KONNECT_TOKEN

Single workspace

If you’re using the default Workspace, decK automatically identifies the Workspace to back up:

deck ai dump -o kong.yaml

To back up a different Workspace, pass the -w flag:

deck ai dump -w $WORKSPACE_NAME -o $WORKSPACE_NAME.yaml

Command usage

Usage:
  deck ai dump [flags]

Flags:
      --format string      output file format: json or yaml. (default "yaml")
  -h, --help               help for dump
  -o, --output-file -      file to which to write AI Gateway configuration. Use - to write to stdout. (default "-")
  -w, --workspace string   dump configuration of a specific Workspace (Kong Enterprise only).
      --yes yes            assume yes to prompts and run non-interactively.

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!