VMware vRealize Operations API Operations Index

All available VMware vRealize Operations API Operations.

---

Actions

get	Get Action Status Get action status by the given task Id
get	Get All Actions Look up all Action Definitions in the system
post	Perform Action Perform an Action on one or more resources
post	Populate Action Populate the information needed to run an action

---

Adapter Kinds

get	Get Adapter Type Get an Adapter Kind using the specified identifier
get	Get Adapter Types Get Adapter Types
get	Get Resource Type Attributes For Adapter Type Get the meta-data for attributes (excluding properties) for a specific Resource Kind supported by a specific Adapter Kind
get	Get Resource Type For Adapter Type Get a specific Resource Kind supported by a specific Adapter Kind
get	Get Resource Type Properties For Adapter Type Get the meta-data for properties for a specific Resource Kind supported by a specific Adapter Kind
get	Get Resource Types For Adapter Type Get all the Resource Kinds supported by a specific Adapter Kind
get	Get Resources With Adapter And Resource Kind Query for Resources within a particular Adapter Kind and Resource Kind
get	Get Resources With Adapter Kind Query for Resources of a particular Adapter Kind

---

Adapters

post	Create Adapter Instance Create an Adapter Instance
delete	Delete Adapter Instance Delete an Adapter Instance
get	Enumerate Adapter Instances Get all the adapter instance resources in the system
get	Get Adapter Instance Look up a single adapter instance using an identifier
get	Get Resources Of Adapter Instance Enumerate all resources managed by an adapter instance
put	Mark Adapter Instance As Being Maintained Mark the adapter instance as being <b>MAINTAINED</b> for the given duration
patch	Patch Adapter Instance Patch an Adapter Instance
patch	Patch Test Connection Patch an Adapter Instance Connection
put	Start Monitoring Resources Of Adapter Instance Start the adapter instance from monitoring its resources
put	Stop Monitoring Resources Of Adapter Instance Stop the adapter instance from monitoring its resources
post	Test Connection Test Adapter Instance connection
delete	Unmark Adapter Instance As Being Maintained Mark the adapter instance as being <b>STARTED</b>
put	Update Adapter Instance Update an Adapter Instance

---

Alert Plugins

post	Create Alert Plugin Create a new Notification Plugin Instance
delete	Delete Alert Plugin Delete an existing Notification Plugin Instance
get	Get Alert Plugin Instance Get Notification Plugin specified by plugin id
get	Get Alert Plugin Type With ID Get the Notification Plugin Type Metadata
get	Get Alert Plugin Types Get the available Notification Plugin Types
get	Get Alert Plugins Of Type Get Notification Plugins, optionally filtered for a specific type
get	Get Rules Of Plugin Retrieve all the notification rules of the plugin instance
put	Modify Alert Plugin State Start or stop an existing Notification Plugin Instance
patch	Patch Alert Plugin Patch a new Notification Plugin Instance
post	Test Alert Plugin Test existing Notification Plugin Instance connectivity
put	Update Alert Plugin Update an existing Notification Plugin Instance

---

Alerts

post	Add Alert Note Add a Note to an Alert
post	Create Alert Definition Create an Alert Definition
delete	Delete Alert Definition Delete an Alert Definition
delete	Delete Alert Note Delete a specific Alert Note for a specific Alert
delete	Delete Canceled Alerts Delete canceled alerts using one or more criteria specified in the Query Spec
put	Disable Alert Definition In Policies Disable alert definition in policies
put	Enable Alert Definition In Policies Enable alert definition in policies
get	Get Alert Look up an Alert by its identifier
get	Get Alert Contributing Symptoms Get the list of triggered symptoms for the requested alerts
get	Get Alert Definition By ID Get the Alert Definition using the identifier specified
get	Get Alert Definitions Get collection of Alert Definitions matching the search criteria specified
get	Get Alert Note Get the requested Alert Note associated with an Alert
get	Get Alert Notes Get all the Alert Notes associated with an Alert
get	Get Alert Types Get all the Alert Types and Subtypes defined in the system.
get	Get Alerts Look up Alerts by their identifiers or using the identifiers of the Resources they are associated with
post	Modify Alerts Perform operations on one or more Alerts
post	Query Alert Query for Alerts using one or more criteria specified in the Query Spec
post	Query Alert Groups Query for Alert groups using one or more criteria specified in the Query Spec
post	Query Alert Notes Query for Alert Notes based on specified criteria
put	Update Alert Definition Update an existing Alert Definition

