VindexDocs
    Vindex docs
    Dashboardgetvindex.com

    API reference

    Tenant

    Your workspace, including shadow mode.

    The workspace's plan, its limits and what's used

    GET/v1/plan

    Request

    cURL
    curl "https://api.getvindex.com/v1/plan" \
  -H "Authorization: Bearer $VINDEX_KEY"

    Response 200

    The plan.

    Example
    {
  "plan": "none",
  "name": "Growth",
  "state": "none",
  "trial_ends_at": "2026-09-17T08:51:06.000Z",
  "pauses_at": "2026-09-17T08:51:06.000Z",
  "ended_at": "2026-09-17T08:51:06.000Z",
  "cancels_at": "2026-09-17T08:51:06.000Z",
  "limits": {
    "included_decisions": 1,
    "policies": 1,
    "rules": 1,
    "reviewer_seats": 1,
    "retention_days": 1,
    "playground_bulk_rows": 1,
    "rate_limit_per_minute": 1,
    "live_checks": false,
    "test_checks_per_month": 1
  },
  "usage": {
    "policies": 1,
    "rules": 1,
    "reviewer_seats": 1,
    "test_checks_this_month": 1
  },
  "upgrade_url": "upgrade url"
}

    Errors

    • 400Invalid request (malformed JSON, or the body/query failed validation).
    • 401Missing, malformed, unknown or revoked API key.
    • 429Rate limit exceeded for this API key. See Retry-After.

    The key's tenant, including shadow mode

    GET/v1/tenant

    Request

    cURL
    curl "https://api.getvindex.com/v1/tenant" \
  -H "Authorization: Bearer $VINDEX_KEY"

    Response 200

    The tenant.

    Example
    {
  "id": "ten_0a1b2c3d4e5f60718293a4b5c6d7e8f9",
  "name": "adult-platform",
  "plan": "starter",
  "shadow_mode": false,
  "default_policy_id": "pol_3f2a0c9e8b7d4c6a9f1e2d3c4b5a6978",
  "weekly_digest": false,
  "created_at": "2026-09-17T08:51:06.000Z"
}

    Errors

    • 400Invalid request (malformed JSON, or the body/query failed validation).
    • 401Missing, malformed, unknown or revoked API key.
    • 429Rate limit exceeded for this API key. See Retry-After.

    Rename the tenant or turn shadow mode on or off

    PATCH/v1/tenant

    A live key can rename the tenant. Shadow mode is switched in the dashboard (Settings), and reaches every edge within about two minutes. A test-mode key can't change the tenant.

    Body

    • namestring

      1–120 chars

    • shadow_modeboolean
    • weekly_digestboolean

    Request

    cURL
    curl -X PATCH "https://api.getvindex.com/v1/tenant" \
  -H "Authorization: Bearer $VINDEX_KEY" \
  -H "Content-Type: application/json" \
  -d '{"shadow_mode":true}'

    Response 200

    The tenant, updated.

    Example
    {
  "id": "ten_0a1b2c3d4e5f60718293a4b5c6d7e8f9",
  "name": "adult-platform",
  "plan": "starter",
  "shadow_mode": false,
  "default_policy_id": "pol_3f2a0c9e8b7d4c6a9f1e2d3c4b5a6978",
  "weekly_digest": false,
  "created_at": "2026-09-17T08:51:06.000Z"
}

    Errors

    • 400Invalid request (malformed JSON, or the body/query failed validation).
    • 401Missing, malformed, unknown or revoked API key.
    • 403A test-mode key (test_key_forbidden), an API key changing shadow mode (dashboard_only), or a dashboard reviewer (role_forbidden).
    • 429Rate limit exceeded for this API key. See Retry-After.