Rudder Example API
Mock the Rudder Example API with 150 endpoints without keys, sandboxes, or a live account.
[01]
About
Mock the Rudder Example API as a turnkey Mockzilla sim with 150 OpenAPI endpoints, realistic JSON payloads, no upstream signup or sandbox keys. 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. Methods: 71x GET, 54x POST, 15x DELETE, 10x PUT. Top resource groups: Techniques, System, Groups, Nodes. Hit https://api.justmocks.com/rudder for the Mockzilla API Explorer landing and per-endpoint sample requests.
Endpoints
150 across 22 resource groups
Methods
GET 71 · POST 54 · PUT 10 · DEL 15 none deprecated
OpenAPI
3.0.3 spec version 17
Source spec
423 KB · YAML
view raw →
[02]
Endpoints
| GET |
/api/changeRequests
|
List all change requests List all change requests. Mocked via Mockzilla.
|
| GET |
/archives/export
|
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
|
| POST |
/archives/import
|
Import a ZIP archive of policies into Rudder Import a ZIP archive of techniques, directives, groups and rules in a saved in a normalized format into Rudder
|
| GET |
/branding
|
Get branding configuration Get all web interface customization parameters
|
| POST |
/branding
|
Update web interface customization change color, logo, label etc.
|
| POST |
/branding/reload
|
Reload branding file Reload the configuration from file. Available as a Mockzilla mock endpoint.
|
| GET |
/campaigns
|
Get all campaigns details Get all campaigns details
|
| POST |
/campaigns
|
Save a campaign Save a campaign details
|
| GET |
/campaigns/events
|
Get all campaign events Get all campaign events
|
| DEL |
/campaigns/events/{id}
|
Delete a campaign event details Delete a campaign event details
|
| GET |
/campaigns/events/{id}
|
Get a campaign event details Get a campaign event details. Mockzilla mock: no signup, no API key.
|
| POST |
/campaigns/events/{id}
|
Update an existing event Update an existing event
|
| DEL |
/campaigns/{id}
|
Delete a campaign Delete a campaign
|
| GET |
/campaigns/{id}
|
Get a campaign details Get a campaign details
|
| GET |
/campaigns/{id}/events
|
Get campaign events for a campaign Get campaign events for a campaign
|
| POST |
/campaigns/{id}/schedule
|
Schedule a campaign event for a campaign Schedule a campaign event for a campaign. Served by the Mockzilla mock runtime.
|
| DEL |
/changeRequests/{changeRequestId}
|
Decline a request details Refuse a change request
|
| GET |
/changeRequests/{changeRequestId}
|
Get a change request details Get a change request details
|
| POST |
/changeRequests/{changeRequestId}
|
Update a request details Update a change request
|
| POST |
/changeRequests/{changeRequestId}/accept
|
Accept a request details Accept a change request
|
| GET |
/compliance
|
Global compliance Get current global compliance of a Rudder server. Mocked via Mockzilla.
|
| GET |
/compliance/directives
|
Compliance details for all directives Get current compliance of all the nodes of a Rudder server
|
| GET |
/compliance/directives/{directiveId}
|
Compliance details by directive Get current compliance of a directive of a Rudder server
|
| GET |
/compliance/nodes
|
Compliance details for all nodes Get current compliance of all the nodes of a Rudder server
|
| GET |
/compliance/nodes/{nodeId}
|
Compliance details by node Get current compliance of a node of a Rudder server
|
| GET |
/compliance/rules
|
Compliance details for all rules Get current compliance of all the rules of a Rudder server. Available as a Mockzilla mock endpoint.
|
| GET |
/compliance/rules/{ruleId}
|
Compliance details by rule Get current compliance of a rule of a Rudder server
|
| GET |
/cve
|
Get all CVE details Get all CVE details
|
| POST |
/cve/check
|
Trigger a CVE check Trigger a CVE check
|
| GET |
/cve/check/config
|
Get CVE check config Get CVE check config
|
| POST |
/cve/check/config
|
Update cve check config Update cve check config. Mockzilla mock: no signup, no API key.
|
| GET |
/cve/check/last
|
Get last CVE check result Get last CVE check result
|
| POST |
/cve/list
|
Get a list of CVE details Get CVE details, from a list passed as parameter
|
| POST |
/cve/update
|
Update CVE database from remote source Update CVE database from remote source
|
| POST |
/cve/update/fs
|
Update CVE database from file system Update CVE database from file system
|
| GET |
/cve/{cveId}
|
Get a CVE details Get a CVE details. Served by the Mockzilla mock runtime.
|
| GET |
/datasources
|
List all data sources Get the configuration of all present data sources
|
| PUT |
/datasources
|
Create a data source Create a new data source
|
| POST |
/datasources/reload
|
Update properties from data sources Update properties from all data source on all nodes. The call is asynchronous.
|
| POST |
/datasources/reload/{datasourceId}
|
Update properties from data sources Update properties from all data source on all nodes. The call is asynchronous.
|
| DEL |
/datasources/{datasourceId}
|
Delete a data source Delete a data source configuration. Mocked via Mockzilla.
|
| GET |
/datasources/{datasourceId}
|
Get data source configuration Get the configuration of a data source
|
| POST |
/datasources/{datasourceId}
|
Update a data source configuration Update the configuration of a data source
|
| GET |
/directives
|
List all directives List all directives
|
| PUT |
/directives
|
Create a directive Create a new directive from provided parameters. You can specify a source directive to clone it.
|
| DEL |
/directives/{directiveId}
|
Delete a directive Delete a directive. Available as a Mockzilla mock endpoint.
|
| GET |
/directives/{directiveId}
|
Get directive details Get all information about a given directive
|
| POST |
/directives/{directiveId}
|
Update a directive details Update directive information
|
| POST |
/directives/{directiveId}/check
|
Check that update on a directive is valid Check that update on a directive is valid
|
| GET |
/groups
|
List all groups List all groups
|
| PUT |
/groups
|
Create a group Create a new group based in provided parameters. Mockzilla mock: no signup, no API key.
|
| PUT |
/groups/categories
|
Create a group category Create a new group category
|
| DEL |
/groups/categories/{groupCategoryId}
|
Delete group category Delete a group category. It must have no child groups and no children categories.
|
| GET |
/groups/categories/{groupCategoryId}
|
Get group category details Get detailed information about a group category
|
| POST |
/groups/categories/{groupCategoryId}
|
Update group category details Update detailed information about a group category
|
| GET |
/groups/tree
|
Get groups tree Get all available groups and their categories in a tree. Served by the Mockzilla mock runtime.
|
| DEL |
/groups/{groupId}
|
Delete a group Update detailed information about a group
|
| GET |
/groups/{groupId}
|
Get group details Get detailed information about a group
|
| POST |
/groups/{groupId}
|
Update group details Update detailed information about a group
|
| POST |
/groups/{groupId}/reload
|
Reload a group Recompute the content of a group
|
| GET |
/info
|
List all endoints List all endpoints and their version. Mocked via Mockzilla.
|
| GET |
/info/details/{endpointName}
|
Get information about one API endpoint Get the description and the list of supported version for one API endpoint
|
| GET |
/info/{sectionId}
|
Get information on endpoint in a section Get all endpoints in the given section with their supported version.
|
| GET |
/inventories/info
|
Get information about inventory processing queue Provide information about the current state of the inventory processor
|
| POST |
/inventories/upload
|
Upload an inventory for processing Upload an inventory to the web application
|
| POST |
/inventories/watcher/restart
|
Restart inventory watcher Restart the inventory watcher if necessary. Available as a Mockzilla mock endpoint.
|
| POST |
/inventories/watcher/start
|
Start inventory watcher Start the inventory watcher if necessary
|
| POST |
/inventories/watcher/stop
|
Stop inventory watcher Stop the inventory watcher if necessary
|
| GET |
/methods
|
List methods Get all generic methods metadata
|
| POST |
/methods/reload
|
Reload methods Reload methods metadata from file system
|
| GET |
/nodes
|
List managed nodes Get information about the nodes managed by the target server. Mockzilla mock: no signup, no API key.
|
| PUT |
/nodes
|
Create one or several new nodes Use the provided array of node information to create new nodes
|
| POST |
/nodes/applyPolicy
|
Trigger an agent run on all nodes This API allows to trigger an agent run on all nodes. Response contains a json stating if agent could be started on each node, but not if the run went fine and do not display any output from it. You can see the result of the run in Rudder web interface or in the each agent logs.
|
| GET |
/nodes/pending
|
List pending nodes Get information about the nodes pending acceptation
|
| POST |
/nodes/pending/{nodeId}
|
Update pending Node status Accept or refuse a pending node
|
| GET |
/nodes/status
|
Get nodes acceptation status Get acceptation status (pending, accepted, deleted, unknown) of a list of nodes. Served by the Mockzilla mock runtime.
|
| DEL |
/nodes/{nodeId}
|
Delete a node Remove a node from the Rudder server. It won't be managed anymore.
|
| GET |
/nodes/{nodeId}
|
Get information about a node Get details about a given node
|
| POST |
/nodes/{nodeId}
|
Update node settings and properties Update node settings and properties
|
| POST |
/nodes/{nodeId}/applyPolicy
|
Trigger an agent run This API allows to trigger an agent run on the target node. Response is a stream of the actual agent run on the node.
|
| POST |
/nodes/{nodeId}/fetchData
|
Update properties for one node from all data sources Update properties from all data sources on one nodes. The call is asynchronous. Mocked via Mockzilla.
|
| POST |
/nodes/{nodeId}/fetchData/{datasourceId}
|
Update properties for one node from a data source Update properties from a data source on one nodes. The call is asynchronous.
|
| GET |
/nodes/{nodeId}/inheritedProperties
|
Get inherited node properties for a node This API returns all node properties for a node, including group inherited ones.
|
| GET |
/parameters
|
List all global parameters Get the current value of all the global parameters
|
| PUT |
/parameters
|
Create a new parameter Create a new global parameter
|
| DEL |
/parameters/{parameterId}
|
Delete a parameter Delete an existing parameter. Available as a Mockzilla mock endpoint.
|
| GET |
/parameters/{parameterId}
|
Get the value of a parameter Get the current value of a given parameter
|
| POST |
/parameters/{parameterId}
|
Update a parameter's value Update the properties of a parameter
|
| GET |
/rules
|
List all rules List all rules
|
| PUT |
/rules
|
Create a rule Create a new rule. You can specify a source rule to clone it.
|
| PUT |
/rules/categories
|
Create a rule category Create a new rule category. Mockzilla mock: no signup, no API key.
|
| DEL |
/rules/categories/{ruleCategoryId}
|
Delete group category Delete a group category. It must have no child groups and no children categories.
|
| GET |
/rules/categories/{ruleCategoryId}
|
Get rule category details Get detailed information about a rule category
|
| POST |
/rules/categories/{ruleCategoryId}
|
Update rule category details Update detailed information about a rule category
|
| GET |
/rules/tree
|
Get rules tree Get all available rules and their categories in a tree
|
| DEL |
/rules/{ruleId}
|
Delete a rule Delete a rule. Served by the Mockzilla mock runtime.
|
| GET |
/rules/{ruleId}
|
Get a rule details Get the details of a rule
|
| POST |
/rules/{ruleId}
|
Update a rule details Update the details of a rule
|
| POST |
/scaleoutrelay/demote/{nodeId}
|
Demote a relay to simple node Demote a relay to a simple node.
|
| POST |
/scaleoutrelay/promote/{nodeId}
|
Promote a node to relay Promote a node to relay
|
| GET |
/secret
|
List all secrets Get the list of all secrets without their value. Mocked via Mockzilla.
|
| POST |
/secret
|
Update a secret Update a secret and override the value, the name cannot be overridden
|
| PUT |
/secret
|
Create a secret Add a secret
|
| DEL |
/secret/{name}
|
Delete a secret Remove the secret by his unique name
|
| GET |
/secret/{name}
|
Get one secret Get one secret by his unique name
|
| GET |
/settings
|
List all settings Get the current value of all the settings. Available as a Mockzilla mock endpoint.
|
| GET |
/settings/allowed_networks/{nodeId}
|
Get allowed networks for a policy server Get the list of allowed networks for a policy server
|
| POST |
/settings/allowed_networks/{nodeId}
|
Set allowed networks for a policy server Set the list of allowed networks for a policy server
|
| POST |
/settings/allowed_networks/{nodeId}/diff
|
Modify allowed networks for a policy server Add or delete allowed networks for a policy server
|
| GET |
/settings/{settingId}
|
Get the value of a setting Get the current value of a specific setting
|
| POST |
/settings/{settingId}
|
Set the value of a setting Set the current value of a specific setting. Mockzilla mock: no signup, no API key.
|
| GET |
/status
|
Check if Rudder is alive An unauthenticated API to check if Rudder web application is up and running. Be careful: this API does not follow other Rudder's API convention: - it is not versioned, so the path is just /api/status; - it returns a plain text message.
|
| GET |
/system/archives/{archiveKind}
|
List archives List configuration archives
|
| POST |
/system/archives/{archiveKind}
|
Create an archive Create new archive of the given kind
|
| POST |
/system/archives/{archiveKind}/restore/{archiveRestoreKind}
|
Restore an archive Restore an archive of the given kind for the given moment
|
| GET |
/system/archives/{archiveKind}/zip/{commitId}
|
Get an archive as a ZIP Get an archive of the given kind as a zip. Served by the Mockzilla mock runtime.
|
| GET |
/system/healthcheck
|
Get healthcheck Run and get the result of all checks
|
| GET |
/system/info
|
Get server information Get information about the server version
|
| POST |
/system/maintenance/purgeSoftware
|
Trigger batch for cleaning unreferenced software Start the software cleaning batch asynchronously.
|
| POST |
/system/regenerate/policies
|
Trigger a new policy generation Trigger a full policy generation
|
| POST |
/system/reload
|
Reload both techniques and dynamic groups Reload both techniques and dynamic groups. Mocked via Mockzilla.
|
| POST |
/system/reload/groups
|
Reload dynamic groups Reload dynamic groups
|
| POST |
/system/reload/techniques
|
Reload techniques Reload techniques from local technique library
|
| GET |
/system/status
|
Get server status Get information about current server status
|
| POST |
/system/update/policies
|
Trigger update of policies Update configuration policies if needed
|
| GET |
/systemUpdate/campaigns/{id}/history
|
Get a campaign result history Get a campaign result history. Available as a Mockzilla mock endpoint.
|
| GET |
/systemUpdate/events/{id}/result
|
Get a campaign event result Get a campaign event result
|
| GET |
/systemUpdate/events/{id}/result/{nodeId}
|
Get detailed campaign event result for a Node Get detailed campaign event result for a Node
|
| GET |
/techniques
|
List all techniques List all technique with their versions
|
| PUT |
/techniques
|
Create technique Create a new technique in Rudder from a technique in the technique editor
|
| GET |
/techniques/categories
|
List categories Get all technique categories. Mockzilla mock: no signup, no API key.
|
| POST |
/techniques/reload
|
Reload techniques Reload all techniques metadata from file system
|
| GET |
/techniques/versions
|
List versions List all techniques version
|
| GET |
/techniques/{techniqueId}
|
Technique metadata by ID Get each Technique's versions with their metadata by ID
|
| GET |
/techniques/{techniqueId}/directives
|
List all directives based on a technique List all directives based on all version of a technique
|
| DEL |
/techniques/{techniqueId}/{techniqueVersion}
|
Delete technique Delete a technique from technique editor. Served by the Mockzilla mock runtime.
|
| GET |
/techniques/{techniqueId}/{techniqueVersion}
|
Technique metadata by version and ID Get Technique metadata
|
| POST |
/techniques/{techniqueId}/{techniqueVersion}
|
Update technique Update technique created with technique editor
|
| GET |
/techniques/{techniqueId}/{techniqueVersion}/directives
|
List all directives based on a version of a technique List all directives based on a version of a technique
|
| GET |
/techniques/{techniqueId}/{techniqueVersion}/resources
|
Technique's resources Get currently deployed resources of a technique
|
| GET |
/techniques/{techniqueId}/{techniqueVersion}/revisions
|
Technique's revisions Get revisions for given technique. Mocked via Mockzilla.
|
| POST |
/usermanagement
|
Add user Add a new user
|
| GET |
/usermanagement/roles
|
List all roles Get all available roles and their rights
|
| POST |
/usermanagement/update/{username}
|
Update user's infos Rename, change password (pre-hashed or not) and change permission of an user. If a parameter is empty, it will be ignored.
|
| GET |
/usermanagement/users
|
List all users Get the list of all present users and their permissions
|
| GET |
/usermanagement/users/reload
|
Reload user Reload the users from the file system, in the configuration file. Available as a Mockzilla mock endpoint.
|
| DEL |
/usermanagement/{username}
|
Delete an user Delete the user and his permissions
|
| GET |
/users
|
List user List all validated and unvalidated users
|
| POST |
/validatedUsers
|
Update validated user list Add and remove user from validated users
|
| DEL |
/validatedUsers/{username}
|
Remove an user from validated user list The user is again subject to workflow validation
|
[03]
Related mocks
Apache Airflow REST API
Mock the Apache Airflow REST API in seconds. Overview To facilitate management, Apache Airflow supports a range of REST API endpoints across its objects.
73 endpoints
·
ai, data, devtools
BC Data Catalogue API
Emulate the BC Data Catalogue API in seconds. This API provides live access to the BC Data Catalogue.
22 endpoints
·
ai, content, data, government, search
BC Geographical Names Web Service
Emulate the BC Geographical Names Web Service with 14 endpoints without keys, sandboxes, or a live account.
14 endpoints
·
ai, data, geo, government, location