vRealize Operations Cloud API Operations Index

vRealize Operations Cloud API Operations Index

All available vRealize Operations Cloud API Operations

Actions

Get Action Status Using GET

Get action status by the given task Id

Get All Actions Using GET

Look up all Action Definitions in the system

Perform Action Using POST

Perform an Action on one or more resources

Populate Action Using POST

Populate the information needed to run an action

Adapter Kinds

Get Adapter Types Using GET

Get Adapter Types

Get Adapter Type Using GET

Get an Adapter Kind using the specified identifier

Get Resources With Adapter And Resource Kind Using GET

Query for Resources within a particular Adapter Kind and Resource Kind

Get Resources With Adapter Kind Using GET

Query for Resources of a particular Adapter Kind

Get Resource Type Attributes For Adapter Type Using GET

Get the meta-data for attributes (excluding properties) for a specific Resource Kind supported by a specific Adapter Kind

Get Resource Type For Adapter Type Using GET

Get a specific Resource Kind supported by a specific Adapter Kind

Get Resource Type Properties For Adapter Type Using GET

Get the meta-data for properties for a specific Resource Kind supported by a specific Adapter Kind

Get Resource Types For Adapter Type Using GET

Get all the Resource Kinds supported by a specific Adapter Kind

Adapters

Create Adapter Instance Using POST

Create an Adapter Instance

Delete Adapter Instance Using DELETE

Delete an Adapter Instance

Enumerate Adapter Instances Using GET

Get all the adapter instance resources in the system

Get Adapter Instance Using GET

Look up a single adapter instance using an identifier

Get Resources Of Adapter Instance Using GET

Enumerate all resources managed by an adapter instance

Mark Adapter Instance As Being Maintained Using PUT

Mark the adapter instance as being MAINTAINED for the given duration

Patch Adapter Instance Using PATCH

Patch an Adapter Instance

Patch Test Connection Using PATCH

Patch an Adapter Instance Connection

Start Monitoring Resources Of Adapter Instance Using PUT

Start the adapter instance from monitoring its resources

Stop Monitoring Resources Of Adapter Instance Using PUT

Stop the adapter instance from monitoring its resources

Test Connection Using POST

Test Adapter Instance connection

Unmark Adapter Instance As Being Maintained Using DELETE

Mark the adapter instance as being STARTED

Update Adapter Instance Using PUT

Update an Adapter Instance

Alert Plugins

Create Alert Plugin Using POST

Create a new Notification Plugin Instance

Delete Alert Plugin Using DELETE

Delete an existing Notification Plugin Instance

Get Alert Plugin Instance Using GET

Get Notification Plugin specified by plugin id

Get Alert Plugins Of Type Using GET

Get Notification Plugins, optionally filtered for a specific type

Get Alert Plugin Types Using GET

Get the available Notification Plugin Types

Get Alert Plugin Type With Id Using GET

Get the Notification Plugin Type Metadata

Get Rules Of Plugin Using GET

Retrieve all the notification rules of the plugin instance

Modify Alert Plugin State Using PUT

Start or stop an existing Notification Plugin Instance

Patch Alert Plugin Using PATCH

Patch a new Notification Plugin Instance

Test Alert Plugin Using POST

Test existing Notification Plugin Instance connectivity

Update Alert Plugin Using PUT

Update an existing Notification Plugin Instance

Alerts

Add Alert Note Using POST

Add a Note to an Alert

Create Alert Definition Using POST

Create an Alert Definition

Delete Alert Definition Using DELETE

Delete an Alert Definition

Delete Alert Note Using DELETE

Delete a specific Alert Note for a specific Alert

Delete Canceled Alerts Using DELETE

Delete canceled alerts using one or more criteria specified in the Query Spec

Disable Alert Definition In Policies Using PUT

Disable alert definition in policies

Enable Alert Definition In Policies Using PUT

Enable alert definition in policies

Get Alert Contributing Symptoms Using GET

Get the list of triggered symptoms for the requested alerts

Get Alert Definition By Id Using GET

Get the Alert Definition using the identifier specified

Get Alert Definitions Using GET

Get collection of Alert Definitions matching the search criteria specified

Get Alert Notes Using GET

Get all the Alert Notes associated with an Alert

Get Alert Note Using GET

Get the requested Alert Note associated with an Alert

Get Alerts Using GET

Look up Alerts by their identifiers or using the identifiers of the Resources they are associated with

Get Alert Types Using GET

Get all the Alert Types and Subtypes defined in the system.

Get Alert Using GET

Look up an Alert by its identifier

Modify Alerts Using POST

Perform operations on one or more Alerts

Query Alert Groups Using POST

Query for Alert groups using one or more criteria specified in the Query Spec

Query Alert Notes Using POST

Query for Alert Notes based on specified criteria

Query Alert Using POST

Query for Alerts using one or more criteria specified in the Query Spec

Update Alert Definition Using PUT

Update an existing Alert Definition

Applications

Get Agent Operation Status Using GET

Get bootstrap action status by the given taskId

Get Application Resources Using GET

Get all available resources for application monitoring

Get Configuration Details Using GET

Get all the created application monitoring configurations

Get Service Configurations Using GET

Get application service configuration by service name on the resource

Get Service Configuration Template Using GET

Get template of application configuration

Get Service Operation Status Using GET

Get application configuration status by the given taskId

Get Services Configurations Using GET

Get applications service configurations on the resource

Install Agent Using POST

Install agent on resource

Remove Services Configurations Using DELETE

Remove application service configuration from the specified resource

Save Services Configurations Using POST

Save application service configuration on the specified resource

Sign Client Certificate Using POST

Query to sign the Arc Client certificate

Start Agent Using PUT

Start agent on the specified resources

Stop Agent Using PUT

Stop agent on the specified resources

Subscribe Using PUT

Subscribe to Application Monitoring by downloading bootstrap bundle containing all required scripts for bootstraping ARC Agent from Endpoints

Uninstall Agent Using DELETE

Uninstall agent from the resource

Unsubscribe Using PUT

UnSubscribe to Application Monitoring by downloading bootstrap bundle containing all required scripts for Unbootstraping ARC Agent from Endpoints.

Update Services Configurations Using PUT

Update application service configuration on the specified resource

Upgrade Agent Using PUT

Upgrade agent on the specified resources

Audit

Get System Audit Using GET

Get system audit report

Auth

Add Role Privileges Using POST

Add the privileges to a user role

Assign Role Permission To User Group Using PUT

Assign a role permission to a particular user group

Assign Role Permission To User Using PUT

Assign a role permission to a particular user

Create Scope Using POST

Create a new Scope

Create User Group Using POST

Create a new local user group or import SSO/VIDM/LDAP/AD user groups

Create User Role Using POST

Create a user role

Delete Scopes Using DELETE

Delete User Groups Using DELETE

Delete a list of user groups using their identifiers

Delete User Group Using DELETE

Delete a local user group

Delete User Role Using DELETE

Remove role with given role name

Get All Object Scopes Using GET

Get Assigned Role Permissions For Current User Using GET

Get assigned role permissions for an initiator of this API method

Get Assigned Role Permissions For User Group Using GET

Get assigned role permissions for the user group

Get Assigned Role Permissions For User Using GET

Get assigned role permissions for a user

Get Auth Sources Using GET

Get all the available authentication sources in the system

Get Auth Source Types Using GET

Get all the available authentication source types

Get Auth Source Type Using GET

Retrieve information about a particular authentication source type

Get Auth Source Using GET

Retrieve detailed information about a particular authentication source

Get Available Privilege Groups Using GET

Get the available privilege groups

Get Available Privileges Using GET

Get the available privileges

Get Current User Role Privileges Using GET

Get privileges of a role for an initiator of this API method

Get Current User Using GET

Look up for an initiator of this API method

Get Role By Name Using GET

Look up a role with the given name

Get Role Privileges Using GET

Get the privileges for a user role

Get Roles Using GET

Find list of application roles using the role names

Get Scope Using GET

Get Traversal Specs Using GET

Get/Query the list of all traversal specification templates in the system

Get User Groups Using GET

Retrieve a list of local user groups using identifiers or/and names

Get User Group Using GET

Look up a local user group using its identifier

Get Users Using GET

Look up a list of users using the user identifiers or their role names

Get User Using GET

Look up a particular user using its identifier

Modify Scope Using PUT

Modify User Group Using PUT

Modify a local user group

Modify User Using PUT

Modify the details of a particular user

Remove Role Privileges Using DELETE

Remove specified privileges from the user role

Set Role Privileges Using PUT

Set the privileges for a user role

Synchronize User Groups Using PUT

Synchronize user groups

Unassigned Role Permission From User Group Using DELETE

Unassign role permission from a user group

Unassigned Role Permission From User Using DELETE

Unassign role permission from a user

Update User Role Using PUT

Update a user role

Certificate

Delete Certificate Using DELETE

Delete a certificate

Get All Certificates Using GET

Get all certificates

Import Certificate Using POST

Import certificate file

Collector Groups

Add Collector To Collector Group Using PUT

Add a Collector to Collector Group

Create Collector Group Using POST

Create a new Collector Group in the system

Delete Collector Group Using DELETE

Delete a Collector Group from the system using its identifier

Get Collector Groups Using GET

Enumerate all the Collector Groups defined in the system

Get Collector Group Using GET

Get details of a particular Collector Group in the system

Remove Collector From Collector Group Using DELETE

Remove a Collector from a Collector Group

Update Collector Group Using PUT

Update a Collector Group in the system

Collectors

Get Adapters On Collector Using GET

Get all the Collectors registered with the vRealize Operations Manager system

Get Collectors Using GET

Get all the Collectors registered with the vRealize Operations Manager system

Configuration Management

Get details of the specified configuration file.

Content Management

Backup Content Using POST

(Deprecated) Backup content for current user

Download Backup Content Data Using GET

(Deprecated) Download backup for current user

Download Using GET

Download the latest export

Export Content Using POST

Export content for current user

Get Content Progress Using GET

(Deprecated) Get content progress

Get Last Export Operation Using GET

Get the last export operation details

Get Last Import Operation Using GET

Get the last import operation details

Get Restore Content Data Using GET

(Deprecated) Get restore data report for current user

Import Content Using POST

Import content for current user from uploaded file

Restore Content Using POST

(Deprecated) Restore content for current user from uploaded file

Cost Configuration

Get Currency Using GET

Get details of currently selected currency such as display name, code, etc.

Set Currency Using POST

Credentials

Create Credential Using POST

Create a new Credential Instance

Delete Credential Using DELETE

Delete a Credential Instance

Get Adapter Instances Using Credential Using GET

Get all Adapter Instances using the Credential Instance

Get Credential Kinds Using GET

Get all Credential Kinds defined in the system

Get Credentials Using GET

Get all Credential Instances in the system

Get Credential Using GET

Get a Credential Instance

Get Resources Using Credential Using GET

Get the Objects using the Credential Instance

Partial Update Credential Using PATCH

Partial update an existing Credential Instance

Update Credential Using PUT

Update an existing Credential Instance

Deployment

Get Global Setting Metadata Using GET

Get global settings metadata

Get Global Settings Using GET

Get all global setting values

Get Global Setting Value Using GET

Get global setting value for the requested key

Manage DT Using PUT

Manages a specific run of Dynamic Threshold (DT) Computation in a vRealize Operations Manager Cluster

Update Global Setting Value Using PUT

Update global setting value for specified key

Events

Push Event By Adapter Kind Key Using POST

Push a single Event into the system with associating an adapter kind as the event source

Push Events By Adapter Kind Key Using POST

Push one or more Events into the system with associating an adapter kind as the event source

Push Events Using POST

Push one or more Events into the system

Push Event Using POST

Push a single Event into the system

Maintenance Schedules

Create Maintenance Schedules Using POST

Create a maintenance schedule

Delete Maintenance Schedules Using DELETE

Delete maintenance schedules with the given identifiers.

Get Maintenance Schedules Using GET

Query for all maintenance schedules based on schedule id, schedule name and resource id

Update Maintenance Schedules Using PUT

Update an existing maintenance schedules

Notifications

Create Email Template Using POST

(Deprecated) Create a new E-Mail template in the system

Create Notification Plugin Rule Using POST

Create a new Notification Rule for a Notification Plugin Instance

Delete Email Template Using DELETE

(Deprecated) Delete an E-Mail template from the system

Delete Notification Plugin Rules Using DELETE

Delete a specific existing Notification Rule associated with a Notification Plugin Instance

Get All Notification Rules Using GET

Get all the Notification Rules defined in the system

Get Email Conditions Using GET

(Deprecated) Get all Email Template Conditions for a particular Email Template

Get Email Template Using GET

(Deprecated) Look up an E-Mail template by its identifier

Get Notification Rule Using GET

Get the Notification Rule for the specified identifier

Query Email Templates Using GET

(Deprecated) Query for Email templates based on names and identifiers

Set Email Condition Using POST

(Deprecated) Set the E-Mail template condition on an E-Mail template

Unset Email Condition Using DELETE

(Deprecated) Clear all conditions associated with the E-Mail template

Update Email Template Using PUT

(Deprecated) Update an E-Mail template in the system

Update Notification Plugin Rule Using PUT

Update a specific Notification Rule for a Notification Plugin Instance

Policies

Apply Policy Using POST

Apply policy to the given groups

Export Policies Using GET

Export the content of policies into ZIP archive.

Get Policies Using GET

Get all available policies.

Import Policies Using POST

Import policy content from an archive of ZIP format

Pricing Policies

Create Metering Policy Using POST

Create a new pricing policy

Delete Metering Policy Using DELETE

Delete the pricing policy for the specified identifier

Get Pricing Policies Using GET

Get a listing of pricing policies

Get Pricing Policy History Using GET

Get a listing of pricing policy changes

Get Pricing Policy Using GET

Get the pricing policy for the specified identifier

Update Metering Policy Using PUT

Update the specified pricing policy

Recommendations

Create Recommendation Using POST

Create a recommendation

Delete Recommendation Using DELETE

Delete a recommendation

Get Recommendation By Id Using GET

Get the recommendation specified by the given identifier

Get Recommendations Using GET

Get recommendations

Update Recommendation Using PUT

Update an existing recommendation

Reports

Create Report Schedule Using POST

Create a Report Schedule to generate a Report for the specified Report Definition and Resource(s)

Create Report Using POST

Generate (create) a Report using the specified Report Definition and for the specified Resource

Delete Report Using DELETE

Delete a report by its identifier

Delete Schedule Using DELETE

Delete Report Schedule associated with the specific Report Definition and for the specified Schedule identifier

Download Report Using GET

Download the Report given its identifier

Get Report Definitions Using GET

Get the Report Definitions based on the query specification specified

Get Report Definition Using GET

Get a Report Definition

Get Report Schedules Using GET

Get all the Report Schedules associated with a Report Definition

Get Report Schedule Using GET

Get a specific Report Schedule for the specified Report Definition and Schedule identifier

Get Reports Using GET

Get the Reports based on the Report Query Spec provided

Get Report Using GET

Get the detail of a Report given its identifier

Update Report Schedule Using PUT

Update Report Schedule associated with the specific Report Definition and for the specified Schedule identifier

Resource

Add Properties Using POST

Add Properties to a Resource

Add Properties Using Push Adapter Kind Using POST

Add Properties to a Resource along with associating an adapter instance of the specified adapter kind as the source of data

Add Relationship Using POST

Add relationships of given type to the resource with specified resourceId

Add Stats Using POST

Add Stats to a Resource

Add Stats Using Push Adapter Kind Using POST

Add Stats to a Resource along with associating an adapter instance of the specified adapter kind as the source of data

Delete Relationship Using DELETE

Delete (remove) a Resource as RelationshipType of a specific Resource

Delete Resource Using DELETE

Delete a Resource with the given identifier

Get DT Stats Of Resource Using GET

Get Stats and Dynamic Threshold values for one or more StatKeys and for a Collection of Resources

Get Latest Stats Using GET

Get the latest stat for a given Resource and given a set of attributes

Get Relationships Using GET

Get ALL the related resources of a particular Relationship Type for a Resource

Get Relationship Using GET

Get the related resources of a particular Relationship Type for a Resource

Get Resource Properties Using GET

Get all the properties for the specified Resource

Get Resource Using GET

Get the Resource for the specified identifier

Get Stat Keys Using GET

Get all the stat keys for the specified Resource

Get Stats For Resource Using POST

Look up stats of a group of objects with the resource ids

Get Stats Of Resource Using GET

Look up stats of a group of objects with the resource ids

Get Top N Stats Of Resource Using GET

Get the TopN stats for a given Resource and given a set of attributes

Mark Resource As Being Maintained Using PUT

Put the specific Resource in Maintenance

Set Relationship Using PUT

Set (Replace) Resource as RelationshipType of a specific Resource

Start Monitoring Resource Using PUT

Inform one or more or all Adapters to start monitoring this Resource

Stop Monitoring Resource Using PUT

Inform one or more or all Adapters to stop monitoring this Resource

Unmark Resource As Being Maintained Using DELETE

Bring the Resource out of Maintenance manually

Update Geo Location Of Resource Using PUT

Update the geographical location of the Resource

Resources

Add Group Type Using POST

Add a new group type

Add Resources Properties Using Adapter Kind Using POST

Add Properties to Resources Using Adapter Kind

Add Resources Properties Using POST

Add Properties to Resources

Add Stats For Resources Using POST

Add Stats to a Collection of Resources

Add Stats For Resources Using Push Adapter Kind Using POST

Adds Stats to a Collection of Resources along with associating an adapter instance of the specified adapter kind as the source of data

Create Custom Group Using POST

Create a new custom group definition

Create Custom Profile Using POST

Create a new custom profile definition

Create Resource Using Adapter Instance Using POST

Create a new Resource in the system associated with an existing adapter instance

Create Resource Using Adapter Kind Using POST

Create a new Resource in the system associated with the specified adapter kind

Delete Custom Group Using DELETE

Delete a custom group

Delete Custom Profile Using DELETE

Delete a custom profile

Delete Group Type Using DELETE

Delete the group type

Delete Resources Using DELETE

Delete multiple Resources

Get Custom Group Members Using GET

Get members of the group

Get Custom Groups Using GET

Get all custom groups

Get Custom Group Using GET

Get custom group

Get Custom Profiles Using GET

Get all custom profiles

Get Custom Profile Using GET

Get custom profile

Get Group Types Using GET

Get group types

Get Latest Stats Of Resources Using GET

Get Latest stats of one or more Resources using the query spec that is specified

Get Matching Resources Using POST

Gets a listing of resources based on the query spec specified

Get Resource Properties List Using GET

Get all the Properties and their current (latest) values for the specified Resources

Get Resources Relationships Using POST

Get resources that satisfy filtering criteria and are related to specified list of resources with the given relationship type

Get Resources Using GET

Get a listing of resources based on the query spec specified

Get Stat Keys Of Resources Using GET

Get all the available Stat Keys and their details for the specified set of Resources

Get Stats And DT For Resources Using POST

Get Stats and Dynamic Threshold values for one or more StatKeys and for a Collection of Resources

Get Stats For Resources Using POST

Get stats for one or more Resources using the specific query spec

Get Stats Of Resources Using GET

Get stats for one or more Resources using the specific query spec

Get Top N Stats Of Resources Using GET

Get the Top-N stats data for one or more Resources and a set of StatKeys

Mark Resources As Being Maintained Using PUT

Put all the specified Resource in Maintenance

Modify Custom Group Using PUT

Modify an existing custom group definition

Modify Custom Profile Using PUT

Modify an existing custom profile definition

Query Latest Properties Of Resources Using POST

Get current (latest) values of requested properties for the specified resources

Query Latest Stats Of Resources Using POST

Get the last "maxSamples" stats values for specified one or more Resources

Start Monitoring Resources Using PUT

Inform one or more or all Adapters to start monitoring a Collection of Resources

Stop Monitoring Resources Using PUT

Inform one or more or all Adapters to stop monitoring a Collection of Resources

Unmark Resources As Being Maintained Using DELETE

Bring the specified set of Resources out of Maintenance manually

Update Resource Using PUT

Update a Resource in the system

Super Metrics

Create Super Metric Using POST

Create a SuperMetric with the given name, formula and description

Delete Super Metric Using DELETE

Delete a SuperMetric

Get Super Metrics Using GET

Get a collection of SuperMetrics based on search parameters

Get Super Metric Using GET

Get a SuperMetric with the given id

Update Super Metric Using PUT

Update a SuperMetric with the given name, formula and description

Symptoms

Create Symptom Definition Using POST

Create the Symptom Definition

Delete Symptom Definition Using DELETE

Delete a Symptom Definition

Get Symptom Definition By Key Using GET

Get Symptom Definition specified by id

Get Symptom Definitions Using GET

Get Symptom Definitions

Get Symptoms Using GET

Look up all Symptoms in the system

Query Symptoms Using POST

Look up a set of Symptoms using a query object

Update Symptom Definition Using PUT

Update an existing Symptom Definition