egdata API
Endpoint histories

v1 getChangelogEntry

History for GET /v1/changelist/{id}

GET /v1/changelist/{id} — active. Recorded dates are not deployment dates.

2026-11-16 — Accept dashboard console session key identities on v1 endpoints

Record: console-session-v1-key-context.

  • v1 GET /v1/changelist/{id} (getChangelogEntry; fixed; compatible)
    • Before: Requests authenticated via an ephemeral dashboard console session sent a console_<projectId> key identity that the v1 origin rejected with HTTP 401 MISSING_KEY_CONTEXT.
    • After: The v1 origin accepts verified gateway console_<projectId> identities alongside key_<id> identities, allowing authenticated dashboard Try It console requests to succeed with the same project permissions and quotas.
    • Client action: None

Verification: tests/v1-origin-provenance.test.ts; tests/v1-router.test.ts; dashboard/tests/console-sessions.test.ts.

2026-11-13 — Fix container startup after Aikido removal

Record: fix-container-startup; corrects remove-aikido-runtime.

  • v1 GET /v1/changelist/{id} (getChangelogEntry; fixed; compatible)
    • Before: After removal of the Aikido dependency, both Docker image startup commands still preloaded @aikidosec/firewall/instrument. Containers exited with MODULE_NOT_FOUND before listening, causing origin-backed requests to fail with gateway errors.
    • After: Both Docker images start Node directly with source maps and dist/index.js, restoring origin availability without the removed preload. Existing route contracts, authentication, origin access controls, gateway quotas and custom anti-abuse behavior are preserved. Responses handled entirely at the gateway are unaffected.
    • Client action: Retry requests that failed during the outage. No request format or authentication changes are required.

Verification: Dockerfile; Dockerfile-Google; package.json; pnpm release:check --base 8ef79d0; Live GET https://api.egdata.app/health returned 200 with healthy Redis and MongoDB after correcting the service startup arguments.; Live GET https://api.egdata.app/countries returned 200 after correcting the service startup arguments..

2026-11-13 — Enforce Free/Pro/Scale paid plans, server entitlements, period budgets, and Stripe billing

Record: paid-plans-and-billing.

  • v1 GET /v1/changelist/{id} (getChangelogEntry; changed; compatible)
    • Before: Version 1 gateway admission enforced Free/Pro/Enterprise RPM and monthly quota without server-side plan entitlement gates, Scale tier support, or paid billing-period allowances. Keys holding the catalog:read scope bypassed granular scope restrictions, and ordinary admitted requests could clear active-minute expensive-policy counters in the same window.
    • After: Version 1 gateway now enforces Free (60 RPM when commercial limits are enabled, 100,000/month UTC), Pro (200 RPM, 300,000/billing period), Scale (600 RPM, 1,000,000/billing period), and explicit manual/enterprise grants, returning RFC 9457 Problem JSON 403 PLAN_ENTITLEMENT_REQUIRED and 429 PERIOD_QUOTA_EXCEEDED when exceeded, with idempotent 5xx period-unit credit-back. Server-owned entitlements are checked prior to edge cache and quota admission, catalog:read wildcard bypass is removed, and active-minute expensive counters remain isolated.
    • Client action: Authenticate with an API key on a plan carrying the required entitlement and handle HTTP 403 (PLAN_ENTITLEMENT_REQUIRED) and HTTP 429 (PERIOD_QUOTA_EXCEEDED / EXPENSIVE_BUDGET_EXCEEDED) with Retry-After.

Verification: dashboard/tests/paid-plans-quota.test.ts; dashboard/tests/billing-stripe.test.ts; dashboard/tests/monthly-quota.test.ts; dashboard/tests/edge-cache.test.ts; dashboard/tests/admin-management.test.ts; dashboard/tests/legacy-analytics.test.ts; tests/middleware-origin-auth.test.ts; src/openapi/project-quota.ts; src/openapi/v1.ts; pnpm dashboard:test; pnpm test:unit; pnpm openapi:check; pnpm docs:check; pnpm release:check --base main.

