Events and the entity store
Weik.io 2026.2Create event channels with the weikio CLI, and manage the events and entities each environment stores. Video
Watch: The channel: one integration publishes, another reacts, 3:49
The video has one integration publish to a channel and another react to it.
This part of the video couldn't be loaded.
On this page
- Commands on this page
- weikio get channels
- weikio channel create
- weikio channel set
- weikio delete channel
- weikio rename channel
- weikio get eventsources
- weikio get eventsubscriptions
- weikio get streams
- weikio get record
- weikio events list
- weikio events show
- weikio events purge
- weikio deadletters list
- weikio deadletters show
- weikio deadletters resend
- weikio deadletters discard
- weikio get readers
- weikio reader skip
- weikio reader rewind
- weikio events resend
- weikio entities list
- weikio entities get
- weikio entities delete
- weikio get entity-store-policies
- weikio describe entity-store-policy
- weikio entitystore policy set
- weikio entitystore policy delete
- weikio rename entity-store-policy
- Exit codes
- See also
Event channels are integrations, so you publish them with weikio apply and run them with weikio deploy. The same goes for event sources and event subscriptions.
Each environment keeps its stored events and dead letters for 30 days within its size budgets. When a budget fills, the oldest go first. Channel events count against the events budget. Set that budget with weikio env set --events-bytes.
When an integration can’t handle an event after its last retry, Weik.io keeps the event as a dead letter. Each dead letter shows the integration it failed in and the reason. Once you’ve fixed the cause, send the dead letter back to that integration with weikio deadletters resend, or delete it with weikio deadletters discard.
The entity store keeps the latest value of each entity of a type, within the limits of the type’s policy in each environment.
Commands on this page#
| Command | What it does |
|---|---|
weikio get channels |
List a project’s event channels with their publishers and readers. |
weikio channel create |
Create an event channel. |
weikio channel set |
Change an event channel. |
weikio delete channel |
Delete an event channel that isn’t deployed, together with its versions. The command also deletes the channel’s own variables and secrets. |
weikio rename channel |
Rename an event channel. |
weikio get eventsources |
List the event sources of a project. |
weikio get eventsubscriptions |
List the event subscriptions of a project. |
weikio get streams |
List the usage and limits of an environment’s event streams and dead letters, and of each entity type’s store. |
weikio get record |
Print a record’s kind and address from its ID. |
weikio events list |
List an environment’s stored events. |
weikio events show |
Print one stored event. |
weikio events purge |
Delete the stored events that match the filters. |
weikio deadletters list |
List the dead letters of an environment. |
weikio deadletters show |
Print one dead letter with its event. |
weikio deadletters resend |
Resend dead letters to the integrations they failed in. |
weikio deadletters discard |
Discard dead letters. |
weikio get readers |
List the readers of the integrations deployed in an environment and how far each has read. |
weikio reader skip |
Skip every event the integration’s reader hasn’t handled yet, so the reader receives only the events published from now on. |
weikio reader rewind |
Deliver a reader’s events again from a sequence number. |
weikio events resend |
Publish stored events again. |
weikio entities list |
List the entities of one type in ID order. |
weikio entities get |
Print one entity. |
weikio entities delete |
Delete one entity. |
weikio get entity- |
List an environment’s entity types with their policies and usage. |
weikio describe entity- |
Show an entity type’s policy and usage. |
weikio entitystore policy set |
Create an entity type in an environment, or change its policy. |
weikio entitystore policy delete |
Delete an entity type and its entities from an environment. |
weikio rename entity- |
Rename an entity type in every environment that has it. |
The tables below leave out the flags every command accepts, such as --env and --project, which the CLI reference lists.
weikio get channels#
List a project’s event channels with their publishers and readers.
weikio get channels [--project P]Who can run it: a grant on the project whose role has read.
API: GET /api/v1/projects/{project}/channels.
Also written as weikio get eventchannels.
$ weikio get channels --project sandboxNAME TYPE DESCRIPTION RETENTION PUBLISHERS READERS CLOUDEVENTS
alerts http - 30d - - binary
plain - - 30d - - -CLOUDEVENTS shows the content mode of a channel with a sink.
weikio channel create#
Create an event channel.
weikio channel create <p>/<name> [--type T] [--param k=v ...] [--cloud-events binary|structured] [--description S] [--retention 30d|0]| Argument or flag | What it does |
|---|---|
<channel> |
Sets the new channel’s name, as project/name. |
--type <type> |
Sets the sink kamelet the channel delivers to, without its -sink suffix, such as http. Give ‘’ for no sink. |
-- |
Sets a sink parameter, as key=value. Repeat it for each parameter. |
-- |
Sets the CloudEvents content mode the sink receives events in, binary or structured. The default is binary. |
-- |
Sets a description of what the channel is for. |
-- |
Sets how long Weik.io keeps events, by default the environment’s 30d. Give 0 to store none. |
-- |
Stores a reason for the change with the audit record. |
Who can run it: a grant on the project whose role has author.
API: PUT /api/v1/configuration.
Also written as weikio create channel.
$ weikio apply -f ./finance/events/Target: https://hub.example, project finance (from finance/project.yaml)
event-channel finance/invoice-created unchanged
event-channel finance/invoice-alerts created (version 0.1.0, built in 14.2 s, delivers to slack)
event-source finance/invoice-files created (version 0.1.0, built in 16.8 s, aws-s3 -> invoice-files)
event-subscription finance/files-to-invoices created (version 0.1.0, built in 15.1 s, invoice-files -> invoice-created)
event-subscription finance/alert-on-invoices created (version 0.1.0, built in 14.9 s, invoice-created -> invoice-alerts)
Nothing new is running yet. To run it:
weikio deploy -f ./finance/events --env devtest$ weikio deploy -f ./finance/events --env devtestTarget: https://hub.example, project finance (from finance/project.yaml), environment devtest (--env)
Deploying finance/invoice-alerts 0.1.0 (latest) to devtest...
Deploying finance/invoice-files 0.1.0 (latest) to devtest...
Deploying finance/files-to-invoices 0.1.0 (latest) to devtest...
Deploying finance/alert-on-invoices 0.1.0 (latest) to devtest...
deployment devtest/finance/invoice-alerts created (version 0.1.0)
deployment devtest/finance/invoice-files created (version 0.1.0)
deployment devtest/finance/files-to-invoices created (version 0.1.0)
deployment devtest/finance/alert-on-invoices created (version 0.1.0)weikio channel set#
Change an event channel.
weikio channel set <p>/<name> [--type T] [--param k=v ...] [--cloud-events binary|structured] [--description S] [--retention 30d|0]| Argument or flag | What it does |
|---|---|
<channel> |
Identifies the channel, as project/name. |
--type <type> |
Sets the sink kamelet the channel delivers to, without its -sink suffix, such as http. Give ‘’ for no sink. |
-- |
Sets a sink parameter, as key=value. Repeat it for each parameter. |
-- |
Sets the CloudEvents content mode the sink receives events in, binary or structured. The default is binary. |
-- |
Sets a description of what the channel is for. |
-- |
Sets how long Weik.io keeps events, by default the environment’s 30d. Give 0 to store none. |
-- |
Stores a reason for the change with the audit record. |
Who can run it: a grant on the project whose role has author.
API:
PUT /api/v1/configurationGET /api/v1/projects/{project}/channelsGET /api/v1/environments/{environment}/projects/{project}/deployments
weikio delete channel#
Delete an event channel that isn’t deployed, together with its versions. The command also deletes the channel’s own variables and secrets.
weikio delete channel <p>/<name> [-y]| Argument or flag | What it does |
|---|---|
<channel> |
Identifies the channel, as project/name. |
-y, --yes |
Skips the confirmation. |
-- |
Stores a reason for the change with the audit record. |
Who can run it: a grant on the project whose role has author.
API:
GET /api/v1/projects/{project}/integrations/{name}DELETE /api/v1/projects/{project}/integrations/{name}?dryRun=trueDELETE /api/v1/projects/{project}/integrations/{name}
Also written as weikio delete eventchannel.
weikio rename channel#
Rename an event channel.
weikio rename channel <p>/<name> <new-name>| Argument or flag | What it does |
|---|---|
<channel> |
Identifies the channel, as project/name. |
<new- |
Sets the new name in the same project. |
-- |
Stores a reason for the change with the audit record. |
Who can run it: a grant on the project whose role has author.
API: GET /api/v1/projects/{project}/integrations/{name}, PATCH /api/v1/projects/{project}/integrations/{name}.
weikio get eventsources#
List the event sources of a project.
weikio get eventsources [--project P]Who can run it: a grant on the project whose role has read.
API: GET /api/v1/projects/{project}/integrations?type=event-source, GET /api/v1/projects/{project}/integrations/{name}/status.
weikio get eventsubscriptions#
List the event subscriptions of a project.
weikio get eventsubscriptions [--project P]Who can run it: a grant on the project whose role has read.
API: GET /api/v1/projects/{project}/integrations?type=event-subscription, GET /api/v1/projects/{project}/integrations/{name}/status.
weikio get streams#
List the usage and limits of an environment’s event streams and dead letters, and of each entity type’s store.
weikio get streams [--env E]Who can run it: a grant whose role has read in the environment.
API: GET /api/v1/environments/{environment}/streams.
weikio get record#
Print a record’s kind and address from its ID.
weikio get record <id>| Argument or flag | What it does |
|---|---|
<id> |
Identifies the record by its ID. weikio describe and a listing with -o json show the ID, as do an audit record and the admin UI’s detail pages. |
Who can run it: any API key, but the command shows only the records the key can read.
API: GET /api/v1/records/{uid}.
weikio events list#
List an environment’s stored events.
| Family | Events |
|---|---|
ev |
Channel events |
hook |
Webhook receipts |
mft |
Transfer run records |
schedule |
Schedule run records |
es |
Entity store changes |
weikio events list [<p>/<channel>] [--env E] [--family ev|hook|mft|schedule|es] [--api A] [--integration N] [--type <p>/<type>] [--record-id ID] [--since 1h | --from T --to T] [--before STREAM.SEQ | --after STREAM.SEQ] [--order newest|oldest] [--source <p>/<n>] [--with-body] [--limit N]| Argument or flag | What it does |
|---|---|
<channel> |
Identifies the channel, as project/name. |
-- |
Shows only the events of one family, such as ev. |
--api <api> |
Lists the webhook receipts of this API. |
-- |
Lists the runs of this transfer or schedule, as project/name. |
--type <type> |
Lists only the entity store changes of this entity type, as project/type. |
-- |
Lists the events of an integration or API by its ID, deleted or not, including the events it published. |
-- |
Shows the events stored before this position, as stream.seq, such as events.48213. |
-- |
Shows the events stored after this position, as stream.seq, such as events.48213. |
-- |
Sorts the events newest or oldest first. The default is newest first. |
-- |
Shows only the events this integration published, as project/name. |
-- |
Prints each event’s body in its row. |
-- |
Sets how far back to read, such as 1h. |
--from <from> |
Sets the start of the window. |
--to <to> |
Sets the end of the window. |
-- |
Sets how many events to read, at most 1,000. |
Who can run it: a grant whose role has read in the environment.
API: GET /api/v1/environments/{environment}/events?family=&channel={p}/{name}&project={p}&api=&integration=&type={p}/{type}&recordUid=&from=&to=&source={p}/{name}&withBody=true&limit=&before=&after=&order=.
$ weikio events list finance/invoice-created --env production --since 1hSEQ STREAM TIME FAMILY SOURCE AGENT BYTES RESEND OF
48211 events 2026-09-16 13:02:11 UTC ev finance/erp-invoice-export agent-fi-02 1204 -
48212 events 2026-09-16 13:03:11 UTC ev finance/erp-invoice-export agent-fi-02 1187 -
48213 events 2026-09-16 13:04:40 UTC ev finance/invoice-files agent-fi-02 2310 -weikio events show#
Print one stored event.
weikio events show [<p>/<channel>] [--env E] [--stream S] --seq N [--raw]| Argument or flag | What it does |
|---|---|
<channel> |
Identifies the channel the event belongs to, as project/name. |
-- |
Sets the event’s stream as events or entities, which the STREAM column shows. The default is events when you give a channel. |
--seq <seq> |
Identifies the event by its sequence number in its stream. |
--raw |
Prints the body as it was stored. |
Who can run it: a grant whose role has read in the environment.
API: GET /api/v1/environments/{environment}/streams/{stream}/events/{seq}.
$ weikio events show finance/invoice-created --env production --seq 48213Seq: 48213
Subject: weikio.data.01k5h2m8q3x7c9d4f6g1j0n2p4.ev.01k5h2n1r6t8v0w2y4z6a8b0c2.01k5h3a7b9d1f3g5h7j9k1m3n5
Time: 2026-09-16 13:04:40 UTC
Source: finance/invoice-files
Headers: Content-Type: application/json
Weikio-Agent-Id: 7c1e...
Weikio-Source: finance/invoice-files
{
"invoiceId": "INV-2026-0912",
...
}weikio events purge#
Delete the stored events that match the filters. Use it to remove events before the environment’s retention would, for example a webhook body with personal data.
Weik.io writes each purge to the audit log. If a purge runs longer than 10 minutes, run it again to finish it.
weikio events purge [<p>/<channel>] [--env E] [--family ev|hook|mft|schedule|es] [--api A] [--integration N] [--type <p>/<type>] [--record-id ID] [-y]| Argument or flag | What it does |
|---|---|
<channel> |
Identifies the channel, as project/name. |
-- |
Removes only the events of one family, such as ev. |
--api <api> |
Removes the webhook receipts of this API. |
-- |
Removes the runs of this transfer or schedule, as project/name. |
--type <type> |
Removes only the entity store changes of this entity type, as project/type. |
-- |
Removes the events of an integration or API by its ID, deleted or not, including the events it published. |
-y, --yes |
Skips the confirmation. |
-- |
Stores a reason for the change with the audit record. |
Who can run it: a grant whose role has operate in the environment.
API: POST /api/v1/environments/{environment}/streams/{stream}/events/_purge.
weikio deadletters list#
List the dead letters of an environment.
weikio deadletters list [<p>/<channel>] [--env E] [--integration P/N | --record-id ID] [--since 1h | --from T --to T] [--before SEQ | --after SEQ] [--order newest|oldest] [--limit N]| Argument or flag | What it does |
|---|---|
<channel> |
Identifies the channel the events came from, as project/name. |
-- |
Identifies the integration the events failed in, as project/name. |
-- |
Identifies the integration the events failed in by its ID, deleted or not. |
-- |
Shows the dead letters that failed less than this long ago, such as 1h. |
--from <from> |
Sets the start of the time range in which the dead letters failed. |
--to <to> |
Sets the end of the time range in which the dead letters failed. |
-- |
Shows the dead letters older than this sequence number. |
-- |
Shows the dead letters newer than this sequence number. Give 0 to start from the oldest. |
-- |
Sorts the dead letters newest or oldest first. The default is newest first. |
-- |
Sets how many dead letters to read, at most 1,000. |
Who can run it: a grant whose role has read in the environment.
API: GET /api/v1/environments/{environment}/dead-letters?project={p}&integration={n}&recordUid=&channel={p}/{name}&from=&to=&limit=&before=&after=&order=.
weikio deadletters show#
Print one dead letter with its event.
weikio deadletters show --seq N [--env E] [--raw]| Argument or flag | What it does |
|---|---|
--seq <seq> |
Identifies the dead letter by its sequence number from the SEQ column. |
--raw |
Prints the event’s body as it was stored. |
Who can run it: a grant whose role has read in the environment.
API: GET /api/v1/environments/{environment}/dead-letters/{seq}.
weikio deadletters resend#
Resend dead letters, each only to the integration it failed in. Weik.io removes a dead letter once it’s sent.
weikio deadletters resend (--seq N [--seq N ...] | [<p>/<channel>] [--integration P/N | --record-id ID] [--since 1h | --from T --to T] | --all) [--env E] [-y]| Argument or flag | What it does |
|---|---|
<channel> |
Identifies the channel the events came from, as project/name. |
--seq <seq> |
Resends the dead letter with this sequence number. Repeat it for each dead letter. |
--all |
Resends every dead letter you may act on. |
-y, --yes |
Skips the confirmation. |
-- |
Stores a reason for the change with the audit record. |
-- |
Identifies the integration the events failed in, as project/name. |
-- |
Identifies the integration the events failed in by its ID, deleted or not. |
-- |
Resends only the dead letters that failed less than this long ago, such as 1h. |
--from <from> |
Sets the start of the time range in which the dead letters failed. |
--to <to> |
Sets the end of the time range in which the dead letters failed. |
Who can run it: a grant whose role has operate in the environment.
API:
- With
--seq,GET /api/v1/environments/{environment}/dead-letters/{seq}, thenPOST /api/v1/environments/{environment}/dead-letters/{seq}/resendfor each dead letter - With a filter or
--all,POST /api/v1/environments/{environment}/dead-letters/_resend?dryRun=true, thenPOST /api/v1/environments/{environment}/dead-letters/_resend
weikio deadletters discard#
Discard dead letters.
weikio deadletters discard (--seq N [--seq N ...] | [<p>/<channel>] [--integration P/N | --record-id ID] [--since 1h | --from T --to T] | --all) [--env E] [-y]| Argument or flag | What it does |
|---|---|
<channel> |
Identifies the channel the events came from, as project/name. |
--seq <seq> |
Discards the dead letter with this sequence number. Repeat it for each dead letter. |
--all |
Discards every dead letter you may act on. |
-y, --yes |
Skips the confirmation. |
-- |
Stores a reason for the change with the audit record. |
-- |
Identifies the integration the events failed in, as project/name. |
-- |
Identifies the integration the events failed in by its ID, deleted or not. |
-- |
Discards only the dead letters that failed less than this long ago, such as 1h. |
--from <from> |
Sets the start of the time range in which the dead letters failed. |
--to <to> |
Sets the end of the time range in which the dead letters failed. |
Who can run it: a grant whose role has operate in the environment.
API:
- With
--seq,GET /api/v1/environments/{environment}/dead-letters/{seq}, thenDELETE /api/v1/environments/{environment}/dead-letters/{seq}for each dead letter - With a filter or
--all,POST /api/v1/environments/{environment}/dead-letters/_discard?dryRun=true, thenPOST /api/v1/environments/{environment}/dead-letters/_discard
weikio get readers#
List the readers of the integrations deployed in an environment and how far each has read.
weikio get readers [<p>/<channel>] [--integration <p>/<n>] [--env E] [--project P]| Argument or flag | What it does |
|---|---|
<channel> |
Identifies the channel that is read, as project/name or, inside the project, as the name alone. |
-- |
Identifies the reading integration, as project/name or, inside the project, as the name alone. |
Who can run it: a grant whose role has read in the environment.
API: GET /api/v1/environments/{environment}/readers?project={p}&integration={n}&channel={p}/{name}.
weikio reader skip#
Skip every event the integration’s reader hasn’t handled yet, so the reader receives only the events published from now on. Use it when a reader is far behind and those events no longer matter. Before you confirm, the command prints how many events it skips.
weikio reader skip <p>/<integration> [--channel C | --transfer T | --schedule S | --type T] [--env E] [-y]| Argument or flag | What it does |
|---|---|
<integration> |
Identifies the deployed integration, as project/name. |
-- |
Identifies the reader that receives events from this channel, as project/name or, inside the integration’s project, as the name alone. |
-- |
Identifies the reader that receives this transfer’s records, as project/name or, inside the integration’s project, as the name alone. |
-- |
Identifies the reader that receives this schedule’s runs, as project/name or, inside the integration’s project, as the name alone. |
--type <type> |
Identifies the reader that receives this entity type’s changes, as project/type or, inside the integration’s project, as the type alone. |
-y, --yes |
Skips the confirmation. |
-- |
Stores a reason for the change with the audit record. |
Who can run it: a grant whose role has operate in the environment.
API: POST /api/v1/environments/{environment}/projects/{project}/deployments/{name}/readers/skip?channel=&transfer=&schedule=&type=&dryRun=true, POST /api/v1/environments/{environment}/projects/{project}/deployments/{name}/readers/skip?channel=&transfer=&schedule=&type=.
weikio reader rewind#
Deliver a reader’s events again from a sequence number. Use it to process events again from a known point, for example after fixing a bug in the reader. Take the sequence number from the SEQ column of weikio events list.
weikio reader rewind <p>/<integration> [--channel C | --transfer T | --schedule S | --type T] --to-seq N [--env E] [-y]| Argument or flag | What it does |
|---|---|
<integration> |
Identifies the deployed integration, as project/name. |
-- |
Identifies the reader that receives events from this channel, as project/name or, inside the integration’s project, as the name alone. |
-- |
Identifies the reader that receives this transfer’s records, as project/name or, inside the integration’s project, as the name alone. |
-- |
Identifies the reader that receives this schedule’s runs, as project/name or, inside the integration’s project, as the name alone. |
--type <type> |
Identifies the reader that receives this entity type’s changes, as project/type or, inside the integration’s project, as the type alone. |
-- |
Delivers the events again from this sequence number, which the SEQ column shows. |
-y, --yes |
Skips the confirmation. |
-- |
Stores a reason for the change with the audit record. |
Who can run it: a grant whose role has operate in the environment.
API: POST /api/v1/environments/{environment}/projects/{project}/deployments/{name}/readers/rewind?channel=&transfer=&schedule=&type=&toSeq=&dryRun=true, POST /api/v1/environments/{environment}/projects/{project}/deployments/{name}/readers/rewind?channel=&transfer=&schedule=&type=&toSeq=.
weikio events resend#
Publish stored events again. Every reader of the channel receives a resent event, which carries a Weikio-Resend-Of header that refers to the original.
weikio events resend [<p>/<channel>] [--env E] [--stream S] --seq N [--seq N ...] [--to <p>/<integration>] [--dry-run] [-y]| Argument or flag | What it does |
|---|---|
<channel> |
Identifies the channel, as project/name. |
-- |
Sets the event’s stream as events or entities, which the STREAM column shows. The default is events when you give a channel. |
--seq <seq> |
Resends the event with this sequence number. Repeat it for each event. |
--to <to> |
Sends the event only to this integration, as project/name. The default is every integration that receives the event. |
-- |
Prints what would happen and changes nothing. |
-y, --yes |
Skips the confirmation. |
-- |
Stores a reason for the change with the audit record. |
Who can run it: a grant whose role has operate in the environment.
API: POST /api/v1/environments/{environment}/streams/{stream}/events/{seq}/resend.
$ weikio events resend finance/invoice-created --env production --seq 48213 -yTarget: https://hub.example, project finance (argument), environment production (--env)
event 48213 resent as 48397 (Weikio-Resend-Of: 48213)weikio entities list#
List the entities of one type in ID order.
weikio entities list <p>/<type> [--env E] [--updated-since T] [--id-prefix S] [--limit N] [--after ID | --before ID]| Argument or flag | What it does |
|---|---|
<type> |
Identifies the entity type, as project/type. |
-- |
Shows the entities updated since this time, such as 1h or 2026-09-01. |
-- |
Shows only the entities whose ID starts with this text. |
-- |
Sets how many entities to read, at most 1,000. |
-- |
Shows the entities before this ID. |
-- |
Shows the entities after this ID. |
Who can run it: a grant whose role has read in the environment.
API: GET /api/v1/environments/{environment}/projects/{project}/entities/{type}?updatedSince&idPrefix&limit&before&after.
weikio entities get#
Print one entity.
weikio entities get <p>/<type> <id> [--env E] [--revisions]| Argument or flag | What it does |
|---|---|
<type> |
Identifies the entity type, as project/type. |
<id> |
Identifies the entity by its ID. |
-- |
Prints the entity’s kept revisions, newest first. |
Who can run it: a grant whose role has read in the environment.
API: GET /api/v1/environments/{environment}/projects/{project}/entities/{type}/{id}.
weikio entities delete#
Delete one entity.
weikio entities delete <p>/<type> <id> [--env E] [-y]| Argument or flag | What it does |
|---|---|
<type> |
Identifies the entity type, as project/type. |
<id> |
Identifies the entity by its ID. |
-y, --yes |
Skips the confirmation. |
-- |
Stores a reason for the change with the audit record. |
Who can run it: a grant whose role has operate in the environment.
API: DELETE /api/v1/environments/{environment}/projects/{project}/entities/{type}/{id}.
weikio get entity-store-policies#
List an environment’s entity types with their policies and usage.
weikio get entity-store-policies [--env E] [--project P]Who can run it: a grant whose role has read in the environment.
API: GET /api/v1/environments/{environment}/entity-store, GET /api/v1/environments/{environment}/projects/{project}/entity-store.
weikio describe entity-store-policy#
Show an entity type’s policy and usage.
weikio describe entity-store-policy <p>/<type> [--env E]| Argument or flag | What it does |
|---|---|
<type> |
Identifies the entity type, as project/type. |
Who can run it: a grant whose role has read in the environment.
API: GET /api/v1/environments/{environment}/projects/{project}/entity-store/{type}/policy.
weikio entitystore policy set#
Create an entity type in an environment, or change its policy. The --max-bytes of all the environment’s entity types together can’t exceed its entity store budget. Set that budget with weikio env set --entity-store-bytes.
weikio entitystore policy set <p>/<type> [--env E] [--max-bytes SIZE] [--max-age LENGTH] [--history N] [--max-value-bytes SIZE] [-y]| Argument or flag | What it does |
|---|---|
<type> |
Identifies the entity type, as project/type. |
-- |
Sets the maximum size the type may take, such as 512MiB. |
-- |
Sets the maximum age of an entity, such as 30d. |
-- |
Sets how many values of an entity Weik.io keeps, counting the current one. |
-- |
Sets the maximum size of one entity, such as 64KiB. |
-y, --yes |
Skips the confirmation. |
-- |
Stores a reason for the change with the audit record. |
Who can run it: a grant whose role has entity-store-policy in the environment.
API: PUT /api/v1/environments/{environment}/projects/{project}/entity-store/{type}/policy.
$ weikio entitystore policy set finance/invoice --env production --max-bytes 512MiB --history 2 -yTarget: https://hub.example, project finance (argument), environment production (--env)
entity-store-policy production/finance/invoice created (maxBytes 512 MiB, history 2, revision 57)
production entity store budget: 512 MiB of 2 GiB allocatedweikio entitystore policy delete#
Delete an entity type and its entities from an environment.
weikio entitystore policy delete <p>/<type> [--env E] [-y]| Argument or flag | What it does |
|---|---|
<type> |
Identifies the entity type, as project/type. |
-y, --yes |
Skips the confirmation. |
-- |
Stores a reason for the change with the audit record. |
Who can run it: a grant whose role has entity-store-policy in the environment.
API: DELETE /api/v1/environments/{environment}/projects/{project}/entity-store/{type}/policy.
weikio rename entity-store-policy#
Rename an entity type in every environment that has it.
weikio rename entity-store-policy <p>/<type> <new-name>| Argument or flag | What it does |
|---|---|
<type> |
Identifies the entity type, as project/type. |
<new- |
Sets the new name. |
-- |
Stores a reason for the change with the audit record. |
Who can run it: a grant whose role has entity-store-policy in the environment.
API: PATCH /api/v1/projects/{project}/entity-store/{type}.
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. |