Skip to content
Weik.ioDocs
2026.2
Try Weik.io

Platform administration

Weik.io 2026.2

Change installation-wide settings and certificates with the weikio CLI, and search the installation by name.

On this page

The commands on this page work on the installation as a whole. Most of them need a platform administrator.

The installation’s settings are one document. You print it with weikio settings get and change it over the API with weikio settings set.

Operations that run on a hub server and don’t go through the API, such as init, backup, restore and doctor, are commands of the backend image. The weikio-backend page lists them.

Commands on this page#

Command What it does
weikio search Search the installation by name.
weikio platform breakglass Show the open break-glass window.
weikio platform secret set Set a platform secret.
weikio platform secret list List the platform secrets without their values.
weikio platform secret delete Delete a platform secret.
weikio forwarding get Print the telemetry forwarding document as a file you can apply.
weikio forwarding status Show where telemetry is forwarded and what each exporter sent in the last hour.
weikio forwarding delete Delete the telemetry forwarding document and stop forwarding telemetry and audit records.
weikio forwarding audit-from Choose the first audit record the forwarder sends.
weikio platform authority get Get the platform authority’s certificate and its SHA-256 fingerprint.
weikio get certificates List certificates.
weikio describe certificate Show a certificate with its last error and failed checks.
weikio certificates renew Renew a certificate now.
weikio certificates dns add Add a DNS connection and test it.
weikio certificates dns set Change a DNS connection and test it again.
weikio certificates dns test Test a DNS connection.
weikio certificates dns remove Remove a DNS connection, after listing the certificates that depend on it.
weikio certificates dns persist Print a DNS record that lets Weik.io order certificates for names under the zone without a DNS connection.
weikio certificates authority add Add a certificate authority.
weikio certificates authority set Change a certificate authority.
weikio certificates authority remove Remove a certificate authority.
weikio settings get Show the installation’s settings.
weikio settings set Change the installation’s settings.
weikio notice set Set the notice at the top of every page of the admin UI.
weikio notice get Print the notice at the top of every page of the admin UI.
weikio notice delete Delete the notice at the top of every page of the admin UI.
weikio project purge Purge a deleted project’s telemetry.

The tables below leave out the flags every command accepts, such as --env and --project, which the CLI reference lists.

Find projects, integrations, APIs and other items by name. The best match comes first.

Terminal
weikio search <text>
Argument or flag What it does
<text> Gives part of the name to find, from two to a hundred characters.

Who can run it: any API key. You see what you may read.

API: GET /api/v1/search?q=.

weikio platform breakglass#

Show the open break-glass window. You open the window on a hub server with weikio-backend breakglass enable.

Terminal
weikio platform breakglass

Who can run it: a platform administrator.

API: GET /api/v1/break-glass.

weikio platform secret set#

Set a platform secret. The command gets the value from a hidden prompt or a pipe, or from a file with --from-file. Weik.io never shows the value again.

Terminal
weikio platform secret set <name> [--from-file PATH] [--reason S]
Argument or flag What it does
<name> Sets the secret’s name.
--from-file <from-file> Uses the value in this file instead of standard input.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: PUT /api/v1/platform/secrets/{name}.

weikio platform secret list#

List the platform secrets without their values.

Terminal
weikio platform secret list

Who can run it: a platform administrator.

API: GET /api/v1/platform/secrets.

weikio platform secret delete#

Delete a platform secret.

Terminal
weikio platform secret delete <name> [--yes] [--reason S]
Argument or flag What it does
<name> Identifies the secret.
-y, --yes Skips the confirmation.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: DELETE /api/v1/platform/secrets/{name}.

weikio forwarding get#

Print the telemetry forwarding document as a file you can apply.

Terminal
weikio forwarding get [--effective]
Argument or flag What it does
--effective Adds the platform’s part of the collector configuration as comment lines.

Who can run it: a platform administrator.

API: GET /api/v1/forwarding[?effective=true].

Also written as weikio get forwarding.

weikio forwarding status#

Show where each signal goes and how much each exporter sent and discarded in the last hour. The output also shows the forwarding document’s revision.

Terminal
weikio forwarding status [--watch] [--lines]
Argument or flag What it does
--watch Prints the status again every 5 seconds until you stop it.
--lines Adds each forwarder’s last log lines.

