Skip to content
|
search
decK
1.8.x
You are browsing documentation for an outdated version. See the latest documentation here.

deck konnect dump

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

The file can then be read using the deck konnect sync command or deck konnect diff command to configure Konnect.

Deprecation notice: The deck konnect command has been deprecated as of v1.12. Please use deck <cmd> instead if you would like to declaratively manage your Kong Gateway config with Konnect.

Syntax

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

Flags

--format
output file format: json or yaml. (Default: "yaml")
-h, --help
help for dump (Default: false)
--include-consumers
export consumers, associated credentials and any plugins associated with consumers. (Default: false)
-o, --output-file
file to which to write Kong’s configuration. (Default: "konnect")
--with-id
write ID of all entities in the output. (Default: false)
--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.
--ca-cert-file
Path to a custom CA certificate to use to verify Kong’s Admin TLS certificate. This value can also be set using DECK_CA_CERT_FILE environment variable.
--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-email
Email address associated with your Konnect account.
--konnect-password
Password associated with your Konnect account, this takes precedence over --konnect-password-file flag.
--konnect-password-file
File containing the password to your Konnect account.
--no-color
Disable colorized output (Default: false)
--skip-workspace-crud
Skip API calls related to Workspaces (Kong Enterprise only). (Default: false)
--timeout
Set a request timeout for the client to connect with Kong (in seconds). (Default: 10)
--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