Rudder API

api:rudder.example.local · v16 · source: apis.guru

Download OpenAPI specification: 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 existing scripts (based on previous behavior). Versions will always be integers (no 2.1 or 3.3, just 2, 3, 4, ...) or latest . You can change the version of the API used by setting it either within the url or in a header: the URL: each URL is prefixed by its version id, like /api/version/function . bash Version 10 curl -X GET -H "X-API-Token: yourToken" https://rudder.example.com/rudder/api/10/rules Latest curl -X GET -H "X-API-Token: yourToken" https://rudder.example.com/rudder/api/latest/rules Wrong (not an integer) = 404 not found curl -X GET -H "X-API-Token: yourToken" https://rudder.example.com/rudder/api/3.14/rules the HTTP headers. You can add the X-API-Version header to your request. The value needs to be an integer or latest . bash Version 10 curl -X GET -H "X-API-Token: yourToken" -H "X-API-Version: 10" https://rudder.example.com/rudder/api/rules Wrong = Error response indicating which versions are available curl -X GET -H "X-API-Token: yourToken" -H "X-API-Version: 3.14" https://rudder.example.com/rudder/api/rules In the future, we may declare some versions as deprecated, in order to remove them i

[![Connect-MCP](https://clawy.uk/mcp/badge/api%3Arudder.example.local.svg)](https://clawy.uk/mcp/s/api%3Arudder.example.local)