Who can run it: a platform administrator.

API: GET /api/v1/forwarding, GET /api/v1/forwarding/status.

weikio forwarding delete#

Delete the telemetry forwarding document and stop forwarding telemetry and audit records.

Terminal
weikio forwarding delete [--yes] [--reason S]
Argument or flag What it does
-y, --yes Skips the confirmation.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: DELETE /api/v1/forwarding.

Also written as weikio delete forwarding.

weikio forwarding audit-from#

Choose the first audit record the forwarder sends. Use it to send the audit log from an earlier record, for example to a destination you just added.

Terminal
weikio forwarding audit-from <time|now> [--yes] [--reason S]
Argument or flag What it does
<time> Sets the time to send audit records from, such as 2026-09-01 or 24h. Give now to skip the records that are waiting.
-y, --yes Skips the confirmation.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: GET /api/v1/forwarding, POST /api/v1/forwarding/audit-from[?dryRun=true].

weikio platform authority get#

Get the platform authority’s certificate and its SHA-256 fingerprint.

Terminal
weikio platform authority get [--to FILE] [--format pem|der]
Argument or flag What it does
--to <file> Writes the certificate to this file. The default for pem is standard output.
--format <format> Sets the format to der for a .crt file that Windows opens. The default format is pem.

Who can run it: any valid API key.

API: GET /api/v1/settings/install/authority.

weikio get certificates#

List certificates.

Terminal
weikio get certificates

Who can run it: for a gateway hostname, a grant with read in the gateway’s environment. For any other certificate, a platform administrator.

API: GET /api/v1/certificates.

Also written as weikio get certificate.

weikio describe certificate#

Show a certificate with its last error and failed checks. The output also shows how Weik.io proved the certificate’s names to the authority.

Terminal
weikio describe certificate <name> [--env E]
Argument or flag What it does
<name> Identifies the certificate by a hostname, by project/api for a client certificate, or as ‘platform authority’.

Who can run it: for a gateway hostname, a grant with read in the gateway’s environment. For any other certificate, a platform administrator.

API: GET /api/v1/certificates.

Also written as weikio describe certificates.

weikio certificates renew#

Renew a certificate now. The command renews the certificate of a gateway hostname or a hub address, and with --client it renews an API’s upstream client certificate.

Renewal is automatic, so run the command after you fix what made a renewal fail, or to replace a certificate early.

Terminal
weikio certificates renew <hostname>
Argument or flag What it does
<hostname> Identifies a gateway hostname or hub address.
--client <client> Renews an API’s upstream client certificate instead, given as project/api, in the --env environment.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: GET /api/v1/certificates, POST /api/v1/gateways/{name}/certificates/renew?hostname=, POST /api/v1/settings/install/certificates/renew?hostname=, POST /api/v1/environments/{environment}/projects/{project}/apis/{api}/client-certificate/renew.

weikio certificates dns add#

Add a DNS connection and test it.

Terminal
weikio certificates dns add <name> --provider cloudflare|hetzner|azure|rfc2136 --zone Z [--zone Z ...] --secret S [--azure-tenant T --azure-client C --azure-object-id O --azure-subscription S --azure-resource-group G] [--server HOST[:PORT] --key-name K]
Argument or flag What it does
<name> Sets the DNS connection’s name.
--provider <provider> Sets the zone’s DNS provider, one of cloudflare, hetzner, azure or rfc2136.
--zone <zone> Adds a zone, such as example.com. Repeat the flag for each zone you add.
--secret <secret> Sets the name of the platform secret that has the provider’s token or key. For azure, it’s the secret that has its sign-in key.
--azure-tenant <azure-tenant> Sets the app registration’s directory (tenant) id.
--azure-client <azure-client> Sets the app registration’s application (client) id.
--azure-object-id <azure-object-id> Sets the app registration’s object id.
--azure-subscription <azure-subscription> Sets the Azure subscription that has the zone.
--azure-resource-group <azure-resource-group> Sets the resource group that has the zone.
--server <server> Sets the name server that accepts the zone’s updates, as HOST or HOST:PORT, for rfc2136.
--key-name <key-name> Sets the TSIG key name, for rfc2136.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: GET /api/v1/settings/install/certificates/dns/{name}, PUT /api/v1/settings/install/certificates/dns/{name}.

