Jump to Content
Home
Guides
API Reference
Central
EdgeConnect SD-WAN
AOS 8
Fabric Composer
New Central
AOS-CX
User Experience Insight
ClearPass Policy Manager
v6.9.0
v6.10.7
v6.11.0
v6.11.10
v6.11.11
v6.12.0
v6.12.4
Guides
API Reference
GitHub
Airheads Developer Community
Log In
API Reference
Guides
API Reference
GitHub
Airheads Developer Community
Log In
ClearPass Policy Manager
v6.11.0
API Reference
Replace an endpoint
Search
JUMP TO
Global Server Configuration
AdminPrivilege
Get a list of admin privileges
get
Create a new admin privilege
post
Get an admin privilege
get
Update some fields of an admin privilege
patch
Replace an admin privilege
put
Delete an admin privilege
delete
Get an admin privilege by name
get
Update some fields of an admin privilege by name
patch
Replace an admin privilege by name
put
Delete an admin privilege by name
delete
AdminUser
Get a list of admin users
get
Create a new admin user
post
Get an admin user
get
Update some fields of an admin user
patch
Replace an admin user
put
Delete an admin user
delete
Get an admin user by user_id
get
Update some fields of an admin user by user_id
patch
Replace an admin user by user_id
put
Delete an admin user by user_id
delete
AdminUserPasswordPolicy
Get the admin user password policies
get
Put the admin user password policies
put
Patch the admin user password policies
patch
ApplicationLicense
Get a list of application licenses
get
Create a new application license
post
Get a license by license id
get
Update a license by license id
put
Delete a license by license id
delete
Activate license online by license id
patch
Activate license offline by license id
patch
Get application license summary
get
Attribute
Get a list of attributes
get
Create a new attribute
post
Get an attribute
get
Update some fields of an attribute
patch
Replace an attribute
put
Delete an attribute
delete
Get an attribute by name
get
Update some fields of an attribute by name
patch
Replace an attribute by name
put
Delete an attribute by name
delete
ClearPassPortal
Get ClearPass Portal
get
Change ClearPass Portal
post
ClusterDbSync
Synchronize subscriber with the publisher
post
ClusterWideParameter
Get cluster wide parameters
get
Replace cluster wide parameters
put
Update some cluster wide parameters
patch
DataFilter
Get a list of data filters
get
Create a new data filter
post
Get a data filter
get
Update a data filter
patch
Replace a data filter
put
Delete a data filter
delete
Get a data filter by name
get
Update a data filter by name
patch
Replace a data filter by name
put
Delete a data filter by name
delete
FileBackupServer
Get a list of file backup server
get
Create a new file backup server
post
Get a file backup server
get
Update some fields of a file backup server
patch
Replace a file backup server
put
Delete a syslog export filter
delete
Get a file backup server by host_address
get
Update some fields of a file backup server by host_address
patch
Replace a file backup server by host_address
put
Delete a syslog export filter by host_address
delete
ListAllPrivileges
Returns the list of system-defined privileges
get
LocalUserPasswordPolicy
Get the local user password policy
get
Put the local user password policy
put
Patch the local user password policy
patch
MessagingSetup
GET Messaging setup
get
Configure Messaging setup
post
Reset Messaging setup configuration
delete
OperatorProfile
Get a list of operator profiles
get
Create a new operator profile
post
Get an operator profile
get
Update an operator profile
patch
Replace an operator profile
put
Delete an operator profile
delete
Get an operator profile by name
get
Update an operator profile by name
patch
Replace an operator profile by name
put
Delete an operator profile by name
delete
PolicyManagerZone
Get list of Policy Manager Zones
get
Create Policy Manager Zone
post
Get Policy Manager Zone
get
Update Policy Manager Zone
put
Delete Policy Manager Zone
delete
Get Policy Manager Zone by name
get
Update Policy Manager Zone by name
put
Delete Policy Manager Zone by name
delete
SnmpTrapReceiver
Get a list of Snmp Trap Receiver
get
Create a new Snmp Trap Receiver
post
Get a Snmp Trap Receiver
get
Update some fields of Snmp Trap Receiver
patch
Replace a Snmp Trap Receiver
put
Delete a Snmp Trap Receiver
delete
Get a Snmp Trap Receiver by name
get
Update some fields of Snmp Trap Receiver by name
patch
Replace a Snmp Trap Receiver by name
put
Delete a Snmp Trap Receiver by name
delete
Tools And Utilities
EmailSend
Send an Email
post
RandomMpskGenerator
GET_for_RandomMpskGenerator
get
POST_for_RandomMpskGenerator
post
RandomPasswordGenerator
GET_for_RandomPasswordGenerator
get
POST_for_RandomPasswordGenerator
post
SmsSend
Send an SMS message
post
Platform Certificates
CertSignRequest
Post a certificate sign request
post
CertTrustList
Get a list of certificate trust list
get
Add a new certificate trust list
post
Get a certificate trust list
get
Enbale certificate trust list
patch
Delete a certificate trust list
delete
CertTrustListDetails
Get a list of certificate trust list details
get
Get a certificate trust list details
get
ClientCert
Get a list of client certificates
get
Add a client certificate
post
Get a client certificate
get
Delete a client certificate
delete
RevocationList
Get a list of revocation certificate list
get
Add a new revocation certificate list
post
Get a certificate by id
get
Update a certificate
patch
Delete a certificate list by id
delete
SelfSignedCert
Create a Self-Signed Certificate
post
ServerCert
Get a list of server certificates
get
Get server certificate
get
Get a server certificate
get
Add a server certificate
put
Update a server certificate
patch
Update a server certificate
patch
ServiceCert
Get a list of service certificates
get
Add a service certificate
post
Get a service certificate
get
Delete a service certificate
delete
API Operations
TokenEndpoint
Obtain an OAuth2 access token for making API calls
post
TokenInfo
Returns OAuth2 authenticated client or user information
get
Returns OAuth2 authenticated client or user information
post
TokenPrivileges
Returns a list of privileges available to the user
get
Endpoint Visibility
AgentlessOnGuardSettings
Get a list of Agentless OnGuard Settings
get
Add an Agentless OnGuard Setting
post
Get an Agentless OnGuard Setting
get
Update some fields of an Agentless OnGuard Setting
patch
Replace an Agentless OnGuard Setting
put
Delete an Agentless OnGuard Setting
delete
Get an Agentless OnGuard Setting by name
get
Update some fields of an Agentless OnGuard Setting by name
patch
Replace an Agentless OnGuard Setting by name
put
Delete an Agentless OnGuard Setting by name
delete
AgentlessOnGuardSubnetMapping
Get a list of subnet mappings
get
Add a subnet mapping
post
Get a subnet mapping
get
Update some fields of a subnet mapping
patch
Replace a subnet mapping
put
Delete a subnet mapping
delete
Get a subnet mapping by name
get
Update some fields of a subnet mapping by name
patch
Replace a subnet mapping by name
put
Delete a subnet mapping by name
delete
Enable Agentless OnGuard Settings on client subnets
patch
Disable Agentless OnGuard Settings on client subnets
patch
Enable Agentless OnGuard Settings on client subnets by subnet mapping name
patch
Disable Agentless OnGuard Settings on client subnets by subnet mapping name
patch
DeviceFingerprint
Post device fingerprint attributes for profiling
post
Get profiled device
get
Delete fingerprint of profiled device
delete
FingerprintDictionary
Get a list of Fingerprints
get
Create a new Fingerprint
post
Get a Fingerprint
get
Update some fields of a Fingerprint
patch
Replace a Fingerprint
put
Delete a Fingerprint
delete
Get a Fingerprint by name
get
Update some fields of a Fingerprint by name
patch
Replace a Fingerprint by name
put
Delete a Fingerprint by name
delete
NetworkScan
Get a list of NetworkScan
get
Add a NetworkScan
post
Get a NetworkScan
get
Update some fields of a NetworkScan
patch
Update all fields of a NetworkScan
put
Delete a NetworkScan
delete
Update some fields of a NetworkScan
patch
Update some fields of a NetworkScan
patch
OnGuardActivity
Get a list of Clearpass OnGuard Endpoints
get
Get a Clearpass OnGuard Endpoint Details
get
Get a Clearpass OnGuard Endpoint Details by host_mac
get
Send/Broadcast Message
post
Send/Broadcast Notification
post
OnGuardCustomScript
Get a list of OnGuard Custom Scripts
get
Create a new OnGuard Custom Script
post
Get an OnGuard Custom Script
get
Update some fields of an OnGuard Custom Script
patch
Replace an OnGuard Custom Script
put
Delete an OnGuard Custom Script
delete
Get an OnGuard Custom Script by name
get
Update some fields of an OnGuard Custom Script by name
patch
Replace an OnGuard Custom Script by name
put
Delete an OnGuard Custom Script by name
delete
OnGuardGlobalSettings
Get OnGuard global settings
get
Update OnGuard global settings
post
OnGuardSettings
Get OnGuard settings
get
Update OnGuard settings
post
OnGuardZoneMapping
Get Policy Manager Zones with associated authentication server IP addresses(Client Subnets and Server IPs)
get
Post Policy Manager Zones with associated authentication server IP addresses
post
Get Client Subnets and Server IPs for Policy Manager Zone
get
Update authentication server IP addresses for Policy Manager Zone
patch
Post Client Subnets and Server IPs for Policy Manager Zone
put
Delete authentication server IP addresses for Policy Manager Zone
delete
Get Client Subnets and Server IPs for Policy Manager Zone by name
get
Update authentication server IP addresses for Policy Manager Zone by name
patch
Post Client Subnets and Server IPs for Policy Manager Zone by name
put
Delete authentication server IP addresses for Policy Manager Zone by name
delete
ProfilerSubnetMapping
Get a list of profiler subnet mappings
get
Add a profiler subnet mapping
post
Get a profiler subnet mapping
get
Update some fields of a profiler subnet mapping
patch
Replace a profiler subnet mapping
put
Delete a profiler subnet mapping
delete
Get a profiler subnet mapping
get
Update some fields of a profiler subnet mapping
patch
Replace a profiler subnet mapping
put
Delete a profiler subnet mapping
delete
WindowsHotfix
Get a list of Windows Hotfixes
get
Add a Windows Hotfix
post
Get a windows hotfix
get
Update some fields of a windows hotfix
patch
Replace a windows hotfix
put
Delete a windows hotfix
delete
Get a windows hotfix by kbid and os
get
Update some fields of a windows hotfix by kbid and os
patch
Replace a windows hotfix by kbid and os
put
Delete a windows hotfix by kbid and os
delete
Enforcement Profile
CaptivePortalProfile
GET a list of Captive Portal Profiles
get
Add a Captive Portal Profile
post
Get a Captive Portal Profile
get
Update some fields of a Captive Portal Profile
patch
Replace a Captive Portal Profile
put
Delete a Captive Portal Profile
delete
Get a Captive Portal Profile by name
get
Update some fields of a Captive Portal Profile by name
patch
Replace a Captive Portal Profile by name
put
Delete a Captive Portal Profile by name
delete
DURClass
GET a list of Policies
get
Add a DUR Class
post
Get a DUR Class
get
Update a DUR Class
patch
Replace a DUR Class
put
Delete a DUR Class
delete
Get a DUR Class by name
get
Update a DUR Class by name
patch
Replace a DUR Class by name
put
Delete a DUR Class by name
delete
EnforcementProfile
Get a list of Enforcement Profiles
get
Create a new Enforcement Profile
post
Get an Enforcement Profile
get
Update an Enforcement Profile
patch
Replace an Enforcement Profile
put
Delete an Enforcement Profile
delete
Get an Enforcement Profile by name
get
Update an Enforcement Profile by name
patch
Replace an Enforcement Profile by name
put
Delete an Enforcement Profile by name
delete
EthertypeAccessControlList
GET a list of Ethertype Access Control Lists
get
Add a Ethertype Access Control List
post
Get a Ethertype Access Control List
get
Update a Ethertype Access Control List
patch
Replace a Ethertype Access Control List
put
Delete a Ethertype Access Control List
delete
Get a Ethertype Access Control List by name
get
Update a Ethertype Access Control List by name
patch
Replace a Ethertype Access Control List by name
put
Delete a Ethertype Access Control List by name
delete
MACAccessControlList
GET a list of MAC Access Control Lists
get
Add a MAC Access Control List
post
Get a MAC Access Control List
get
Update some fields of a MAC Access Control List
patch
Replace a MAC Access Control List
put
Delete a MAC Access Control List
delete
Get a MAC Access Control List by name
get
Update some fields of a MAC Access Control List by name
patch
Replace a MAC Access Control List by name
put
Delete a MAC Access Control List by name
delete
NATPool
GET a list of NAT Pools
get
Add a NAT Pool
post
Get a NAT Pool
get
Update some fields of a NAT Pool
patch
Replace a NAT Pool
put
Delete a NAT Pool
delete
Get a NAT Pool by name
get
Update some fields of a NAT Pool by name
patch
Replace a NAT Pool by name
put
Delete a NAT Pool by name
delete
NetDestination
GET a list of Net Destinations
get
Add a Net Destination
post
Get a Net Destination
get
Update some fields of a Net Destination
patch
Replace a Net Destination
put
Delete a Net Destination
delete
Get a Net Destination by name
get
Update some fields of a Net Destination by name
patch
Replace a Net Destination by name
put
Delete a Net Destination by name
delete
NetService
GET a list of Net Services
get
Add a Net Service
post
Get a Net Service
get
Update some fields of a Net Service
patch
Replace a Net Service
put
Delete a Net Service
delete
Get a Net Service by name
get
Update some fields of a Net Service by name
patch
Replace a Net Service by name
put
Delete a Net Service by name
delete
PolicerProfile
GET a list of Policer Profiles
get
Add a Policer Profile
post
Get a Policer Profile
get
Update some fields of a Policer Profile
patch
Replace a Policer Profile
put
Delete a Policer Profile
delete
Get a Policer Profile by name
get
Update some fields of a Policer Profile by name
patch
Replace a Policer Profile by name
put
Delete a Policer Profile by name
delete
Policy
GET a list of Policies
get
Add a Policy
post
Get a Policy
get
Update a Policy
patch
Replace a Policy
put
Delete a Policy
delete
Get a Policy by name
get
Update a Policy by name
patch
Replace a Policy by name
put
Delete a Policy by name
delete
QoSProfile
GET a list of QoS Profiles
get
Add a QoS Profile
post
Get a QoS Profile
get
Update some fields of a QoS Profile
patch
Replace a QoS Profile
put
Delete a QoS Profile
delete
Get a QoS Profile by name
get
Update some fields of a QoS Profile by name
patch
Replace a QoS Profile by name
put
Delete a QoS Profile by name
delete
SessionAccessControlList
GET a list of Session Access Control Lists
get
Add a Session Access Control List
post
Get a Session Access Control List
get
Update some fields of a Session Access Control List
patch
Replace a Session Access Control List
put
Delete a Session Access Control List
delete
Get a Session Access Control List by name
get
Update some fields of a Session Access Control List by name
patch
Replace a Session Access Control List by name
put
Delete a Session Access Control List by name
delete
StatelessAccessControlList
GET a list of Stateless Access Control Lists
get
Add a Stateless Access Control List
post
Get a Stateless Access Control List
get
Update some fields of a Stateless Access Control List
patch
Replace a Stateless Access Control List
put
Delete a Stateless Access Control List
delete
Get a Stateless Access Control List by name
get
Update some fields of a Stateless Access Control List by name
patch
Replace a Stateless Access Control List by name
put
Delete a Stateless Access Control List by name
delete
TimeRange
GET a list of Time Ranges
get
Add a Time Range
post
Get a Time Range
get
Update some fields of a Time Range
patch
Replace a Time Range
put
Delete a Time Range
delete
Get a Time Range by name
get
Update some fields of a Time Range by name
patch
Replace a Time Range by name
put
Delete a Time Range by name
delete
VoIPProfile
GET a list of VoIP Profiles
get
Add a VoIP Profile
post
Get a VoIP Profile
get
Update some fields of a VoIP Profile
patch
Replace a VoIP Profile
put
Delete a VoIP Profile
delete
Get a VoIP Profile by name
get
Update some fields of a VoIP Profile by name
patch
Replace a VoIP Profile by name
put
Delete a VoIP Profile by name
delete
Logs
EndpointInfo
Get a single endpoint by MAC address
get
Look up endpoints by IP address
get
Look up endpoints by IP address range
get
Look up endpoints by time range
get
LoginAudit
Get previous login details for an admin user
get
SystemEvents
Get a list of system events
get
Create a new system event
post
Insight
Alert
Get all Insight alert configurations.
get
Create an Insight alert configuration.
post
Get an Insight alert configuration by id.
get
Partial update of an Insight alert configuration by id.
patch
Complete update of an Insight alert configuration by id.
put
Delete an Insight alert configuration by id.
delete
Get an Insight alert configuration by name.
get
Partial update of an Insight alert configuration by name.
patch
Complete update of an Insight alert configuration by name.
put
Delete an Insight alert configuration by name.
delete
Enable an Insight alert configuration by id.
patch
Disable an Insight alert configuration by id.
patch
Mute an Insight alert configuration by id.
patch
Unmute an Insight alert configuration by id.
patch
Enable an Insight alert configuration by name.
patch
Disable an Insight alert configuration by name.
patch
Mute an Insight alert configuration by name.
patch
Unmute an Insight alert configuration by name.
patch
Report
Get all Insight report configurations.
get
Create an Insight report configuration.
post
Get an Insight report configuration by id.
get
Partial update of an Insight report configuration by id.
patch
Complete update of an Insight report configuration by id.
put
Delete an Insight report configuration by id.
delete
Get an Insight report configuration by name.
get
Partial update of an Insight report configuration by name.
patch
Complete update of an Insight report configuration by name.
put
Delete an Insight report configuration by name.
delete
Enable an Insight report configuration by id.
patch
Disable an Insight report configuration by id.
patch
Enable an Insight report configuration by name.
patch
Disable an Insight report configuration by name.
patch
Run an Insight report by id.
post
Run an Insight report by name.
post
Policy Elements
ApplicationDictionary
Get a list of Application Dictionaries
get
Create a new Application Dictionary
post
Get an Application Dictionary
get
Update an Application Dictionary
patch
Replace an Application Dictionary
put
Delete an Application Dictionary
delete
Get an Application Dictionary by name
get
Update an Application Dictionary by name
patch
Replace an Application Dictionary by name
put
Delete an Application Dictionary by name
delete
AuthMethod
Get a list of authentication methods
get
Create a new authentication method
post
Get an authentication method
get
Update some fields of an authentication method
patch
Replace an authentication method
put
Delete an authentication method
delete
Get an authentication method by name
get
Update some fields of an authentication method by name
patch
Replace an authentication method by name
put
Delete an authentication method by name
delete
AuthSource
Get a list of authentication sources
get
Create a new authentication source
post
Get an authentication source
get
Update some fields of an authentication source
patch
Replace an authentication source
put
Delete an authentication source
delete
Get an authentication source by name
get
Update some fields of an authentication source by name
patch
Replace an authentication source by name
put
Delete an authentication source by name
delete
EnforcementPolicy
Get a list of enforcement policies
get
Create a new enforcement policy
post
Get a enforcement policy
get
Update a enforcement policy
patch
Replace a enforcement policy
put
Delete a enforcement policy
delete
Get a enforcement policy by name
get
Update a enforcement policy by name
patch
Replace a enforcement policy by name
put
Delete a enforcement policy by name
delete
NetworkDevice
Get a list of network devices
get
Create a new network device
post
Get a network device
get
Update some fields of a network device
patch
Replace a network device
put
Delete a network device
delete
Get a network device by name
get
Update some fields of a network device by name
patch
Replace a network device by name
put
Delete a network device by name
delete
NetworkDeviceGroup
Get a list of network device groups
get
Create a new network device group
post
Get a network device group
get
Update some fields of a network device group
patch
Replace a network device group
put
Delete a network device group
delete
Get a network device group by name
get
Update some fields of a network device group by name
patch
Replace a network device group by name
put
Delete a network device group by name
delete
PosturePolicy
Get a list of Posture Policies
get
Create a new Posture Policy
post
Get a Posture Policy
get
Update a Posture Policy
patch
Replace a Posture Policy
put
Delete a Posture Policy
delete
Get a Posture Policy by name
get
Update a Posture Policy by name
patch
Replace a Posture Policy by name
put
Delete a Posture Policy by name
delete
RADIUSDictionary
Get a list of RADIUS Dictionaries
get
Create a new RADIUS Dictionary
post
Get a RADIUS Dictionary
get
Update a RADIUS Dictionary
patch
Replace a RADIUS Dictionary
put
Get a RADIUS Dictionary by name
get
Update a RADIUS Dictionary by name
patch
Replace a RADIUS Dictionary by name
put
Enable a RADIUS Dictionary
patch
Disable a RADIUS Dictionary
patch
Enable a RADIUS Dictionary by name
patch
Disable a RADIUS Dictionary by name
patch
RADIUSDynamicAuthorizationTemplate
Get a list of RADIUS Dynamic Authorization Templates
get
Create a new RADIUS Dynamic Authorization Template
post
Get a RADIUS Dynamic Authorization Template
get
Update a RADIUS Dynamic Authorization Template
patch
Replace a RADIUS Dynamic Authorization Template
put
Delete a RADIUS Dynamic Authorization Template
delete
Get a RADIUS Dynamic Authorization Template by name
get
Update a RADIUS Dynamic Authorization Template by name
patch
Replace a RADIUS Dynamic Authorization Template by name
put
Delete a RADIUS Dynamic Authorization Template by name
delete
RADIUSProxyTarget
Get a list of proxy targets
get
Create a new proxy target
post
Get a proxy target
get
Update some fields of a proxy target
patch
Replace a proxy target
put
Delete a proxy target
delete
Get a proxy target by name
get
Update some fields of a proxy target by name
patch
Replace a proxy target by name
put
Delete a proxy target by name
delete
Role
Get a list of roles
get
Create a new role
post
Get a role
get
Update some fields of a role
patch
Replace a role
put
Delete a role
delete
Get a role by name
get
Update some fields of a role by name
patch
Replace a role by name
put
Delete a role by name
delete
RoleMapping
Get a list of role mappings
get
Create a new role mapping
post
Get a role mapping
get
Update a role mapping
patch
Replace a role mapping
put
Delete a role mapping
delete
Get a role mapping by name
get
Update a role mapping by name
patch
Replace a role mapping by name
put
Delete a role mapping by name
delete
Service
Get a list of Services
get
Create a new Service
post
Get a Service
get
Update some fields of a Service
patch
Replace a Service
put
Delete a Service
delete
Get a Service by name
get
Update some fields of a Service by name
patch
Replace a Service by name
put
Delete a Service by name
delete
Enable a Service
patch
Enable a Service by name
patch
Disable a Service
patch
Disable a Service by name
patch
Reorder Services
patch
TACACSServiceDictionary
Get a list of TACACS+ Service Dictionaries
get
Create a new TACACS+ Service Dictionary
post
Get a TACACS+ Service Dictionary
get
Update a TACACS+ Service Dictionary
patch
Replace a TACACS+ Service Dictionary
put
Delete a TACACS+ Service Dictionary
delete
Get a TACACS+ Service Dictionary by name
get
Update a TACACS+ Service Dictionary by name
patch
Replace a TACACS+ Service Dictionary by name
put
Delete a TACACS+ Service Dictionary by name
delete
Session Control
ActiveSession
Get a list of active sessions
get
Get an active session
get
ActiveSessionDisconnect
Disconnect active session
post
ActiveSessionReauthorize
Get reauthorization profile(s) for an active session
get
Reauthorize active session
post
SessionAction
Performs active session disconnect with a synchronous or asynchronous action & filter by multiple fields.
post
Performs active session disconnect with a synchronous or asynchronous action & filter by mac-address.
post
Performs active session disconnect with a synchronous or asynchronous action & filter by username.
post
Performs active session disconnect with a synchronous or asynchronous action & filter by client-ip-address.
post
Performs active session reauthorize with a synchronous or asynchronous action & filter by multiple fields.
post
Performs active session reauthorize with a synchronous or asynchronous action & filter by mac-address.
post
Performs active session reauthorize with a synchronous or asynchronous action & filter by username.
post
Performs active session reauthorize with a synchronous or asynchronous action & filter by client-ip-address.
post
Returns the current status of a disconnected or reauthorized active session by the action ID.
get
Identities
ApiClient
Get a list of API clients
get
Create a new API client
post
Get an API client
get
Update some fields of an API client
patch
Replace an API client
put
Delete an API client
delete
DenyListedUsers
Get a list of deny listed users
get
Get a deny listed user
get
Delete a deny listed user
delete
Get a deny listed user by Username and MAC Address
get
Delete a deny listed user by Username and MAC Address
delete
Device
Get a list of device accounts
get
Create a new device account
post
Get a device account
get
Update some fields of a device account
patch
Replace a device account
put
Delete a device account
delete
Get a device account by MAC address
get
Update some fields of a device account by MAC address
patch
Replace a device account by MAC address
put
Delete a device account by MAC address
delete
Endpoint
Get a list of endpoints
get
Create a new endpoint
post
Get an endpoint
get
Update some fields of an endpoint
patch
Replace an endpoint
put
Delete an endpoint
delete
Get an endpoint by mac_address
get
Update some fields of an endpoint by mac_address
patch
Replace an endpoint by mac_address
put
Delete an endpoint by mac_address
delete
ExternalAccount
Get a list of external accounts
get
Add an external account
post
Get an external account
get
Update some fields of an external account
patch
Replace an external account
put
Delete an external account
delete
Get an external account by name
get
Update some fields of an external account by name
patch
Replace an external account by name
put
Delete an external account by name
delete
GuestUser
Get a list of guest accounts
get
Create a new guest account
post
Get a guest account
get
Update some fields of a guest account
patch
Replace a guest account
put
Delete a guest account
delete
Get a guest account by username
get
Update some fields of a guest account by username
patch
Replace a guest account by username
put
Delete a guest account by username
delete
LocalUser
Get a list of local users
get
Create a new local user
post
Get a local user
get
Update some fields of a local user
patch
Replace a local user
put
Delete a local user
delete
Get a local user by user_id
get
Update some fields of a local user by user_id
patch
Replace a local user by user_id
put
Delete a local user by user_id
delete
StaticHostList
Get a list of static host lists
get
Create a static host list
post
Get a static host list
get
Update some fields of a static host list
patch
Replace a static host list
put
Delete a static host list
delete
Get a static host list by name
get
Update some fields of a static host list by name
patch
Replace a static host list by name
put
Delete a static host list by name
delete
Certificate Authority
Certificate
Get a list of certificates
get
Get a certificate or certificate signing request
get
Delete a certificate or certificate signing request
delete
CertificateChain
Get a certificate and its trust chain
get
CertificateExport
Export a certificate or certificate signing request
post
CertificateImport
Import a code-signing, trusted, or CA certificate
post
CertificateNew
Create a new certificate signing request and private key
post
CertificateReject
Reject a certificate signing request
post
CertificateRequest
Import a certificate signing request
post
CertificateRevoke
Revoke a certificate
post
CertificateSignRequest
Sign a certificate signing request
post
OnboardDevice
Get a list of devices
get
Get a device
get
Update settings for a device
patch
Delete a device
delete
OnboardUser
Get a list of users
get
Get a user
get
Update settings for a user
patch
Delete a user
delete
Guest Actions
GenerateGuestDigitalPass
Generate digital pass for guest account based on template specified by ID
get
GenerateGuestReceipt
Generate print template for guest account, using specified template ID
get
SendSmsReceipt
Resend guest receipt for guest account, via SMS
post
SendSmtpReceipt
Resend guest receipt for guest account, via SMTP
post
SponsorshipApproval
Accept or reject a guest sponsorship request
post
Guest Configuration
DigitalPassTemplate
Get a list of pass templates
get
Create a new pass template
post
Get a pass template
get
Update some fields of a pass template
patch
Replace a pass template
put
Delete a pass template
delete
GuestAuthenticationConfiguration
Return settings from Configuration -> Authentication
get
Modify settings at Configuration -> Authentication
post
Modify settings at Configuration -> Authentication
patch
GuestManager
Return settings from Configuration -> Guest Manager
get
Modify settings at Configuration -> Guest Manager
post
Modify settings at Configuration -> Guest Manager
patch
PrintTemplate
Get a list of print templates
get
Create a new print template
post
Get a print template
get
Update some fields of a print template
patch
Replace a print template
put
Delete a print template
delete
WebLogin
Get a list of web login pages
get
Create a new web login page
post
Get a web login page
get
Update some fields of a web login page
patch
Replace a web login page
put
Delete a web login page
delete
Get a web login page by page-name
get
Update some fields of a web login page by page-name
patch
Replace a web login page by page-name
put
Delete a web login page by page-name
delete
Local Server Configuration
ADDomain
Get a list of AD Domains
get
GET an AD domain by netbios_name
get
Join AD Domain
put
Leave AD domain
put
Configure AD Password Servers
patch
AccessControl
Get all application access controls
get
Get an application access control by resource name
get
Replace an application access controls by resource name
put
Delete an application access control by resource name
delete
CppmVersion
Get Cppm version
get
ServerConfiguration
Get a list of servers in the cluster
get
Get configuration of a server
get
Update configuration of a server
patch
ServerFips
Get server FIPS mode information
get
ServerSnmp
Get server snmp settings
get
Replace server snmp settings
put
Update some fields of server snmp settings
patch
ServerVersion
Get server version information
get
ServiceParameter
Get service parameter details
get
Update service parameter values
patch
SystemServiceControl
Get all services
get
Get a service by name
get
Start a service by name
patch
Stop a service by name
patch
Integrations
ContextServerAction
Get a list of Context Server Actions
get
Create a new Context Server Action
post
Get a Context Server Action
get
Update some fields of a Context Server Action
patch
Replace a Context Server Action
put
Delete a Context Server Action
delete
Get a Context Server Action by name
get
Update some fields of a Context Server Action by name
patch
Replace a Context Server Action by name
put
Delete a Context Server Action by name
delete
DeviceInsight
Get Device Insight Integration details
get
Update Device Insight Integration values
post
EndpointContextServer
Get a list endpoint context servers
get
Create a new endpoint context server
post
Get an endpoint context server
get
Update some fields of an endpoint context server
patch
Replace an endpoint context server
put
Delete an endpoint context server
delete
Get an endpoint context server by server name
get
Update some fields of an endpoint context server by server name
patch
Replace an endpoint context server by server name
put
Delete an endpoint context server by server name
delete
Trigger polling for an endpoint context server
patch
Trigger polling for an endpoint context server by server name
patch
EventSources
Get a list of event sources
get
Create a new event source
post
Get an event source
get
Update some fields of an event source
patch
Replace an event source
put
Delete an event source
delete
Get an event source by name
get
Update some fields of an event source by name
patch
Replace an event source by name
put
Delete an event source by name
delete
ExtensionInstance
Get a list of installed extensions
get
Install an extension
post
Get details of an installed extension
get
Change the state of an installed extension
patch
Uninstall an extension
delete
ExtensionInstanceConfig
Get the configuration of an installed extension
get
Set the configuration of an installed extension
put
ExtensionInstanceLog
Get the log output from an installed extension
get
ExtensionInstanceReinstall
Reinstall an extension
post
ExtensionInstanceRestart
Restart an installed extension
post
ExtensionInstanceStart
Start an installed extension
post
ExtensionInstanceStop
Stop an installed extension
post
ExtensionInstanceUpgrade
Get information on an extension's available upgrade
get
Upgrade an extension
post
ExtensionStore
Find a extension in the store
get
Get details of an extension in the store
get
IngressEventDictionary
Get a list of Ingress Event Dictionaries
get
Create a new Ingress Event Dictionary
post
Get an Ingress Event Dictionary
get
Update an Ingress Event Dictionary
patch
Replace an Ingress Event Dictionary
put
Delete an Ingress Event Dictionary
delete
Get an Ingress Event Dictionary by format_name
get
Update an Ingress Event Dictionary by format_name
patch
Replace an Ingress Event Dictionary by format_name
put
Delete an Ingress Event Dictionary by format_name
delete
SyslogExportFilter
Get a list of syslog export filter
get
Create a new syslog export filter
post
Get a syslog export filter
get
Update some fields of a syslog export filter
patch
Replace a syslog export filter
put
Delete a syslog export filter
delete
Get a syslog export filter by name
get
Update some fields of a syslog export filter by name
patch
Replace a syslog export filter by name
put
Delete a syslog export filter by name
delete
SyslogTarget
Get a list of syslog target
get
Create a new syslog target
post
Get a syslog target
get
Update some fields of a syslog target
patch
Replace a syslog target
put
Delete a syslog target
delete
Get a syslog target by host_address
get
Update some fields of a syslog target by host_address
patch
Replace a syslog target by host_address
put
Delete a syslog target by host_address
delete
Replace an endpoint
put
https://clearpass-hostname/api/endpoint/
{endpoint_id}
Replace an endpoint
Language
Shell
Node
Ruby
PHP
Python
