For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DashboardProduct
DocsAPI ReferenceArchitecture
DocsAPI ReferenceArchitecture
  • Start here
    • What is Panicly?
    • Core concepts
    • Quickstart
    • Component gallery
  • Product workflows
    • Gateway lifecycle
    • Controls and policies
    • Usage and billing
    • Dashboard guide
  • Changelog
    • Changelog
LogoLogo
DashboardProduct
On this page
  • Preferred naming
Start here

Core concepts

Normalize Panicly product vocabulary before implementing or operating it
||View as Markdown|
Was this page helpful?
Edit this page
Previous

What is Panicly?

Next

Quickstart

Built with

Current docs should prefer the new product names: Sentry Mode, Network Controls, Region Rules, Workspace Audit, Requests, Usage, Credits, Rules, Models, and Insights.

workspace
organization boundaryRequired

The top-level operator boundary. It owns plan tier, members, projects, billing state, credits, audit events, and global controls.

project
routable unitRequired

A protected unit of traffic inside a workspace. It owns environment, Panicly API keys, provider connection, thresholds, and request history.

panicly_api_key
secretRequired

The credential your app sends to Panicly. Keys are project-scoped, returned once, and stored as prefix plus hash.

provider_key
secretRequired

The upstream provider credential Panicly uses for approved requests. Current storage allows one provider key per project.

sentry_mode
boolean

The public emergency stop control. The database column still uses the older panic_mode name.

credit_backed_capacity
usage balance

Paid workspace capacity used after included monthly request volume is exceeded. The repo still mixes “requests”, “logs”, and “credit-backed logs”, so docs must define this carefully.

Preferred naming

Current product names
Legacy or internal names
Use thisMeaning
Sentry ModeEmergency traffic stop
Network ControlsSender IP blocking and inspection
Region RulesCountry and Panicly-defined region blocking
Workspace AuditOperator-visible change history
ProPublic paid plan name

Why does plus appear in code if the plan is called Pro?

The internal tier key is plus, but the public-facing plan name is Pro. Public docs should use Pro and mention plus only in internal implementation contexts.

Why are requests and logs both used?

Plan limits are request-based, while credit packages include fields named logAllowance. Public usage docs should describe included monthly requests separately from credit-backed capacity.

Can one project connect multiple providers?

Not today. The schema currently has a unique provider-key row per project, so docs should not promise multi-provider project configuration.