weikio certificates dns set#

Change a DNS connection and test it again.

Terminal
weikio certificates dns set <name> [flags]
Argument or flag What it does
<name> Identifies the DNS connection.
--provider <provider> Sets the zone’s DNS provider, one of cloudflare, hetzner, azure or rfc2136.
--zone <zone> Adds a zone, such as example.com. Repeat the flag for each zone you add.
--secret <secret> Sets the name of the platform secret that has the provider’s token or key. For azure, it’s the secret that has its sign-in key.
--azure-tenant <azure-tenant> Sets the app registration’s directory (tenant) id.
--azure-client <azure-client> Sets the app registration’s application (client) id.
--azure-object-id <azure-object-id> Sets the app registration’s object id.
--azure-subscription <azure-subscription> Sets the Azure subscription that has the zone.
--azure-resource-group <azure-resource-group> Sets the resource group that has the zone.
--server <server> Sets the name server that accepts the zone’s updates, as HOST or HOST:PORT, for rfc2136.
--key-name <key-name> Sets the TSIG key name, for rfc2136.
--reason <reason> Stores a reason for the change with the audit record.

weikio certificates dns test#

Test a DNS connection.

Terminal
weikio certificates dns test <name> [flags]
Argument or flag What it does
<name> Identifies the DNS connection.
--reason <reason> Stores a reason for the change with the audit record.

weikio certificates dns remove#

Remove a DNS connection, after listing the certificates that depend on it.

Terminal
weikio certificates dns remove <name> [flags]
Argument or flag What it does
<name> Identifies the DNS connection.
-y, --yes Skips the confirmation.
--reason <reason> Stores a reason for the change with the audit record.

weikio certificates dns persist#

Print a DNS record that lets Weik.io order certificates from the public authority for every name under the zone, without a DNS connection. Add the printed record to the zone once.

Terminal
weikio certificates dns persist <zone>
Argument or flag What it does
<zone> Identifies the zone the record goes into, such as example.com.

Who can run it: a platform administrator.

API: GET /api/v1/settings/install.

weikio certificates authority add#

Add a certificate authority.

Terminal
weikio certificates authority add <name> --acme URL --names SUFFIX,... [--eab-key-id K --eab-secret S] [--trust ca.pem ...] [--orders backend|site] [--client-certificates]
Argument or flag What it does
<name> Sets the certificate authority’s name.
--acme <acme> Sets the authority’s ACME directory URL.
--names <names> Sets the name suffixes, such as corp.example, comma separated or repeated.
--eab-key-id <eab-key-id> Sets the key id of the authority’s external account binding (EAB).
--eab-secret <eab-secret> Sets the name of the platform secret that has the EAB key.
--trust <trust> Adds a PEM file with a CA certificate to trust. Repeat the flag for each file.
--orders <orders> Sets who orders from the authority, backend when the hub reaches it, or site when only the sites do.
--client-certificates Lets the authority sign the client certificates APIM presents to upstreams.
--no-client-certificates Keeps the authority from signing client certificates.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

weikio certificates authority set#

Change a certificate authority.

Terminal
weikio certificates authority set <name> [flags]
Argument or flag What it does
<name> Identifies the certificate authority.
--acme <acme> Sets the authority’s ACME directory URL.
--names <names> Sets the name suffixes, such as corp.example, comma separated or repeated.
--eab-key-id <eab-key-id> Sets the key id of the authority’s external account binding (EAB).
--eab-secret <eab-secret> Sets the name of the platform secret that has the EAB key.
--trust <trust> Adds a PEM file with a CA certificate to trust. Repeat the flag for each file.
--orders <orders> Sets who orders from the authority, backend when the hub reaches it, or site when only the sites do.
--client-certificates Lets the authority sign the client certificates APIM presents to upstreams.
--no-client-certificates Keeps the authority from signing client certificates.
--reason <reason> Stores a reason for the change with the audit record.

weikio certificates authority remove#

Remove a certificate authority.

Terminal
weikio certificates authority remove <name> [flags]
Argument or flag What it does
<name> Identifies the certificate authority.
-y, --yes Skips the confirmation.
--reason <reason> Stores a reason for the change with the audit record.

weikio settings get#

Show the installation’s settings.

Terminal
weikio settings get

Who can run it: a platform administrator.

API:

  • GET /api/v1/settings/install
  • GET /api/v1/platform/health
  • GET /api/v1/agents

Also written as weikio get settings.

weikio settings set#

Change the installation’s settings. Fields you don’t set keep their values.

A shorter retention erases a store’s older records. The command lists what it erases in each store and changes nothing until you confirm, as Storage and its budget shows.

Terminal
weikio settings set [--public-base-url URL] [--local-accounts enabled|breakGlassOnly] [--bundle-keep-versions N] [--bundle-max-age D|--no-bundle-max-age] [--default-camel-version V] [--hub-certificate NAME=CHAIN.pem,KEY.pem ...] [--remove-hub-certificate NAME ...] [--launch-property KEY=VALUE ...] [--launch-jvm-option FLAG ...] [--no-launch-defaults] [--backup-every INTERVAL] [--backup-keep N] [--backup-copy-to ADDRESS|--no-backup-copy] [--two-factor-required=true|false] [--allow-builds-without-network-limit=true|false] [--allowed-networks RANGE,...|--no-allowed-networks] [--telemetry-batch-max-bytes SIZE] [--build-heap SIZE] [--logs-retention DAYS] [--metrics-retention DAYS] [--traces-retention DAYS] [--dry-run] [-y]
Argument or flag What it does
--public-base-url <public-base-url> Sets the address Weik.io is reached at.
--local-accounts <local-accounts> Sets who can sign in with a local account, enabled or breakGlassOnly.
--bundle-keep-versions <bundle-keep-versions> Sets how many built versions of each integration to keep.
--bundle-max-age <bundle-max-age> Sets how long a built version is kept, such as 30d.
--no-bundle-max-age Removes the age limit on built versions.
--default-camel-version <default-camel-version> Sets the Camel version for integrations that don’t set one.
--backup-every <backup-every> Sets how often to take a backup archive, from 1h to 365d, such as 6h.
--backup-keep <backup-keep> Sets how many backup archives to keep on the server.
--backup-copy-to <backup-copy-to> Sets where to copy each backup archive, such as s3://acme-backups/weikio.
--no-backup-copy Keeps backup archives only on the server.
--two-factor-required Sets whether a platform administrator’s password sign-in needs a code from an authenticator app.
--allow-builds-without-network-limit Sets whether builds run on a hub server whose kernel can’t limit a build step’s network connections. Builds stop on such a server until this is true.
--allowed-networks <allowed-networks> Sets the address ranges that can reach the hub addresses, comma separated, such as 203.0.113.7/32.
--no-allowed-networks Removes the allowed networks, so every address can reach the hub.
--telemetry-batch-max-bytes <telemetry-batch-max-bytes> Sets the largest batch of telemetry the hub accepts, from 8MiB to 64MiB, such as 16MiB.
--build-heap <build-heap> Sets the most Java heap each Java process of a build uses, from 128m to 16g, such as 512m.
--logs-retention <logs-retention> Sets how long the log store keeps log lines, in days, such as 30d.
--metrics-retention <metrics-retention> Sets how long the metric store keeps metrics, in days, such as 90d.
--traces-retention <traces-retention> Sets how long the trace store keeps traces, in days, such as 7d.
--hub-certificate <hub-certificate> Adds a certificate for the hub addresses, as NAME=CHAIN.pem,KEY.pem. Repeat the flag for each certificate.
--remove-hub-certificate <remove-hub-certificate> Removes the uploaded hub certificate with this name. Repeat the flag for each certificate.
--launch-property <launch-property> Adds a Camel setting to the installation’s list that every deployment starts with, as KEY=VALUE, such as camel.main.shutdownTimeout=90. Repeat the flag for each setting.
--launch-jvm-option <launch-jvm-option> Adds a Java option that every deployment starts with, such as -Xmx512m. The options you give replace the installation’s list. Repeat the flag for each option.
--no-launch-defaults Removes the installation’s launch defaults. The --launch-property and --launch-jvm-option flags of the same command then start from an empty list.
--dry-run Prints what would happen and changes nothing.
-y, --yes Skips the confirmation.
--reason <reason> Stores a reason for the change with the audit record.