2026-11-12 — Add verified-email onboarding, immutable receipts, privacy operations, and authoritative account closure

Record: developer-onboarding-account-closure.

  • v1 GET /v1/changelist/{id} (getChangelogEntry; security; breaking)
    • Before: The portal had no self-service account closure or verified-email/terms onboarding. Cached key identity could be used without a fresh account-closure lookup, and active console sessions did not check onboarding.
    • After: Initial publication gates dashboard and console access on verified email followed by explicit terms acceptance. Existing external API keys keep working even after an incomplete dashboard visit. Account closure deletes active credentials and rejects warm/delayed key caches through a primary lookup before quota/cache/upstream access (401 INVALID_API_KEY). Credential/account lookup failure returns uncacheable 503 ACCOUNT_STATUS_UNAVAILABLE with Retry-After: 30; HEAD has no body. Public and configured anonymous bypasses retain their prior behavior. Already-admitted requests may finish; acceptance does not restore revoked keys or reset quotas.
    • Client action: Existing API-key integrations need no onboarding change for this initial rollout. Dashboard/console users must verify a notification email and accept published terms; closure permanently ends their credentials. Retry ACCOUNT_STATUS_UNAVAILABLE after Retry-After; do not automatically retry agreement-related 403 responses.

Verification: dashboard/tests/privacy-operations.test.ts; dashboard/tests/developer-mail-events.test.ts; dashboard/tests/analytics.test.ts; dashboard/tests/legacy-analytics.test.ts; dashboard/legal/operations.md; dashboard/tests/developer-account.test.ts; dashboard/tests/legal-publication.test.ts; openapi/egdata.dashboard.openapi.json; src/openapi/project-quota.ts; src/openapi/v1.ts; apps/docs/content/docs/api-console.mdx; pnpm dashboard:test; pnpm dashboard:build; pnpm docs:check.

2026-11-12 — Report email verification before terms acceptance in dashboard and console onboarding

Record: developer-onboarding-error-order.

  • v1 GET /v1/changelist/{id} (getChangelogEntry; fixed; compatible)
    • Before: During an active rollout, signed-in dashboard console requests with unverified email and no terms acceptance returned 403 AGREEMENT_REQUIRED. Dashboard gates also advertised terms before verification.
    • After: Dashboard console requests return 403 EMAIL_VERIFICATION_REQUIRED until email is verified, then 403 AGREEMENT_REQUIRED until the current terms edition is accepted. Dashboard gates list required terms only after verification. Public API-key access, anonymous access, eligibility, quotas and successful responses are unchanged.
    • Client action: Console clients should handle EMAIL_VERIFICATION_REQUIRED by verifying the notification email first, then handle AGREEMENT_REQUIRED by accepting the current terms. Existing application API-key integrations require no change.

Verification: dashboard/tests/developer-account.test.ts; dashboard/tests/console-sessions.test.ts; openapi/egdata.dashboard.openapi.json; src/openapi/v1.ts; apps/docs/content/docs/api-console.mdx; pnpm docs:check; pnpm release:check --base origin/main.

2026-11-12 — Enforce shared 100,000 requests/month allowance across free account projects

Record: free-account-monthly-quota.

  • v1 GET /v1/changelist/{id} (getChangelogEntry; changed; breaking)
    • Before: Free projects were governed only by the 120 requests/minute per-project quota and expensive v1 per-operation limits without a monthly account cap, and RateLimit-Policy headers assumed 60-second windows.
    • After: Free accounts share an authoritative 100,000 requests/month allowance across all free projects, API keys, and console sessions across legacy and v1 gateways, resetting on the 1st of each calendar month at 00:00 UTC alongside existing per-project minute and expensive-operation limits. Paid projects (pro, enterprise) are exempt, while custom RPM overrides on free projects retain the monthly cap. Key rotation/deletion and project recreation never reset account usage. Monthly exhaustion returns 429 MONTHLY_QUOTA_EXCEEDED with Retry-After until reset and calendar-aware RateLimit headers; unavailable accounting returns 503 QUOTA_UNAVAILABLE.
    • Client action: Track free-account monthly usage in the developer portal or via RateLimit headers, respect Retry-After until 00:00 UTC on the 1st of next month on 429 MONTHLY_QUOTA_EXCEEDED, or request a Pro/Enterprise tier upgrade in Rate Limits.

