Resources
Cheatsheet Videos
Support
Community Subscription
Chat Website
All resources
  • Get started
    • current
  • Reference manual
    • 8.3
    • 8.2
    • 8.1
    • older
  • Rudder by example
    • current
  • YAML techniques
    • 8.3
    • 8.2
    • 8.1
  • Public API reference
    • 8.3 (v21)
    • 8.2 (v20)
    • 8.1 (v19)
    • older
  • Relay API reference
    • 8 (v1)
  • Changelogs
    • 8.3
    • 8.2
    • 8.1
Reference manual 8.2
    • Introduction
      • What is Rudder?
        • Made for production environments
        • Different roles for a better accessibility
        • Universality
      • Key Features
        • OS independent target configuration state definition
        • Centralize and aggregate real configuration states
        • Automatic inventory
        • REST API
        • Audit trace and Change Requests
        • Centralized authentication (LDAP, Active Directory, OpenID Connect)
        • Extensibility
      • Use cases
        • Dynamic groups by operating system
        • Library of preventive policies
        • Standardizing configurations
        • Using Rudder as an Audit tool
        • Using Audit mode to validate a policy before applying it
      • Architecture
        • Functional architecture of Rudder
        • Network architecture in client/server mode
        • Agents
      • Technical stack
        • Principles
        • Server
        • Agent
    • Installation
      • Rudder components
      • Rudder versions
      • Compatible OS
        • Fully supported Operating Systems
        • Partially supported Operating Systems
      • Requirements
        • Networking
        • JVM requirements
        • Cloud compatibility
        • Hardware specifications for Rudder Agent
        • Hardware specifications and sizing for Rudder Root Server
      • Quick installation
      • Install server
        • on Debian/Ubuntu
        • on RHEL/CentOS
        • on Amazon Linux
        • on SLES
        • with a separate DB
      • Install agent
        • on Debian/Ubuntu
        • on RHEL/CentOS/Amazon Linux
        • on SLES
        • on Windows
        • on AIX
      • Install relay
        • on Debian/Ubuntu
        • on RHEL/CentOS
        • on SLES
      • Upgrade Rudder
        • Upgrade notes
        • on Debian/Ubuntu
        • on RHEL/CentOS/Amazon Linux
        • on SLES
        • on Windows
        • upgrade PostgreSQL
      • Migrate to external DB
      • Containers - Docker
      • Development versions
    • Usage
      • Web interface usage
        • Authentication
        • Presentation of Rudder Web Interface
        • Quick search anything
      • Node management
        • Node inventory
        • Accept new nodes
        • Search nodes
        • Group of Nodes
      • Advanced node management
        • Create node API
        • Override node FQDN
        • Reinitialize policies for a Node
        • Completely reinitialize a Node
        • Change the agent run schedule
        • Installation of the Rudder Agent
        • Rudder Agent interactive
        • Processing new inventories on the server
        • Agent execution frequency on nodes
        • Extend node inventory
        • Node Lifecycle
        • Disable the service listening for remote run on nodes
        • Single directive execution
      • Configuration concepts
        • Techniques
        • Directives
        • Rules
        • Variables and Values
        • Compliance and Drift Assessment
        • Rudder score
        • Policy Mode (Audit/Enforce)
        • Reporting Mode (non-compliant only)
        • Non-answering nodes and configuration of last compliance validity
      • Technique editor
        • Introduction
        • Technique Editor
        • Create your first Technique
      • Variables
        • Generalities
        • Variables definition purpose: configuration data or source of environment knowledge?
        • Using variables
        • Auto-conditions
      • Advanced configuration management
        • Policy generation
        • Server Event Hooks
        • New directives default naming scheme
        • Policies ordering
        • Share files between nodes
        • Update technique resources from command line
        • Import / Export archive of rules, directives, techniques, groups and related dependencies
      • REST API
    • Administration
      • Server administration
        • Configuration repository
        • Archives
        • Event Logs
        • Health Check
        • Policy Server
        • Basic administration of Rudder services
        • Communication resilience in case of network or Rudder server outage
        • rudder-cf-serverd logging
        • Optional usage survey and data collection
      • Agent administration
        • Package manager data caching
      • User management
        • Configuration files related to user authentication and authorizations
        • Authentication providers configuration
        • User configuration file
        • User roles and fine-grained authorizations
      • Maintenance procedures
        • Database maintenance
        • Server backup and migration
        • Relay backup and migration
        • Agent backup and migration
        • Password management
      • Performance tuning
        • Disk usage
        • Reports retention
        • Apache web server
        • Jetty
        • Java "Out Of Memory Error"
        • Configure RAM allocated to Jetty
        • Configure Jetty for very small instances
        • Make better use of resources
        • LDAP connection pool configuration
        • Configure PostgreSQL server
        • Agent
      • Monitoring
        • Monitoring Rudder itself
        • Monitoring your configuration management
      • Server installation options
        • Installation modifiers with environment variables
      • Integration
        • Use Rudder inventory in other tools
        • Existing third party integration
        • Integrate Rudder thanks to its APIs
      • Uninstall
        • Uninstall Rudder agent on a node
        • Uninstalling Rudder relay servers
        • Uninstalling Rudder root server
      • Rudder security & hardening
        • Server
        • Agent
        • Network
      • Webapp administration
        • Configuration
        • Data files
        • HTTP
        • Logging
        • Performance
        • Monitoring
      • Relayd administration
        • Configuration
        • Data files
        • API
        • Logging
        • Monitoring
        • Security
        • Synchronization via ssh
      • Slapd administration
        • Configuration
        • Data files
        • Backup
        • Logging
        • Security
      • Change server ports
        • Change listening ports on the root server
        • Set connection port on the agents (for nodes, relays, and root server)
      • Troubleshooting
        • Inventory problem
        • Compliance problem
        • Agent problems
    • Plugins
      • Manage plugins
        • Install plugins with a subscription
        • Manual plugins installation
        • More about plugins
      • API authorizations
        • User personal API Token
        • API ACLs
      • Authentication backends
        • Configuring log level
        • Centralized user authorization management with OIDC
        • Configure login form rendering
        • Configure enabled backends
        • Root access when external authentication is not working
        • LDAP / AD backend configuration
        • OAUTHv2 / OpenID Connect (OIDC)
      • Branding
      • Centreon
        • Installation
        • Usage
      • Change validation
        • What is a Change request ?
        • Change request management page
        • How to create a Change request ?
        • How to validate a Change request ?
        • Change request and conflicts
        • Notifications
        • Validated User
      • Consul
        • Installation
        • Usage
      • CVE
        • CVE plugin overview
        • Installation, requirements and settings
        • Vulnerability assessment
        • Interactive check and CVE database update
        • How CVE are detected.
        • How can I remediate my security vulnerabilities?
      • Node properties data sources
        • Data source configuration screen
        • First set: data source description
        • Second set: query configuration
        • Third set: query triggers
        • Field description
        • Deleting a data source
      • DSC
      • DSC
      • GLPI
        • Installation
        • Usage
      • Multi-tenants
        • How to use
      • Node external reports
        • Documents naming convention
        • Plugin configuration
        • Configuration file location
        • Configuration file format
      • Notification
        • Installation
        • Usage
        • Authors
        • Contributing
      • OpenSCAP
        • Installation
        • Usage
        • Rudder Webapp integration
      • Reporting
        • Usage
      • Scale out relay servers
      • Secret Management
        • How to use
      • Security benchmark
      • System updates
        • Specific rights and roles
        • List available updates
        • Apply updates
      • Vault
        • Installation
        • Usage
      • Zabbix
        • Installation
        • Usage
    • Reference
      • Contribute
        • Licenses
        • Bugs prioritization
      • Rudder architecture
        • Inventory workflow, from nodes to Root server
        • Rudder Server data workflow
        • Configuration files for Rudder Server
        • Rudder agent workflow
        • Configuration files for a Node
        • Packages organization
      • Build packages from source
        • Building the Rudder agent
      • Man pages
        • rudder(8)
        • rudder-relayd(1)
      • Variables
        • Technical implementation of Node properties
      • Plugin format
        • File description
      • Security considerations
        • Data confidentiality
        • Node-Server communication security
      • Generic methods
        • Audit
        • Command
        • Condition
        • Directory
        • Dsc
        • Environment
        • File
        • Group
        • Http
        • Kernel
        • Monitoring
        • Package
        • Permissions
        • Powershell
        • Registry
        • Report
        • Rudder
        • Schedule
        • Service
        • Sharedfile
        • Sysctl
        • User
        • Variable
        • Windows
      • Generic methods guidelines
        • Rudder generic methods project
      • Reports reference
        • Concepts
      • Technique reference
        • Files organisation
        • General Rules
        • Details of the metadata.xml file
        • Examples
        • Separated policy generation
        • Known limitations
        • Syntax of the Techniques
        • Best Practices for Techniques
        • Technique upgrade
      • Jetty server configuration
        • Jetty start and JVM parameters
        • Jetty modules configurations architecture
        • Jetty directories
        • Other Jetty places
        • Rudder default start.ini
      • Logs reference
        • Server side
        • Linux agents
        • Windows agents
      • Frequently Asked Questions
        • General
        • Security
  • Reference manual
  • Usage
  • REST API
8.3 8.2 8.1
Edit this Page

REST API

Rudder provides a complete REST API that gives access to the same features as the Web interface (and even more).

Read the API documentation for more information about usage and available features.


← Advanced configuration management Server administration →

This page was built using the Antora default UI.

The source code for this UI is licensed under the terms of the MPL-2.0 license.