---

Applications

put	Add vCenter To Configuration Add a vCenter to be monitored by the specified application monitoring configuration
get	Get Agent Operation Status Get bootstrap action status by the given taskId
get	Get Application Resources Get all available resources for application monitoring
get	Get Configuration Details Get all the created application monitoring configurations
get	Get Service Configuration Template Get template of application configuration
get	Get Service Configurations Get application service configuration by service name on the resource
get	Get Service Operation Status Get application configuration status by the given taskId
get	Get Services Configurations Get applications service configurations on the resource
post	Install Agent Install agent on resource
delete	Remove Services Configurations Remove application service configuration from the specified resource
put	Remove vCenter From Configuration Remove a vCenter from Application Monitoring Configuration
post	Save Services Configurations Save application service configuration on the specified resource
post	Sign Client Certificate Query to sign the Arc Client certificate
put	Start Agent Start agent on the specified resources
put	Stop Agent Stop agent on the specified resources
put	Subscribe Subscribe to Application Monitoring by downloading bootstrap bundle containing all required scripts for bootstraping ARC Agent from Endpoints
delete	Uninstall Agent Uninstall agent from the resource
put	Unsubscribe UnSubscribe to Application Monitoring by downloading bootstrap bundle containing all required scripts for Unbootstraping ARC Agent from Endpoints.
put	Update Services Configurations Update application service configuration on the specified resource
put	Upgrade Agent Upgrade agent on the specified resources

---

Audit

get	Get System Audit Get system audit report

---

Auth

post	Acquire Token Acquire a token to perform REST API calls
post	Add Auth Source Add a new authentication source in the system
post	Add Role Privileges Add the privileges to a user role
put	Assign Role Permission To User Assign a role permission to a particular user
put	Assign Role Permission To User Group Assign a role permission to a particular user group
put	Assign Traversal Spec To User (Deprecated) Assign a traversal specification to a particular user.
put	Assign Traversal Spec To User Group (Deprecated) Assign a traversal specification to a particular user
put	Change Password Change the password of the active user
post	Create Scope Create a new Scope
post	Create User Create a new user
post	Create User Group Create a new local user group or import SSO/VIDM/LDAP/AD user groups
post	Create User Role Create a user role
delete	Delete Auth Source Delete an authentication source
delete	Delete Scopes Delete scopes
delete	Delete User Delete a user
delete	Delete User Group Delete a local user group
delete	Delete User Groups Delete a list of user groups using their identifiers
delete	Delete User Role Remove role with given role name
delete	Delete Users Delete a collection of users with the given identifiers
get	Get All Object Scopes Get all scopes
get	Get Assigned Role Permissions For Current User Get assigned role permissions for an initiator of this API method
get	Get Assigned Role Permissions For User Get assigned role permissions for a user
get	Get Assigned Role Permissions For User Group Get assigned role permissions for the user group
get	Get Auth Source Retrieve detailed information about a particular authentication source
get	Get Auth Source Type Retrieve information about a particular authentication source type
get	Get Auth Source Types Get all the available authentication source types
get	Get Auth Sources Get all the available authentication sources in the system
get	Get Available Privilege Groups Get the available privilege groups
get	Get Available Privileges Get the available privileges
get	Get Current User Look up for an initiator of this API method
get	Get Current User Role Privileges Get privileges of a role for an initiator of this API method
get	Get Role By Name Look up a role with the given name
get	Get Role Privileges Get the privileges for a user role
get	Get Roles Find list of application roles using the role names
get	Get Scope Get the scope
get	Get Traversal Specs Get/Query the list of all traversal specification templates in the system
get	Get User Look up a particular user using its identifier
get	Get User Group Look up a local user group using its identifier
get	Get User Groups Retrieve a list of local user groups using identifiers or/and names
get	Get Users Look up a list of users using the user identifiers or their role names
post	Import Users Import users from the auth source
put	Modify Scope Modify a Scope
put	Modify User Modify the details of a particular user
put	Modify User Group Modify a local user group
patch	Patch Auth Source With Certificate Details Patch an already added authentication source with the certificate data
patch	Patch Test Auth Source Patch an already tested authentication source with the certificate data
post	Release Token Terminate the current sessionId
delete	Remove Role Privileges Remove specified privileges from the user role
post	Search User Groups For Auth Source Search user-groups for an auth source
post	Search Users For Auth Source Search users for an auth source
put	Set Role Privileges Set the privileges for a user role
put	Synchronize User Groups Synchronize user groups
post	Test Auth Source Test a new or an existing authentication source in the system
delete	Unassigned Role Permission From User Unassign role permission from a user
delete	Unassigned Role Permission From User Group Unassign role permission from a user group
put	Update Auth Source Update an authentication source in the system
put	Update User Role Update a user role