Verification: dashboard/tests/monthly-quota.test.ts: simultaneous cap enforcement across keys/projects/console/gateways, calendar and leap-year rollovers, cache hits and upstream 5xx counting, auth/permission/public bypass exclusions, recreation/RPM/tier persistence, dashboard /quota thresholds (80%, 95%, exhausted), and 503 QUOTA_UNAVAILABLE fail-closed handling; dashboard/tests/project-quota.test.ts and dashboard/tests/rate-limiter.test.ts: atomic project minute and expensive-operation admission alongside account monthly policies; src/openapi/project-quota.ts, src/openapi/v1.ts, apps/docs/content/docs/versioned-api.mdx, and dashboard/src/lib/docs/problems.ts; pnpm openapi:generate; pnpm changelog:generate; pnpm docs:check.

2026-11-12 — Share gateway quotas across project keys and restrict project creation

Record: project-shared-quotas.

  • v1 GET /v1/changelist/{id} (getChangelogEntry; changed; breaking)
    • Before: Each API key had its own exact minute quota and expensive-operation counters; console sessions had a separate project-console counter. Accounts could create up to ten projects with a non-atomic check.
    • After: All API keys and console sessions in a project share one exact UTC-aligned 60-second global quota across authenticated legacy/v1 gateway traffic, using project tier/custom RPM. Expensive v1 caps are shared per project. Cache hits count; quota exhaustion returns 429 and unavailable admission returns retryable 503 QUOTA_UNAVAILABLE. Legacy responses expose project RateLimit headers. Accounts include one project unless an operator approves more; atomic creation enforces a 24-hour cooldown that survives deletion. Existing projects and keys remain usable.
    • Client action: Keep existing keys; coordinate request budgets across the project's keys, console and API versions. Respect Retry-After and request a project limit increase if necessary. Contact the egdata team for additional projects; creating or rotating keys no longer adds capacity. See docs/project-quota-rollout.md for migration and existing-grant review.

Verification: dashboard/tests/project-quota.test.ts: shared legacy/v1 and console quotas, key rotation, project isolation, expensive policies, UTC reset and fail-closed admission; dashboard/tests/project-policy.test.ts: concurrent creation, login races, deletion cooldown, existing projects and grants, operator allowances and HTTP policy errors; dashboard/tests/usage-outbox.test.ts: shared project counters retain distinct admitted per-key usage events; dashboard/tests/edge-cache.test.ts: quota admission remains before authenticated cache hits and revalidation; src/openapi/project-quota.ts and src/openapi/v1.ts; pnpm openapi:generate; pnpm docs:check.

2026-11-12 — Remove Aikido origin runtime blocking and telemetry

Record: remove-aikido-runtime.

  • v1 GET /v1/changelist/{id} (getChangelogEntry; security; compatible)
    • Before: Requests reaching the Node origin passed globally installed Aikido runtime instrumentation and middleware, which could send request/security telemetry and impose Aikido-specific blocking or rate-limit grouping before the route handler.
    • After: The updated origin no longer loads the Aikido SDK, sends its runtime telemetry, creates its IP/UA-derived user identity, or applies its blocking/grouping. Existing authentication, origin access controls, gateway quotas, legacy rate limits and custom legacy anti-abuse remain. Gateway-local responses that never reach the origin retain their prior behavior. v1 remains outside custom legacy challenges. Historical provider data is not erased by this code change; origin deployment is required.
    • Client action: None. Continue honoring existing authentication, quotas and Retry-After responses. This record does not confirm production deployment.

