rudder.example.local

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 parameter

🔑 apikey 134 endpoints developer_tools
📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (10 total)

npm install rudder-sdk-js
npm install rudder-sdk-node
# Maven: see https://github.com/rudderlabs/rudder-sdk-react-native
# Maven: see https://github.com/rudderlabs/rudder-sdk-android
cargo add rudder-sdk-rust
composer require rudder-php-sdk
# Maven: see https://github.com/rudderlabs/rudder-sdk-kotlin
# See https://github.com/rudderlabs/rudder-sdk-unity
# See https://github.com/rudderlabs/rudder-sdk-ios
# See https://github.com/rudderlabs/rudder-sdk-flutter
curl examples
Get all CVE details
curl \
  -H "X-API-Token: $API_KEY" \
  https://rudder.example.local/rudder/api/latest/cve
List all endoints
curl \
  -H "X-API-Token: $API_KEY" \
  https://rudder.example.local/rudder/api/latest/info
List managed nodes
curl \
  -H "X-API-Token: $API_KEY" \
  https://rudder.example.local/rudder/api/latest/nodes
Endpoints (134 total)
GET
/cve
Get all CVE details
GET
/info
List all endoints
GET
/nodes
List managed nodes
GET
/rules
List all rules
GET
/users
List user
GET
/groups
List all groups
GET
/status
Check if Rudder is alive
GET
/methods
List methods
GET
/secret/
List all secrets
GET
/branding
Get branding configuration
GET
/settings
List all settings
GET
/compliance
Global compliance
At a glance
Total SDKs10
Languages8
Endpoints134
Authapikey
Categories1
https://rudder.example.local/rudder/api/latest