You are browsing documentation for an older version. See the latest documentation here.

deck dump

The dump command reads all entities present in Kong and writes them to a local file.

The file can then be read using the sync command or diff command to configure Kong.

Syntax

deck dump [command-specific flags] [global flags]

Flags

--all-workspaces

dump configuration of all workspaces Kong Gateway Enterprise only. (Default: false)

--format

output file format: json or yaml. (Default: "yaml")

-h, --help

help for dump

-o, --output-file

file to which to write Kong’s configuration.Use - to write to stdout. (Default: "kong")

--rbac-resources-only

export only the RBAC resources Kong Gateway Enterprise only. (Default: false)

--select-tag

only entities matching tags specified with this flag are exported. When this setting has multiple tag values, entities must match every tag.

--skip-consumers

skip exporting consumers and any plugins associated with consumers. (Default: false)

--with-id

write ID of all entities in the output (Default: false)

-w, --workspace

dump configuration of a specific workspace Kong Gateway Enterprise only.

--yes

assume yes to prompts and run non-interactively. (Default: false)

Global flags

--analytics

Share anonymized data to help improve decK. Use --analytics=false to disable this. (Default: true)

--ca-cert

Custom CA certificate (raw contents) to use to verify Kong’s Admin TLS certificate. This value can also be set using DECK_CA_CERT environment variable. This takes precedence over --ca-cert-file flag.

--config

Config file (default is $HOME/.deck.yaml).

--headers

HTTP headers (key:value) to inject in all requests to Kong’s Admin API. This flag can be specified multiple times to inject multiple headers.

--kong-addr

HTTP address of Kong’s Admin API. This value can also be set using the environment variable DECK_KONG_ADDR environment variable. (Default: "http://localhost:8001")

--konnect-addr

Address of the Konnect endpoint. (Default: "https://us.api.konghq.com")

--konnect-token

Token associated with your Konnect account. This takes precedence over the --konnect-token-file flag.

--konnect-token-file

File containing the token associated with your Konnect account.

--no-color

Disable colorized output (Default: false)

--skip-workspace-crud

Skip API calls related to Workspaces (Kong Gateway Enterprise only). (Default: false)

--tls-server-name

Name to use to verify the hostname in Kong’s Admin TLS certificate. This value can also be set using DECK_TLS_SERVER_NAME environment variable.

--tls-skip-verify

Disable verification of Kong’s Admin TLS certificate. This value can also be set using DECK_TLS_SKIP_VERIFY environment variable. (Default: false)

--verbose

Enable verbose logging levels Setting this value to 2 outputs all HTTP requests/responses between decK and Kong. (Default: 0)

See also

• deck - Administer your Kong clusters declaratively