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 parameter
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://rudder.example.local/rudder/api/latest
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
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 e
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/changeRequests | List all change requests List all change requests 🧩 Change requests |
GET | /archives/export | Get a ZIP archive of the requested items and their dependencies Get a ZIP archive or rules, directives, techni |
POST | /archives/import | Import a ZIP archive of policies into Rudder Import a ZIP archive of techniques, directives, groups and rules |
GET | /branding | Get branding configuration Get all web interface customization parameters 🧩 Branding |
POST | /branding | Update web interface customization change color, logo, label etc. 🧩 Branding |
POST | /branding/reload | Reload branding file Reload the configuration from file 🧩 Branding |
GET | /changeRequests/{changeRequestId} | Get a change request details Get a change request details 🧩 Change requests |
POST | /changeRequests/{changeRequestId} | Update a request details Update a change request 🧩 Change requests |
DELETE | /changeRequests/{changeRequestId} | Decline a request details Refuse a change request 🧩 Change requests |
POST | /changeRequests/{changeRequestId}/accept | Accept a request details Accept a change request 🧩 Change requests |
GET | /compliance | Global compliance Get current global compliance of a Rudder server Compliance |
GET | /compliance/nodes | Compliance details for all nodes Get current compliance of all the nodes of a Rudder server Compliance |
GET | /compliance/nodes/{nodeId} | Compliance details by node Get current compliance of a node of a Rudder server Compliance |
GET | /compliance/rules | Compliance details for all rules Get current compliance of all the rules of a Rudder server Compliance |
GET | /compliance/rules/{ruleId} | Compliance details by rule Get current compliance of a rule of a Rudder server Compliance |
GET | /cve | Get all CVE details Get all CVE details 🧩 CVE |
POST | /cve/check | Trigger a CVE check Trigger a CVE check 🧩 CVE |
GET | /cve/check/config | Get CVE check config Get CVE check config 🧩 CVE |
POST | /cve/check/config | Update cve check config Update cve check config 🧩 CVE |
GET | /cve/check/last | Get last CVE check result Get last CVE check result 🧩 CVE |
POST | /cve/list | Get a list of CVE details Get CVE details, from a list passed as parameter 🧩 CVE |
POST | /cve/update/ | Update CVE database from remote source Update CVE database from remote source 🧩 CVE |
POST | /cve/update/fs | Update CVE database from file system Update CVE database from file system 🧩 CVE |
GET | /datasources | List all data sources Get the configuration of all present data sources 🧩 Data sources |
PUT | /datasources | Create a data source Create a new data source 🧩 Data sources |
POST | /datasources/reload | Update properties from data sources Update properties from all data source on all nodes. The call is asynchron |
POST | /datasources/reload/{datasourceId} | Update properties from data sources Update properties from all data source on all nodes. The call is asynchron |
GET | /datasources/{datasourceId} | Get data source configuration Get the configuration of a data source 🧩 Data sources |
POST | /datasources/{datasourceId} | Update a data source configuration Update the configuration of a data source 🧩 Data sources |
DELETE | /datasources/{datasourceId} | Delete a data source Delete a data source configuration 🧩 Data sources |
GET | /directives | List all directives List all directives Directives |
PUT | /directives | Create a directive Create a new directive from provided parameters. You can specify a source directive to clon |
GET | /directives/{directiveId} | Get directive details Get all information about a given directive Directives |
POST | /directives/{directiveId} | Update a directive details Update directive information Directives |
DELETE | /directives/{directiveId} | Delete a directive Delete a directive Directives |
POST | /directives/{directiveId}/check | Check that update on a directive is valid Check that update on a directive is valid Directives |
GET | /groups | List all groups List all groups Groups |
PUT | /groups | Create a group Create a new group based in provided parameters Groups |
PUT | /groups/categories | Create a group category Create a new group category Groups |
GET | /groups/categories/{groupCategoryId} | Get group category details Get detailed information about a group category Groups |
and 94 more operation(s) in this specification, all searchable.
specification origin: https://docs.rudder.io/api/openapi.yml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.