Skip to content
Cloud infrastructure/devops

rudder.example.local

Rudder sandbox and mock API

Download OpenAPI specification: [openapi.yml](openapi.yml) # Introduction Rudder exposes a REST API, enabling the user to interact with Rudder without using the webapp, for example in scripts or cronjobs. ## Versioning Each time the API is extended with new features (new functions, new parameters, new responses, ...), it will be assigned a new version number. This will allow you to keep your exist Writes persist, data moves on a schedule and every change can fire a signed webhook.

Operations
134
Collections
-
Event types
-
example request
curl https://your-rudder-example-local.slurry.io/rudder/api/latest/api/changeRequests \
  -H "Authorization: Bearer slurry_sim_..."

Your simulation gets its own hostname, key and IP allow-list. Built from API version 16.

What gets simulated

Collections, relationships and state machines are worked out from the spec when you start the simulation.

  • State. Creates, updates and deletes persist and show up in later reads.
  • Behaviour. Records move through their states on a schedule you control, and you can fast-forward up to 30 days.
  • Webhooks. Every change emits a signed, retried event.
  • Failure. Per-endpoint errors, latency and chaos rules, on demand.

Operations

First 12 of 134.

  • GET/api/changeRequests
  • GET/archives/export
  • POST/archives/import
  • GET/branding
  • POST/branding
  • POST/branding/reload
  • GET/changeRequests/{changeRequestId}
  • POST/changeRequests/{changeRequestId}
  • DELETE/changeRequests/{changeRequestId}
  • POST/changeRequests/{changeRequestId}/accept
  • GET/compliance
  • GET/compliance/nodes