Portal guide

Namespaces

The Namespaces page lists your namespaces with their recent traffic, and is where an administrator creates, renames, disables, deletes and restores them.

What this page is for#

A namespace is one TERSL state with its own record, its own grants and its own address on the API. The Namespaces page (/namespaces) lists them with their recent traffic and size, and links each one to the pages that work on it. An administrator also creates namespaces here and changes their status. The portal opens on this page after you sign in.

Who can see it#

Every signed-in user. An administrator sees every namespace in the account and every action. A limited user sees only the namespaces that a key they hold reaches, with the sentence "These are the namespaces the keys you hold can reach.", and has no actions that change a namespace.

What is on the page#

The usage panel#

Administrators see a panel above the namespaces. It names the plan (Plan followed by the plan's name, which links to Account), the number of requests this month and the data out this month, and a bar chart of requests per day over the last 30 days. The month figures are usage totals since the start of the calendar month in UTC, not an allowance; the plan's limits refill continuously and have no reset date (see Plans, rates and limits). Green, orange and red in each bar are requests that were ok, throttled and refused. Chips below the chart give the 30-day totals, and rolled up says how old the figures are. A new account shows not yet computed until the first figures are ready.

Card view and list view#

Two buttons at the top switch between Card view and List view. Both show the same namespaces, newest first.

Each card shows the namespace's name (or its Namespace Id when it has no name), a Rename link for administrators, and a status chip. Below that is the Namespace Id, a seven-character identifier such as 74XEEJ5, and, for a copy, a line such as "Copied from 1234567 at csn 12". An active namespace is marked live.

The card's statistics are the requests in the last settled minute (req/min), how many requests in the last hour were throttled or delayed by the plan's rates, a 60-minute bar chart, and chips for the hour's ok, throttled and refused requests. A further line shows the namespace's size, how many requests were in flight or queued, how many distinct keys were seen in five minutes, bytes out and in over the hour, and the newest CSN. These come from samples taken while the namespace is in use; a namespace that has not been addressed shows no sample yet, and one that has gone quiet shows quiet. Hover over a figure to see what it measures. The figures refresh while the page is open.

Under the statistics are Created, Access and Record. Access says how many keys the namespace's grants name, read when the page loaded: "2 key(s) granted", or Grant… when none is named. For an administrator it links to the Grants page. Record holds the namespace's actions (see below).

The list view is a table with the columns Name, Namespace Id, Status, Keys, Req/min, Last hour, Size, Created and Record. Click a column header to sort, and type in Filter by name or Namespace Id to narrow the rows.

The status chip#

Chip Meaning
Active The namespace serves requests.
Disabled Requests to it are refused with an empty 404 until it is enabled. Nothing is removed.
Forking A copy is being made into this namespace; it serves nothing until the copy finishes.
Deleted It is deleted and in its grace period; it serves nothing and can be restored until the date shown.
Removing It is being deleted for good. The card shows progress, such as "Removing… 12 / 40".

A namespace whose record keeps entries immutable for a retention window cannot be removed before the window ends; its line then says "held until" a date, followed by "(WORM)".

Deleted namespaces#

When any namespace is deleted, a Deleted (n) link appears below the list. It opens a view of the deleted namespaces, with "← Namespaces" to return. Each deleted namespace says when and by whom it was deleted and "restorable until" a date.

Actions#

The actions that change a namespace are for administrators.

Add a namespace#

Press Add namespace (the button, or the last card). In the flyout, type a Name of up to 200 characters and press Add. You choose only the name; the seven-character Namespace Id is assigned when you add it (see What TERSL/DB is). The page then says, for example, "Added Orders — Namespace Id 74XEEJ5."

A new namespace starts with a grants document that admits nobody, so no key can reach it until you grant one on the Grants page. When the account has as many active namespaces as the plan allows, the button is disabled and its caption says "Your plan allows N namespaces." Disabled and deleted namespaces do not count toward that limit.

Rename#

Press Rename on a card (or in a list row), change the name and press Save. The name is the namespace's display name in every picker and in its grants document. The Namespace Id never changes.

Disable and enable#

Press Disable. The card asks "Disable 74XEEJ5? Requests to it are refused until it is enabled again. Nothing is removed." and you confirm with Disable. Within a few seconds the API answers every request to the namespace with an empty 404, as if it did not exist.

Enable asks "Enable 74XEEJ5? It starts serving requests again." Enabling counts toward the plan's namespace limit; at the limit the page says "Your plan allows N namespaces. Delete one to enable this one." A copy that failed part-way cannot be enabled, only deleted.

Delete#

Press Delete…. The card asks, for example, "Delete Orders (74XEEJ5)? It stops serving requests now. You can restore it until date; after that it is deleted for good.", where date is the end of the grace period. Confirm with Delete. Within a few seconds the namespace stops serving requests, and it moves to Deleted (n). Its data, record and grants stay in place until the date shown, and the namespace no longer counts toward the plan's limit.

A namespace from which a copy is being made cannot be deleted until that copy is Active, and a namespace that is still being made as a copy cannot be deleted either; the page says which.

Restore#

In the Deleted (n) view, press Restore. The namespace comes back Disabled, with the message "Restored. Enable it to serve requests again." and an Enable button. A restored copy that never finished says "Restored. This copy did not finish: it can be deleted, not enabled." Once the removal has started the page says "Too late to restore: it is being deleted for good."

Delete now#

In the Deleted (n) view, Delete now… opens a flyout titled "Delete namespace 74XEEJ5". It says "This permanently deletes the namespace, its record, its data, its grants and its seals from this service. This action cannot be undone." Type the Namespace Id in the field and press Delete namespace. Removal starts at once and cannot be restored. On a deployment configured with no grace period, Delete… opens this flyout directly.

Open a namespace in another page#

The Record row of each card links to the pages that work on the namespace, with it preselected:

  • Explore opens the Explorer.
  • History opens its record.
  • Copy at… (administrators, active namespaces) opens History with the copy form ready at the newest CSN; see Copy.
  • Copies (n) (administrators) lists the copies made from this namespace.
  • Keys opens the Keys page filtered to the keys granted here.
  • Logs opens the namespace's customer log.