---

Certificate

delete	Delete Certificate Delete a certificate
get	Get All Certificates Get all certificates
post	Import Certificate Import certificate file

---

Collector Groups

put	Add Collector To Collector Group Add a Collector to Collector Group
post	Create Collector Group Create a new Collector Group in the system
delete	Delete Collector Group Delete a Collector Group from the system using its identifier
get	Get Collector Group Get details of a particular Collector Group in the system
get	Get Collector Groups Enumerate all the Collector Groups defined in the system
delete	Remove Collector From Collector Group Remove a Collector from a Collector Group
put	Update Collector Group Update a Collector Group in the system

---

Collectors

get	Get Adapters On Collector Get all the Collectors registered with the vRealize Operations Manager system
get	Get Collectors Get all the Collectors registered with the vRealize Operations Manager system

---

Configuration Management

get	get Configuration Management Get details of the specified configuration file.

---

Content Management

post	Backup Content (Deprecated) Backup content for current user
get	Download Download the latest export
get	Download Backup Content Data (Deprecated) Download backup for current user
post	Export Content Export content for current user
get	Get Content Progress (Deprecated) Get content progress
get	Get Last Export Operation Get the last export operation details
get	Get Last Import Operation Get the last import operation details
get	Get Restore Content Data (Deprecated) Get restore data report for current user
post	Import Content Import content for current user from uploaded file
post	Restore Content (Deprecated) Restore content for current user from uploaded file

---

Cost Configuration

get	Get Currency Get details of currently selected currency such as display name, code, etc.
post	Set Currency Set currency

---

Credentials

post	Create Credential Create a new Credential Instance
delete	Delete Credential Delete a Credential Instance
get	Get Adapter Instances Using Credential Get all Adapter Instances using the Credential Instance
get	Get Credential Get a Credential Instance
get	Get Credential Kinds Get all Credential Kinds defined in the system
get	Get Credentials Get all Credential Instances in the system
get	Get Resources Using Credential Get the Objects using the Credential Instance
patch	Partial Update Credential Partial update an existing Credential Instance
put	Update Credential Update an existing Credential Instance

---

Deployment

post	Add License Key To Product Add one or more License keys to the vRealize Operations Manager instance
delete	Delete License For Product Delete a specific License associated with the vRealize Operations Manager instance
get	Get Global Setting Metadata Get global settings metadata
get	Get Global Setting Value Get global setting value for the requested key
get	Get Global Settings Get all global setting values
get	Get License Groups Get all license groups
get	Get License Keys For Product Get all the License Details associated with the vRealize Operations Manager instance
get	Get Node Status Get the status of the node
get	Get Service Info Get information about a specific Service that is part of the vRealize Operations Manager stack
get	Get Services Info Get the health of all Services
put	Manage Dt Manages a specific run of Dynamic Threshold (DT) Computation in a vRealize Operations Manager Cluster
put	Update Global Setting Value Update global setting value for specified key

---

Events

post	Push Event Push a single Event into the system
post	Push Event By Adapter Kind Key Push a single Event into the system with associating an adapter kind as the event source
post	Push Events Push one or more Events into the system
post	Push Events By Adapter Kind Key Push one or more Events into the system with associating an adapter kind as the event source

---

Log Management

put	Disable Log Forwarding Disable log forwarding
put	Enable Log Forwarding Enable log forwarding
get	Get Log Configurations By Type Get logs configurations of certain type
get	Get Log Forwarding Configuration Get log forwarding configuration
put	Update Log Configurations Change level of the logs
put	Update Log Forwarding Configuration Create a new or update an existing log forwarding configuration

---

Maintenance Schedules

post	Create Maintenance Schedules Create a maintenance schedule
delete	Delete Maintenance Schedules Delete maintenance schedules with the given identifiers.
get	Get Maintenance Schedules Query for all maintenance schedules based on schedule id, schedule name and resource id
put	Update Maintenance Schedules Update an existing maintenance schedules

---

Notifications

