Reset the sandbox

post/v1/test_helpers/sandbox/reset

Puts this sandbox back to how it started: everything in it is removed (sites, screens, devices, campaigns, creatives, plays, events, test plays) and it is seeded again from its starting point; a copy of your live setup is taken afresh. Its test keys and webhook endpoints are kept, so your configuration still works; an endpoint scoped to particular screens or sites is pointed at the new ones by name. Ambient plays switch off. Typically the first step of a CI run.

Takes a few seconds. skipped says what a copy of live left out to stay inside the sandbox's limits; endpoint_scope_entries_lost counts scope entries whose screen or site no longer exists.

Access

Authentication
Secret key or OAuth access token.
Scope
test_helpers:write
User permission
developerAccess
Safe to retry
Send an Idempotency-Key.

Headers

  • Vojo-Versionstring

    Optional API version pin (a date). Overrides the version pinned on the secret key / organisation for this request. Echoed in the Vojo-Version response header. Within /v1 only additive changes ship, so most callers can omit it.

    date

  • Idempotency-Keystring

    Client-generated unique key (UUID v4 recommended) making this create safe to retry. A replay within 24 hours returns the stored response (with Idempotent-Replayed: true). Reusing a key with a different body returns 409 idempotency_key_reused.

    8 to 255 characters

Response 200

OK

  • dataobjectRequired
    Show 5 fields
    • templatestringRequired

      The starting point the sandbox was seeded from again.

      One of sample, empty, live_copy

    • reset_atstringRequired

      date-time

    • skippedobjectRequired

      What a copy of live left out to stay inside the sandbox's limits; all zero otherwise.

      Show 4 fields
      • sitesintegerRequired

        at least 0

      • screensintegerRequired

        at least 0

      • campaignsintegerRequired

        at least 0

      • creativesintegerRequired

        at least 0

    • endpoint_scope_entries_lostintegerRequired

      at least 0

    • livemodeboolean

      Always false.

  • metaobjectRequired

Response headers

  • Vojo-Versionstring

    The API version (date) this response was rendered with — the request's Vojo-Version, else the key/org pin.

  • RateLimitstring

    IETF RateLimit header: remaining quota in the current window, e.g. "default";r=97;t=42.

  • RateLimit-Policystring

    IETF RateLimit-Policy header, e.g. "default";q=100;w=60. Portal OAuth clients get a higher tier.

  • Idempotent-Replayedstring

    true when this response is a stored replay of an earlier request with the same Idempotency-Key.

Errors

Every error is application/problem+json. Branch on its code.

  • 401

    Missing, invalid, expired or revoked credential.

  • 403

    The caller is authenticated but not allowed: missing scope (insufficient_scope), missing Permissions flag (permission_denied), a client/installer persona on an operator endpoint (operator_access_required), or no access to the requested org (organisation_access_denied).

  • 409

    The request conflicts with current state (duplicate name, device already paired, idempotency key reuse).

  • 429

    Rate limit exceeded for this principal. Back off for Retry-After seconds.

  • 500

    Unexpected server failure.