A deployment’s own Camel setting wins over the installation’s setting of the same key. The installation’s Java options come before a deployment’s own options.

Who can run it: a platform administrator.

API: PUT /api/v1/settings/install, GET /api/v1/settings/install/telemetry-retention/erasure, GET /api/v1/agents, PUT|DELETE /api/v1/settings/install/certificates/hub-certificates/{certificate}.

weikio notice set#

Set the notice at the top of every page of the admin UI. It also shows on the sign-in page and the other pages you see before you sign in. A new notice replaces the current one.

Terminal
weikio notice set <text> [--level info|warn] [--from WHEN] [--until WHEN] [--reason S]
Argument or flag What it does
<text> Sets the notice’s text, one line of at most 300 characters.
--level <level> Sets the level to info or warn. The default is info.
--from <from> Sets when the notice starts showing, as a duration from now such as 2h or a date such as 2026-11-14T08:00Z. Without it, the notice starts showing when you set it.
--until <until> Sets when the notice stops showing, as a duration from now such as 4h or a date such as 2026-11-14T10:00Z. Without it, the notice shows until you delete it.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: PUT /api/v1/notice.

Terminal
$ weikio notice set "Planned service break on 20 November, 08:00 to 10:00 UTC" --level warn --until 2026-11-20T10:00Z
You see
Target: https://hub.example
notice created (revision 270)

While the notice shows, anyone who reaches the installation from its allowed networks can read it with GET /api/v1/auth/notice without signing in.

weikio notice get#

Print the notice as the pages show it. The output also says whether it shows now and who set it.

Terminal
weikio notice get

Who can run it: a platform administrator.

API: GET /api/v1/notice.

Also written as weikio get notice.

Terminal
$ weikio notice get
You see
Text:     Planned service break on 20 November, 08:00 to 10:00 UTC
Level:    warn
From:     when it was set
Until:    2026-11-20 10:00 UTC
Showing:  yes
Set by:   admin@local (key 'init' 01m7mzdgte2nkywz5yd5cjcmd4)
Updated:  2026-11-18 16:38 UTC

weikio notice delete#

Delete the notice at the top of every page of the admin UI.

Terminal
weikio notice delete [-y] [--reason S]
Argument or flag What it does
-y, --yes Skips the confirmation.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: DELETE /api/v1/notice.

Also written as weikio delete notice.

Terminal
$ weikio notice delete
You see
Target: https://hub.example
Deleting the notice takes it off the top of every page.
Delete it? [y/N] y
notice deleted

weikio project purge#

Purge a deleted project’s telemetry. Delete the project with weikio delete project first.

The command erases nothing until you confirm the purge or give -y. It then runs until the purge finishes. At a terminal, it prints a line for each store as the purge reaches it. At the end, it prints a count for each kind of telemetry the purge erased. With --no-wait, the command returns once the purge has started.

The purge goes on when you stop the command with Ctrl-C. To follow a purge that is still running, run the same command again. You don’t confirm it a second time.

Terminal
weikio project purge <name> [-y] [--no-wait] [--reason S]
Argument or flag What it does
<name> Identifies the project by its name.
-y, --yes Skips the confirmation.
--no-wait Returns once the purge has started, without waiting for it to finish.
--reason <reason> Stores a reason for the change with the audit record.

Who can run it: a platform administrator.

API: POST /api/v1/projects/{project}/telemetry/purge to start the purge, GET /api/v1/projects/{project}/telemetry/purge to see its progress.

Exit codes#

The codes match the exit code table in the CLI reference.

Code Meaning
0 The command succeeded.
1 The command stopped without making the change.
2 The command has a usage error.
3 Your key is missing, expired or revoked, or its access doesn’t cover the command.
4 What you named doesn’t exist.
5 The change conflicts with another change.
6 Weik.io couldn’t be reached or wasn’t ready, or it was rate limiting your calls or out of storage. Run the command again later.
8 A document isn’t valid.

weikio certificates dns persist exits with code 4 while the installation has no account at the public certificate authority yet. weikio notice get and weikio notice delete exit with code 4 and print No notice is set. when there’s no notice.

See also#

Sign in to the live demo

Sign in with the shared viewer account. It can open every screen of the example projects but can't change anything.

E-mail
viewer@demo.weik.io
Password
try-weikio-live-demo
Open the live demo