Verification: src/index.ts; src/middlewares/rate-limit.ts; package.json; scripts/dev.mjs; tests/middleware-rate-limit.test.ts; tests/anti-abuse.test.ts; tests/v1-router.test.ts; src/openapi/index.ts; src/openapi/v1.ts; apps/docs/content/docs/regions-pagination-errors.mdx; pnpm test; pnpm build; pnpm docs:check.

2026-11-12 — Expose API gateway hostname and harden Worker edge caching

Record: worker-edge-cache.

  • v1 GET /v1/changelist/{id} (getChangelogEntry; fixed; compatible)
    • Before: The API gateway Worker was not bound to api.egdata.app; additionally, eligible GET/HEAD requests used an edge-cache key that sorted repeated query values, allowing opposite value orders to share a cached representation.
    • After: The Worker is now bound to api.egdata.app for v1 requests. Eligible GET/HEAD cache keys sort query parameter names while preserving the original order of values with the same name, preserving origin query semantics. Protected requests still pass authentication, permissions, and quota admission before cache access; response contracts and outgoing private/no-store headers are unchanged.
    • Client action: None

Verification: dashboard/tests/edge-cache.test.ts; dashboard/tests/gateway.test.ts; dashboard/tests/v1-gateway.test.ts.

2026-11-11 — Apply administrator-approved project limits to API keys and console sessions

Record: admin-reviewed-project-limits.

  • v1 GET /v1/changelist/{id} (getChangelogEntry; changed; compatible)
    • Before: Limit requests were saved without a dashboard approval action; new keys inherited only the project tier and console sessions ignored custom project RPM.
    • After: After explicit administrator approval, existing and future project keys inherit the approved RPM. Console sessions use the current project custom RPM on each request. Key caches refresh within five minutes; operation caps and quota counters are unchanged. Projects without an approved change retain their existing limits.
    • Client action: None

Verification: dashboard/tests/limit-reviews.test.ts; dashboard/tests/console-sessions.test.ts; pnpm docs:check.

2026-11-11 — Keep API startup available while v1 indexes are provisioned separately

Record: keep-api-startup-independent-of-v1-indexes.

  • v1 GET /v1/changelist/{id} (getChangelogEntry; fixed; compatible)
    • Before: GET /v1/changelist/{id} was unavailable during API startup while v1 MongoDB index creation was pending; the proxy returned 502 before HTTP began listening.
    • After: GET /v1/changelist/{id} becomes available after the existing database and catalog initialization, without waiting for v1 index provisioning. Its route, authentication, response format and limits are preserved.
    • Client action: None

Verification: tests/server-startup.test.ts: stalled v1 index builds do not delay HTTP startup; database connectivity remains required; pnpm test; pnpm build; pnpm docs:check; pnpm release:check --base origin/main.

2026-11-11 — Try v1 operations with ten-minute project console sessions

Record: project-console-sessions.

  • v1 GET /v1/changelist/{id} (getChangelogEntry; added; compatible)
    • Before: Trying GET /v1/changelist/{id} in the API Reference required pasting an existing API key secret.
    • After: The project owner can also try GET /v1/changelist/{id} with a console-only credential lasting at most ten minutes, bound to the same dashboard login. Requests share a stable per-project console quota and count toward project analytics and endpoint alerts. Public API key behavior is preserved.
    • Client action: None

Verification: dashboard/tests/console-sessions.test.ts; dashboard/tests/explorer.test.ts.

2026-11-11 — Add the versioned v1 API with explicit scopes and per-key quotas

Record: versioned-v1-api.

  • v1 GET /v1/changelist/{id} (getChangelogEntry; added; compatible)
    • Before: GET /v1/changelist/{id} was not available in the versioned API.
    • After: Get a catalog change. Response media: application/json. Requires an API key with catalog:read permission; the gateway enforces per-key quotas.
    • Client action: None

Verification: tests/v1-router.test.ts; tests/v1-operations.test.ts; tests/v1-origin-provenance.test.ts; tests/middleware-origin-auth.test.ts; dashboard/tests/v1-gateway.test.ts; dashboard/tests/rate-limiter.test.ts; pnpm openapi:check.

On this page