Expand description
One function per Core route, no logic beyond building the request and decoding the
envelope. Modules follow ../core/src/api/router.ts (non-admin routes only).
Structs§
- Audit
LogFilter - Filters and page for
AuditLogs::list. Every field is optional; together they narrow. Admin-only filters (core_id,nats_seq,ip) are not here. - Audit
Logs - Audit log routes, from
Client::audit_logs. - Certificates
- TLS certificates of zones, from
Client::certificates. - Client
Identities - Client identity routes, from
Client::client_identities. - Client
Identity Filter - Optional filters for
ClientIdentities::list. - Free
Domains - Free domain routes, from
Client::free_domains. They work without an API key. - Geo
- Geo route, from
Client::geo. - GeoBans
- Geo ban routes, from
Client::geo_bans. - Health
Checks - Health check routes, from
Client::health_checks. - Page
Request - Page selection for paginated lists.
Noneleaves Core’s default. - Record
Filter - Optional filters for
Records::list. - Records
- Record routes, from
Client::records. - Redirects
- HTTP(S) redirects by host name, from
Client::redirects. - Sinkhole
Link Filter - Optional filters for
SinkholeLinks::list. - Sinkhole
Links - Sinkhole link routes, from
Client::sinkhole_links: which lists apply to which client identities. - Sinkhole
Lists - Sinkhole list routes, from
Client::sinkhole_lists. - Sinkhole
Roles - Sinkhole rule routes, from
Client::sinkhole_roles(Core calls rules “roles”). - Stats
- Statistics routes, from
Client::stats. - Stats
Series Query - Range and shape of a series query. Core aligns the range to 10 minutes; data is kept 90 days and a range may span at most 92 days.
- Stats
TopQuery - Range and size of a top-list query.
- Users
- The caller’s own user account, from
Client::users. - Zone
Members - Who has access to a zone, from
Client::zone_members. - Zones
- Zone routes, from
Client::zones.
Enums§
- Client
Scope - Which client identities a client statistic covers.
- Stats
Group - How series are split (
group_by). Each route takes only some of them (see the method); Core answersErrorCode::Validationfor others. - Stats
Mode - What series point values are (
mode). - Stats
Step - Step of a series.
Auto(Core’s default) picks the smallest step with at most 300 points; a range may have at most 2000 points.