Settings APIs

Settings APIs

Settings APIs

Operations
POST
Add new SNMP Trap destination profile
Add new SNMP Trap destination profile
DELETE
Delete An existing SNMP Trap destination profile
Delete an existing SNMP Trap destination profile
GET
Get details Of An existing SNMP destination profile
Get details of an existing SNMP destination profile
GET
List the configured SNMP Trap destination profiles
List the configured SNMP Trap destination profiles
POST
Migrate event subscriptions To other SNMP Trap destination profiles
Migrate event subscriptions to other SNMP Trap destination profiles
POST
Send Test trap To SNMP destination profile
Send Test trap to SNMP destination profile
PUT
Update An existing SNMP destination profile
Update an existing SNMP destination profile
PUT
Update user password
Update user password
POST
Activate Serial Number
Activates a valid license key. This API is not applicable for on-boarding.
POST
Add Backup Config
Configure backup of configuration
POST
Add Ip Tag
Tag IP addresses with tag-id
POST
Add Login Banner
Add new Login Banner in the system
POST
Add Restore Config
Configure restore of configuration and triggers restore operation
POST
Add Search Based Alert Config
Add a new Search Based Alert Configuration
POST
Add Syslog Target
Add syslog server
POST
Add Tag V2
Tag IP addresses with tag-id
POST
Add Vidm User
Add a VMware Identity manager user to Operations for Networks
POST
Add Vidm User Group
Add a VMware Identity Manager user-group to Operations for Networks
POST
Add Web Proxy
Add new Web Proxy in the system
POST
Create Subnet Mapping
Create subnet mapping
POST
Create Subscriber
Add 'Databus' subsciption
POST
Create User Defined Event
Add new User-Defined event
DELETE
Deactivate Serial Number
Deactivates an existing license key
DELETE
Delete Backup Config
Delete existing Backup configuration
DELETE
Delete Login Banner
Delete login banner from the system
DELETE
Delete Restore Config
Delete existing restore configuration
DELETE
Delete Search Based Alert Config
Delete an existing Search Based Alert Configuration.
DELETE
Delete Subnet Mapping
Delete subnet mapping
DELETE
Delete Subscriber
Delete a 'Databus' subscription
DELETE
Delete Syslog Target
Delete syslog server
DELETE
Delete User
Delete an existing user.
DELETE
Delete User Defined Event
Delete an existing User-Defined event
DELETE
Delete User Group
Delete an existing user-group
DELETE
Delete Vidm Configuration
Delete VMware Identity Manager configuration
DELETE
Delete Web Proxy
Delete an existing Web Proxy server
POST
Disable Search Based Alert Config
Disable an existing Search Based Alert Configuration.
POST
Disable User Defined Event
Disable an existing User-Defined event
POST
Disable Vidm
Disable VMware Identity Manager integration
POST
Enable Search Based Alert Config
Enable an existing Search Based Alert Configuration
POST
Enable User Defined Event
Enable an existing User-Defined event
POST
Enable Vidm
Enable VMware Identity Manager integration
GET
Get All Search Based Alert Configs
List all Search Based Alert Configurations.
GET
Get All Subscriber
Get the list of 'Databus' subscriptions
GET
Get All User Defined Events
List the created User Defined Event defintions.
GET
Get All Users
List all the users
GET
Get Backup Config
Get Backup configuration
GET
Get Backup Status Report
Get currently running or last Backup job status
GET
Get Certificate
Get certificate for given url
GET
Get Connected Clients To Web Proxy
Get details of connected clients to Web Proxy Server
GET
Get Infra Nodes Web Proxy
Get details of web proxy config associated with infra nodes
GET
Get Ip Tag
Show IP tag details
GET
Get Ip Tag Ids
Show IP tag IDs
GET
Get Ip Tag V2
Show IP tag details
GET
Get Licenses
Get current licensing and license usage information
GET
Get Login Banner
Get Login banner
GET
Get Restore Config
Get Restore configuration
GET
Get Restore Status Report
Get currently running or last Restore job status
GET
Get SNMP Engine Id
Output SNMP Engine ID for v3 traps
GET
Get Search Based Alert Config
Get details of an existing Search Based Alert Configuration.
GET
Get Subnet Mappings
Get all subnet mappings
GET
Get Subscriber
Retrieve a 'Databus' subscriptions
GET
Get Syslog Mapping
Get syslog mappings.
GET
Get Syslog Status
Get status of the syslog.
GET
Get Syslog Target List
Get syslog server info
GET
Get Tag Ids V2
Show IP tag IDs
GET
Get User
Get details of a user
GET
Get User Defined Event
Get details of an existing User-Defined event.
GET
Get User Group
Get details of a user-group
GET
Get User Groups
List user-groups
GET
Get Users
List the users
GET
Get Vidm Configuration
Get configuration details of VMware Identity Manager
GET
Get Web Proxies
List of configured web proxy servers
GET
Get Web Proxy
Get details of an existing Web Proxy Server
POST
Remove Ip Tag
Remove tag from IP addresses
POST
Remove Tag V2
Remove tag from IP addresses
POST
Save Vidm Configuration
Configure VMware Identity Manager
POST
Send Syslog Test Message
Send test log to syslog server
PUT
Update Backup Config
Update Backup configuration
PUT
Update Login Banner
Edit login banner details in the system
PUT
Update SNMP Engine Id
Update existing SNMP engine ID
PUT
Update Search Based Alert Config
Update an existing Search Based Alert Configuration.
PUT
Update Subnet Mapping
Update subnet mapping
PUT
Update Subscriber
Update 'Databus' subsciption
POST
Update Syslog Mapping
Map and Unmap platform, proxy(or collector) and Ni Alert to a syslog server.
PATCH
Update Syslog Status
Enable/Disable syslog functionality.
PUT
Update Syslog Target
Update syslog server
PUT
Update User Defined Event
Update an existing User-Defined event.
PUT
Update Vidm Configuration
Update VMware Identity Manager configuration
PUT
Update Vidm User Group Role
Update role for user-group mapped through VMware Identity Manager
PUT
Update Vidm User Role
Update role for user mapped through VMware Identity Manager
PUT
Update Web Proxy
Update the existing web proxy server
POST
Validate Connections Via Web Proxy
Validate the connections via web proxy
POST
Validate Serial Number
Validates license key
POST
Validate Web Proxy Migration
Validate the connections when migrating from one web proxy to another