post	Create Email Template (Deprecated) Create a new E-Mail template in the system
post	Create Notification Plugin Rule Create a new Notification Rule for a Notification Plugin Instance
delete	Delete Email Template (Deprecated) Delete an E-Mail template from the system
delete	Delete Notification Plugin Rules Delete a specific existing Notification Rule associated with a Notification Plugin Instance
get	Get All Notification Rules Get all the Notification Rules defined in the system
get	Get Email Conditions (Deprecated) Get all Email Template Conditions for a particular Email Template
get	Get Email Template (Deprecated) Look up an E-Mail template by its identifier
get	Get Notification Rule Get the Notification Rule for the specified identifier
get	Query Email Templates (Deprecated) Query for Email templates based on names and identifiers
post	Set Email Condition (Deprecated) Set the E-Mail template condition on an E-Mail template
delete	Unset Email Condition (Deprecated) Clear all conditions associated with the E-Mail template
put	Update Email Template (Deprecated) Update an E-Mail template in the system
put	Update Notification Plugin Rule Update a specific Notification Rule for a Notification Plugin Instance

---

Policies

post	Apply Policy Apply policy to the given groups
get	Export Policies Export the content of policies into ZIP archive.
get	Get Policies Get all available policies.
post	Import Policies Import policy content from an archive of ZIP format

---

Pricing Policies

post	Create Metering Policy Create a new pricing policy
delete	Delete Metering Policy Delete the pricing policy for the specified identifier
get	Get Pricing Policies Get a listing of pricing policies
get	Get Pricing Policy Get the pricing policy for the specified identifier
get	Get Pricing Policy History Get a listing of pricing policy changes
put	Update Metering Policy Update the specified pricing policy

---

Product Licensing

get	Get Product Edition Get edition of product licensing

---

Recommendations

post	Create Recommendation Create a recommendation
delete	Delete Recommendation Delete a recommendation
get	Get Recommendation By ID Get the recommendation specified by the given identifier
get	Get Recommendations Get recommendations
put	Update Recommendation Update an existing recommendation

---

Reports

post	Create Report Generate (create) a Report using the specified Report Definition and for the specified Resource
post	Create Report Schedule Create a Report Schedule to generate a Report for the specified Report Definition and Resource(s)
delete	Delete Report Delete a report by its identifier
delete	Delete Schedule Delete Report Schedule associated with the specific Report Definition and for the specified Schedule identifier
get	Download Report Download the Report given its identifier
get	Get Report Get the detail of a Report given its identifier
get	Get Report Definition Get a Report Definition
get	Get Report Definitions Get the Report Definitions based on the query specification specified
get	Get Report Schedule Get a specific Report Schedule for the specified Report Definition and Schedule identifier
get	Get Report Schedules Get all the Report Schedules associated with a Report Definition
get	Get Reports Get the Reports based on the Report Query Spec provided
put	Update Report Schedule Update Report Schedule associated with the specific Report Definition and for the specified Schedule identifier

---

Resource

post	Add Properties Add Properties to a Resource
post	Add Properties Using Push Adapter Kind Add Properties to a Resource along with associating an adapter instance of the specified adapter kind as the source of data
post	Add Relationship Add relationships of given type to the resource with specified resourceId
post	Add Stats Add Stats to a Resource
post	Add Stats Using Push Adapter Kind Add Stats to a Resource along with associating an adapter instance of the specified adapter kind as the source of data
delete	Delete Relationship Delete (remove) a Resource as RelationshipType of a specific Resource
delete	Delete Resource Delete a Resource with the given identifier
get	Get Dt Stats Of Resource Get Stats and Dynamic Threshold values for one or more StatKeys and for a Collection of Resources
get	Get Latest Stats Get the latest stat for a given Resource and given a set of attributes
get	Get Relationship Get the related resources of a particular Relationship Type for a Resource
get	Get Relationships Get ALL the related resources of a particular Relationship Type for a Resource
get	Get Resource Get the Resource for the specified identifier
get	Get Resource Properties Get all the properties for the specified Resource
get	Get Stat Keys Get all the stat keys for the specified Resource
post	Get Stats For Resource Look up stats of a group of objects with the resource ids
get	Get Stats Of Resource Look up stats of a group of objects with the resource ids
get	Get Top N Stats Of Resource Get the TopN stats for a given Resource and given a set of attributes
put	Mark Resource As Being Maintained Put the specific Resource in Maintenance
put	Set Relationship Set (Replace) Resource as RelationshipType of a specific Resource
put	Start Monitoring Resource Inform one or more or all Adapters to start monitoring this Resource
put	Stop Monitoring Resource Inform one or more or all Adapters to stop monitoring this Resource
delete	Unmark Resource As Being Maintained Bring the Resource out of Maintenance manually
put	Update Geo Location Of Resource Update the geographical location of the Resource

