Jump to Content
Documentation
API Reference
Release Notes
v24.10
v25.1
v25.1.2
v25.1.3
v25.1.5
v25.1.7
API Reference
v25.1.7
Documentation
API Reference
Release Notes
Get role details
All
Pages
Start typing to search…
JUMP TO
Endpoint Privilege Management Linux API
BTPlatform
Get PMUL client installation token
get
DirectoryServices
Test the Directory Services connection with optional override settings
post
Get list of all domains in the forest
get
Get the Entra user schema
get
Update an existing Entra Group
put
Add multiple members to multiple Entra Groups
put
Update Group attributes including schema attributes
put
Get list of Groups and GIDs from Entra
get
Get suggested Group GID from Entra
get
Get the list of Entra Group Members
get
Get the Entra group definition
get
Add users to Entra Group
put
Delete users from Entra Group
put
Update User attributes including schema attributes, referenced by group membership
put
Import Entra User/Group Schema Attributes
post
Create or update Entra ID schema
put
Get the Entra group schema
get
Get the Entra user schema
get
Update a new Entra User
put
Update User attributes including schema attributes
put
Get the Entra User Group Membership
get
Get suggested user UID from Entra
get
Get the Entra user definition
get
Search for OUs in a given OU
get
Search for groups
get
Search for users
get
Test the Directory Services connection
get
Get the list of Entra groups
get
Get list of Entra Users
get
PMUL
List downloadable client packages
get
Create PMUL client package
post
Retrieve client package build status
get
Delete a PMUL client package
del
Get enhanced license information
get
Get license server clients information
get
Retire license clients
put
List eventlog events
get
Get feature availability for all active PMUL servers
get
List Change Management events
get
Get enhanced license information
get
Put enhanced license information
put
Upload enhanced license file
post
Eventlog event details
get
List queryable event destinations configured for a PMUL host
get
List Iologs detailed in the PMUL event log
get
Delete IOLogs detailed in a given PMUL event log
del
Download eventlog file for a PMUL host
get
List eventlog files for a PMUL host
get
List events using the PMUL V2 Event API
get
List events using the PMUL V2 Event API
get
Get feature availability
get
List host system groups
get
Get license information
get
Get license server clients information
get
Retire license clients
put
List settings
get
Update Settings
put
verify Settings
post
Get setting
get
Get settings file
get
Get PMUL REST status
get
Get PMUL host system info
get
List host system users
get
List Change Management events
get
ExternalAPIs
List all External APIs
get
Create a new External API record
post
Get External API configuration information by ID
get
Update an External API configuration record
put
Delete an External API configuration record
del
Get External API information by ID
get
Update an External API record
put
Delete an External API record
del
Iolog
Return a list of commands that were run in the iolog session
get
Return Playback history for an Iolog file
get
Create Playback record for an Iolog file
post
Update Playback record for an Iolog file
put
Get IOLOG replay data
get
Return a list of commands that were run in the iolog session
get
Get IOLOG variable data
get
Return shadow record for an Iolog file
put
List IOLOG files
get
Get a list of commands that were run in the iolog session by event id
get
Get IOLOG replay data by event id
get
Return a list of commands that were run in the iolog session by event id
get
Get IOLOG variable data by event id
get
RBP
Get all RBP Test Suites
get
Create RBP test suite
post
Create rbp test
post
Update rbp test
put
Delete rbp test
del
Get RBP Test Suite with Test details
get
Update RBP Test Suite
put
Delete rbp test suite
del
List RBP Entities
get
Delete all RBP policy
del
Get Command Groups
get
Create/Update Command Groups
post
Delete Command Groups
del
Get Commands for a Command Group
get
Create/Update Commands for a Command Group
post
Delete Commands from a Command Group
del
Get the updates between two RBP Policy versions
get
Retrieve a RBP entitlement report.
get
Retrieve a RBP entitlement report.
get
Export PMUL's RBP Policy Database
get
Get Host Groups
get
Create/Update Host Groups
post
Delete Host Groups
del
Get Hosts for a Host Group
get
Create/Update Hosts for a Host Group
post
Delete Hosts from a Host Group
del
Import RBP Policy Database
post
Revert RBP Policy Database
post
Get RBP Roles
get
Create/Update Roles
post
Delete RBP Roles
del
/api/pbul/{hostid}/rbp/roles/duplicate/{roleid}
post
Get Command Groups for a Role
get
Add Command Group to Roles
post
Delete Command Group from a Role
del
Get Host Groups for a Role
get
Add Host Group to Roles
post
Delete Host Group from a Role
del
Get Time/Date Groups for a Role
get
Add Time/Date Group to Roles
post
Delete TimeDate Group from a Role
del
Get User Groups for a Role
get
Add User Group to Roles
post
Delete User Group from a Role
del
Run RBP Test Suite, returning result
get
Get Time/Date Groups
get
Create/Update Time/Date Groups
post
Delete Time/Date Groups
del
Get Time/Dates for a Time/Date Group
get
Create/Update Time/Dates for a Time/Date Group
post
Delete Time/Dates from a Time/Date Group
del
Get Current/Active RBP transaction details
get
Delete the current/active RBP Transaction
del
Begin an RBP transaction
post
Commit an RBP transaction
post
Rollback an RBP transaction
post
Get User Groups
get
Create/Update User Groups
post
Delete User Group RBP Entities
del
/api/pbul/{hostid}/rbp/usergrps/multiple
post
Get Users for a User Group
get
Create/Update Users for a User Group
post
Delete User RBP Entities
del
List RBP versions
get
Get Command Groups
get
Delete Command RBP Entities
post
/api/v6/pbul/{hostid}/rbp/cmdgrps/import
post
Get Commands for a Command Group
get
Create/Update Commands for a Command Group
post
Create/Update Commands for a Command Group
post
Delete RBP Entities
post
Get Host Groups
get
Delete Host RBP Entities
post
/api/v6/pbul/{hostid}/rbp/hostgrps/import
post
Get Hosts for a Host Group
get
Create/Update Hosts for a Host Group
post
Create/Update Hosts for a Host Group
post
Get specified Role with all its role details
get
Get RBP Roles
get
Get Time/Date Groups
get
Delete Time/Dates RBP Entities
post
Get Time/Dates for a Time/Date Group
get
Create/Update Time/Dates for a Time/Date Group
post
Get User Groups
get
/api/v6/pbul/{hostid}/rbp/usergrps/import
post
Delete User RBP Entities
post
Get Users for a User Group
get
Create/Update Users for a User Group
post
Create/Update Users for a User Group
post
Delete RBP Entities
post
Import RBP Policy Database
post
Begin an RBP Import transaction
post
Settings
List settings
get
Authentication
List roles
get
Get role details
get
Set all groups for a role
put
Set all users for a role
put
Get all user details
get
Get user details for all local and remote users and groups
get
Get user details
get
Set all roles for a user
put
Add a role to a user
put
Remove a role for a user
del
Get all user details
get
Log out of the application
post
Get current user details
get
Hosts
Return a Managed Host with Profile Information
get
ApplicationFeatures
Get Features Status
get
Audit
List all user sessions
get
List all session categories
get
List all requests in a user session
get
SIEMs
List all configured SIEMs
get
Create a new Elastic configuration
post
Test Elastic configuration details
post
Get Elastic configuration details
get
Update Elastic configuration details
put
Delete Elastic configuration details
del
Validate if a query is valid BIUL query language
post
Search for PMUL Event data
post
Upload
Upload generic file
post
Powered by
Get role details
get
https://example.com/api/v1/auth/roles/
{rolename}
Get details of a Role
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
Response
Click
Try It!
to start a request and see the response here!