Rudder API

rudder · Developer Tools

Developer Tools No Auth Free & Open developer_tools

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 existing scripts (based on previous behavior). Versions will always be integers (no 2.1 or 3.3, just

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Get a ZIP archive of the requested items and their dependencies

Get a ZIP archive or rules, directives, techniques and groups with optionally their dependencies

https://api.apis.guru/v2/specs/rudder.example.local/16/archives/export?rules=example&groups=example&include=example&directives=example&techniques=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/rudder.example.local/16/archives/export?rules=example&groups=example&include=example&directives=example&techniques=example"

import requests
params = {
    "rules": "example",
    "groups": "example",
    "include": "example",
    "directives": "example",
    "techniques": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/rudder.example.local/16/archives/export",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/rudder.example.local/16/archives/export');
url.searchParams.set('rules', 'example');
url.searchParams.set('groups', 'example');
url.searchParams.set('include', 'example');
url.searchParams.set('directives', 'example');
url.searchParams.set('techniques', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/rudder.example.local/16/archives/export")
	q := baseURL.Query()
	q.Set("rules", "example")
	q.Set("groups", "example")
	q.Set("include", "example")
	q.Set("directives", "example")
	q.Set("techniques", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/rudder.example.local/16/archives/export")
uri.query = URI.encode_www_form({
  "rules" => "example",
  "groups" => "example",
  "include" => "example",
  "directives" => "example",
  "techniques" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/rudder.example.local/16/archives/export?" . http_build_query([
    "rules" => "example",
    "groups" => "example",
    "include" => "example",
    "directives" => "example",
    "techniques" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get branding configuration

Get all web interface customization parameters

https://api.apis.guru/v2/specs/rudder.example.local/16/branding

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/rudder.example.local/16/branding"

import requests
response = requests.get(
    "https://api.apis.guru/v2/specs/rudder.example.local/16/branding",
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/rudder.example.local/16/branding';

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/rudder.example.local/16/branding"
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/rudder.example.local/16/branding")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/rudder.example.local/16/branding";
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Global compliance

Get current global compliance of a Rudder server

https://api.apis.guru/v2/specs/rudder.example.local/16/compliance?precision=0

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/rudder.example.local/16/compliance?precision=0"

import requests
params = {
    "precision": "0"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/rudder.example.local/16/compliance",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/rudder.example.local/16/compliance');
url.searchParams.set('precision', '0');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/rudder.example.local/16/compliance")
	q := baseURL.Query()
	q.Set("precision", "0")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/rudder.example.local/16/compliance")
uri.query = URI.encode_www_form({
  "precision" => "0"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/rudder.example.local/16/compliance?" . http_build_query([
    "precision" => "0"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Rudder API?

Rudder API is a Developer Tools API. Developers commonly use developer tools APIs for:

automating code review and quality checks
integrating CI/CD pipelines and build systems
managing feature flags and A/B tests
monitoring errors and application performance
generating and validating test data

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Rudder API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