---

Resources

post	Add Group Type Add a new group type
post	Add Resources Properties Add Properties to Resources
post	Add Resources Properties Using Adapter Kind Add Properties to Resources Using Adapter Kind
post	Add Stats For Resources Add Stats to a Collection of Resources
post	Add Stats For Resources Using Push Adapter Kind Adds Stats to a Collection of Resources along with associating an adapter instance of the specified adapter kind as the source of data
post	Create Custom Group Create a new custom group definition
post	Create Custom Profile Create a new custom profile definition
post	Create Resource Using Adapter Instance Create a new Resource in the system associated with an existing adapter instance
post	Create Resource Using Adapter Kind Create a new Resource in the system associated with the specified adapter kind
delete	Delete Custom Group Delete a custom group
delete	Delete Custom Profile Delete a custom profile
delete	Delete Group Type Delete the group type
delete	Delete Resources Delete multiple Resources
get	Get Custom Group Get custom group
get	Get Custom Group Members Get members of the group
get	Get Custom Groups Get all custom groups
get	Get Custom Profile Get custom profile
get	Get Custom Profiles Get all custom profiles
get	Get Group Types Get group types
get	Get Latest Stats Of Resources Get Latest stats of one or more Resources using the query spec that is specified
post	Get Matching Resources Gets a listing of resources based on the query spec specified
get	Get Resource Properties List Get all the Properties and their current (latest) values for the specified Resources
get	Get Resources Get a listing of resources based on the query spec specified
post	Get Resources Relationships Get resources that satisfy filtering criteria and are related to specified list of resources with the given relationship type
get	Get Stat Keys Of Resources Get all the available Stat Keys and their details for the specified set of Resources
post	Get Stats And Dt For Resources Get Stats and Dynamic Threshold values for one or more StatKeys and for a Collection of Resources
post	Get Stats For Resources Get stats for one or more Resources using the specific query spec
get	Get Stats Of Resources Get stats for one or more Resources using the specific query spec
get	Get Top N Stats Of Resources Get the Top-N stats data for one or more Resources and a set of StatKeys
put	Mark Resources As Being Maintained Put all the specified Resource in Maintenance
put	Modify Custom Group Modify an existing custom group definition
put	Modify Custom Profile Modify an existing custom profile definition
post	Query Latest Properties Of Resources Get current (latest) values of requested properties for the specified resources
post	Query Latest Stats Of Resources Get the last "maxSamples" stats values for specified one or more Resources
put	Start Monitoring Resources Inform one or more or all Adapters to start monitoring a Collection of Resources
put	Stop Monitoring Resources Inform one or more or all Adapters to stop monitoring a Collection of Resources
delete	Unmark Resources As Being Maintained Bring the specified set of Resources out of Maintenance manually
put	Update Resource Update a Resource in the system

---

Solutions

post	Add License Keys To Solution Add a license key to the solution
delete	Delete License Key Delete the Id of the license for the specified solution id from the system
get	Get Adapter Kinds For Solution Get Adapter Kind details for the specified solution id
get	Get License Keys For Solution Get all the licenses that are currently available for a solution
get	Get Solution Get solution data for the specified id
get	Get Solutions Get all solutions installed in the product

---

Super Metrics

post	Create Super Metric Create a SuperMetric with the given name, formula and description
delete	Delete Super Metric Delete a SuperMetric
get	Get Super Metric Get a SuperMetric with the given id
get	Get Super Metrics Get a collection of SuperMetrics based on search parameters
put	Update Super Metric Update a SuperMetric with the given name, formula and description

---

Symptoms

post	Create Symptom Definition Create the Symptom Definition
delete	Delete Symptom Definition Delete a Symptom Definition
get	Get Symptom Definition By Key Get Symptom Definition specified by id
get	Get Symptom Definitions Get Symptom Definitions
get	Get Symptoms Look up all Symptoms in the system
post	Query Symptoms Look up a set of Symptoms using a query object
put	Update Symptom Definition Update an existing Symptom Definition

---

Tasks

get	Get Task Status Look up a task status with the given identifier
get	Get Tasks Status Look up a list of task objects' statuses

---

Versions Info

get	Get Current Version Of Server Get the current version of the service
get	Get Supported Application Versions Get all supported versions by the service