Rudder API

Rudder API

API version: 22

Auth

ApiKey X-API-Token in header

Base URL

https://{rudderServer}/rudder/api/latest

Setup

1. Set your API key in the appropriate header
2. GET /api/changeRequests -- verify access
3. POST /apiaccounts -- create first apiaccounts

Endpoints

176 endpoints across 31 groups. See references/api-spec.lap for full details.

api

apiaccounts

archives

branding

campaigns

changeRequests

compliance

cve

datasources

directives

groups

info

inventories

methods

nodes

openscap

parameters

plugins

rules

scaleoutrelay

secret

securitytags

settings

status

system

systemUpdate

techniques

tenants

usermanagement

users

validatedUsers

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all changeRequests?" -> GET /api/changeRequests
• "List all apiaccounts?" -> GET /apiaccounts
• "Create a apiaccount?" -> POST /apiaccounts
• "Get ${apiAccountId} details?" -> GET /apiaccounts/${apiAccountId}
• "Delete a ${apiAccountId}?" -> DELETE /apiaccounts/${apiAccountId}
• "Create a regenerate?" -> POST /apiaccounts/${apiAccountId}/regenerate
• "List all token?" -> GET /apiaccounts/token
• "List all export?" -> GET /archives/export
• "Create a import?" -> POST /archives/import
• "List all branding?" -> GET /branding
• "Create a branding?" -> POST /branding
• "Create a reload?" -> POST /branding/reload
• "List all campaigns?" -> GET /campaigns
• "Create a campaign?" -> POST /campaigns
• "List all events?" -> GET /campaigns/events
• "Get event details?" -> GET /campaigns/events/{id}
• "Delete a event?" -> DELETE /campaigns/events/{id}
• "Get campaign details?" -> GET /campaigns/{id}
• "Delete a campaign?" -> DELETE /campaigns/{id}
• "List all events?" -> GET /campaigns/{id}/events
• "Create a schedule?" -> POST /campaigns/{id}/schedule
• "Get changeRequest details?" -> GET /changeRequests/{changeRequestId}
• "Delete a changeRequest?" -> DELETE /changeRequests/{changeRequestId}
• "Create a accept?" -> POST /changeRequests/{changeRequestId}/accept
• "List all compliance?" -> GET /compliance
• "List all directives?" -> GET /compliance/directives
• "Get directive details?" -> GET /compliance/directives/{directiveId}
• "Get group details?" -> GET /compliance/groups/{targetOrNodeGroupId}
• "List all target?" -> GET /compliance/groups/{targetOrNodeGroupId}/target
• "List all nodes?" -> GET /compliance/nodes
• "Get node details?" -> GET /compliance/nodes/{nodeId}
• "List all rules?" -> GET /compliance/rules
• "Get rule details?" -> GET /compliance/rules/{ruleId}
• "List all cve?" -> GET /cve
• "Create a check?" -> POST /cve/check
• "List all config?" -> GET /cve/check/config
• "Create a config?" -> POST /cve/check/config
• "List all last?" -> GET /cve/check/last
• "Create a list?" -> POST /cve/list
• "Create a update?" -> POST /cve/update
• "Create a f?" -> POST /cve/update/fs
• "Get cve details?" -> GET /cve/{cveId}
• "List all datasources?" -> GET /datasources
• "Create a reload?" -> POST /datasources/reload
• "Get datasource details?" -> GET /datasources/{datasourceId}
• "Delete a datasource?" -> DELETE /datasources/{datasourceId}
• "List all directives?" -> GET /directives
• "List all tree?" -> GET /directives/tree
• "Get directive details?" -> GET /directives/{directiveId}
• "Delete a directive?" -> DELETE /directives/{directiveId}
• "Create a check?" -> POST /directives/{directiveId}/check
• "List all groups?" -> GET /groups
• "Get category details?" -> GET /groups/categories/{groupCategoryId}
• "Delete a category?" -> DELETE /groups/categories/{groupCategoryId}
• "List all tree?" -> GET /groups/tree
• "Get group details?" -> GET /groups/{groupId}
• "Delete a group?" -> DELETE /groups/{groupId}
• "Create a reload?" -> POST /groups/{groupId}/reload
• "List all info?" -> GET /info
• "Get detail details?" -> GET /info/details/{endpointName}
• "Get info details?" -> GET /info/{sectionId}
• "Create a upload?" -> POST /inventories/upload
• "Create a restart?" -> POST /inventories/watcher/restart
• "Create a start?" -> POST /inventories/watcher/start
• "Create a stop?" -> POST /inventories/watcher/stop
• "List all methods?" -> GET /methods
• "Create a reload?" -> POST /methods/reload
• "Search nodes?" -> GET /nodes
• "Create a applyPolicy?" -> POST /nodes/applyPolicy
• "Search pending?" -> GET /nodes/pending
• "Create a pending?" -> POST /nodes/pending
• "List all status?" -> GET /nodes/status
• "Get node details?" -> GET /nodes/{nodeId}
• "Delete a node?" -> DELETE /nodes/{nodeId}
• "Create a applyPolicy?" -> POST /nodes/{nodeId}/applyPolicy
• "Create a fetchData?" -> POST /nodes/{nodeId}/fetchData
• "List all inheritedProperties?" -> GET /nodes/{nodeId}/inheritedProperties
• "Get report details?" -> GET /openscap/report/{nodeId}
• "List all parameters?" -> GET /parameters
• "Get parameter details?" -> GET /parameters/{parameterId}
• "Delete a parameter?" -> DELETE /parameters/{parameterId}
• "List all info?" -> GET /plugins/info
• "List all settings?" -> GET /plugins/settings
• "Create a setting?" -> POST /plugins/settings
• "List all rules?" -> GET /rules
• "Get category details?" -> GET /rules/categories/{ruleCategoryId}
• "Delete a category?" -> DELETE /rules/categories/{ruleCategoryId}
• "List all tree?" -> GET /rules/tree
• "Get rule details?" -> GET /rules/{ruleId}
• "Delete a rule?" -> DELETE /rules/{ruleId}
• "List all secret?" -> GET /secret
• "Create a secret?" -> POST /secret
• "Get secret details?" -> GET /secret/{name}
• "Delete a secret?" -> DELETE /secret/{name}
• "Create a node?" -> POST /securitytags/nodes
• "List all settings?" -> GET /settings
• "Get allowed_network details?" -> GET /settings/allowed_networks/{nodeId}
• "Create a diff?" -> POST /settings/allowed_networks/{nodeId}/diff
• "Get setting details?" -> GET /settings/{settingId}
• "List all status?" -> GET /status
• "Get archive details?" -> GET /system/archives/{archiveKind}
• "Get zip details?" -> GET /system/archives/{archiveKind}/zip/{commitId}
• "List all healthcheck?" -> GET /system/healthcheck
• "List all info?" -> GET /system/info
• "Create a purgeSoftware?" -> POST /system/maintenance/purgeSoftware
• "Create a policy?" -> POST /system/regenerate/policies
• "Create a reload?" -> POST /system/reload
• "Create a group?" -> POST /system/reload/groups
• "Create a technique?" -> POST /system/reload/techniques
• "List all status?" -> GET /system/status
• "Create a policy?" -> POST /system/update/policies
• "List all history?" -> GET /systemUpdate/campaign/{id}/history
• "List all report?" -> GET /systemUpdate/events/{id}/report
• "List all result?" -> GET /systemUpdate/events/{id}/result
• "Get result details?" -> GET /systemUpdate/events/{id}/result/{nodeId}
• "List all summaryReport?" -> GET /systemUpdate/events/{id}/summaryReport
• "List all techniques?" -> GET /techniques
• "List all categories?" -> GET /techniques/categories
• "Create a reload?" -> POST /techniques/reload
• "List all versions?" -> GET /techniques/versions
• "Get technique details?" -> GET /techniques/{techniqueId}
• "List all directives?" -> GET /techniques/{techniqueId}/directives
• "Delete a technique?" -> DELETE /techniques/{techniqueId}/{techniqueVersion}
• "Get technique details?" -> GET /techniques/{techniqueId}/{techniqueVersion}
• "List all directives?" -> GET /techniques/{techniqueId}/{techniqueVersion}/directives
• "List all resources?" -> GET /techniques/{techniqueId}/{techniqueVersion}/resources
• "List all revisions?" -> GET /techniques/{techniqueId}/{techniqueVersion}/revisions
• "List all tenants?" -> GET /tenants
• "Create a tenant?" -> POST /tenants
• "Get tenant details?" -> GET /tenants/{id}
• "Create a usermanagement?" -> POST /usermanagement
• "List all roles?" -> GET /usermanagement/roles
• "Update a activate?" -> PUT /usermanagement/status/activate/{username}
• "Update a disable?" -> PUT /usermanagement/status/disable/{username}
• "List all users?" -> GET /usermanagement/users
• "Create a reload?" -> POST /usermanagement/users/reload
• "Delete a usermanagement?" -> DELETE /usermanagement/{username}
• "List all users?" -> GET /users
• "Create a validatedUser?" -> POST /validatedUsers
• "Delete a validatedUser?" -> DELETE /validatedUsers/{username}
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP