Officially supported API(s) are listed below.

Note regarding UTF-8 characters: UTF-8 character sets (e.g. Chinese) need to explicity set the Content-Type request header when making API calls:

Content-Type: application/xml;charset=utf-8

GET /api/actiondefinitions

Look up all Action Definitions in the system.
Performing a GET /api/actiondefinitions call will query for all available Actions defined in the system. This includes the data needed to populate an Action in the system.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:action-definitions xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:pageInfo totalCount="2">
        <ops:page>0</ops:page>
        <ops:pageSize>10</ops:pageSize>
    </ops:pageInfo>
    <ops:links>
        <ops:link name="current" rel="SELF" href="/suite-api/api/actiondefinitions?page=0&amp;pageSize=10">
            <ops:description>self</ops:description>
        </ops:link>
        <ops:link name="first" rel="RELATED" href="/suite-api/api/actiondefinitions?page=0&amp;pageSize=10">
            <ops:description>first</ops:description>
        </ops:link>
        <ops:link name="last" rel="RELATED" href="/suite-api/api/actiondefinitions?page=0&amp;pageSize=10">
            <ops:description>last</ops:description>
        </ops:link>
    </ops:links>
    <ops:action-definition canRecommend="true" type="UPDATE" id="PythonRemediationVcenterAdapter-Power Off VM">
        <ops:displayName>Power Off VM</ops:displayName>
        <ops:actionAdapterKindKey>PythonRemediationVcenterAdapter</ops:actionAdapterKindKey>
        <ops:contextAdapterKindKey>VMWARE</ops:contextAdapterKindKey>
        <ops:contextResourceKindKey>VirtualMachine</ops:contextResourceKindKey>
        <ops:contextIds>PowerOffVM</ops:contextIds>
    </ops:action-definition>
    <ops:action-definition canRecommend="true" type="UPDATE" id="PythonRemediationVcenterAdapter-Power On VM">
        <ops:displayName>Power On VM</ops:displayName>
        <ops:actionAdapterKindKey>PythonRemediationVcenterAdapter</ops:actionAdapterKindKey>
        <ops:contextAdapterKindKey>VMWARE</ops:contextAdapterKindKey>
        <ops:contextResourceKindKey>VirtualMachine</ops:contextResourceKindKey>
        <ops:contextIds>PowerOnVM</ops:contextIds>
    </ops:action-definition>
</ops:action-definitions>
{
  "pageInfo" : {
    "totalCount" : 2,
    "page" : 0,
    "pageSize" : 10,
    "sortBy" : null,
    "sortOrder" : null
  },
  "links" : [ {
    "href" : "/suite-api/api/actiondefinitions?page=0&pageSize=10",
    "rel" : "SELF",
    "name" : "current",
    "description" : "self"
  }, {
    "href" : "/suite-api/api/actiondefinitions?page=0&pageSize=10",
    "rel" : "RELATED",
    "name" : "first",
    "description" : "first"
  }, {
    "href" : "/suite-api/api/actiondefinitions?page=0&pageSize=10",
    "rel" : "RELATED",
    "name" : "last",
    "description" : "last"
  } ],
  "actionDefinitions" : [ {
    "id" : "PythonRemediationVcenterAdapter-Power Off VM",
    "displayName" : "Power Off VM",
    "type" : "UPDATE",
    "actionAdapterKindKey" : "PythonRemediationVcenterAdapter",
    "contextAdapterKindKey" : "VMWARE",
    "contextResourceKindKey" : "VirtualMachine",
    "contextIds" : [ "PowerOffVM" ],
    "extension" : null,
    "links" : null,
    "canRecommend" : true
  }, {
    "id" : "PythonRemediationVcenterAdapter-Power On VM",
    "displayName" : "Power On VM",
    "type" : "UPDATE",
    "actionAdapterKindKey" : "PythonRemediationVcenterAdapter",
    "contextAdapterKindKey" : "VMWARE",
    "contextResourceKindKey" : "VirtualMachine",
    "contextIds" : [ "PowerOnVM" ],
    "extension" : null,
    "links" : null,
    "canRecommend" : true
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:action-definitions/>

POST /api/actions/{id}

Perform an Action on one or more resources

Performing a POST /api/actions/{id} will attempt to trigger the specified action in the id. It is considered a best practice to use the actionExecution field from the POST /api/action/{id}/query that has been previously executed to populate the body of the request. Please note that additional values may be required in order to make the populateAction response body valid.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:action-execution contextId="PowerOffVM" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:contextResourceId>c5af764a-d4d5-4258-829c-8acb0604e4c7 c5af764a-d4d5-4258-829c-8acb0604e4c7</ops:contextResourceId>
    <ops:parameterGroup resourceId="7e780215-da07-4da1-9167-cd6892dcfdd8">
        <ops:parameterValue name="mOR">vm-99</ops:parameterValue>
    </ops:parameterGroup>
    <ops:parameterGroup resourceId="c5af764a-d4d5-4258-829c-8acb0604e4c7">
        <ops:parameterValue name="mOR">vm-100</ops:parameterValue>
    </ops:parameterGroup>
</ops:action-execution>
{
  "contextId" : "PowerOffVM",
  "contextResourceId" : [ "c5af764a-d4d5-4258-829c-8acb0604e4c7", "c5af764a-d4d5-4258-829c-8acb0604e4c7" ],
  "parameterGroup" : [ {
    "resourceId" : "7e780215-da07-4da1-9167-cd6892dcfdd8",
    "parameterValue" : [ {
      "name" : "mOR",
      "value" : "vm-99"
    } ]
  }, {
    "resourceId" : "c5af764a-d4d5-4258-829c-8acb0604e4c7",
    "parameterValue" : [ {
      "name" : "mOR",
      "value" : "vm-100"
    } ]
  } ]
}
Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:str-values xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:values>68bd30aa-cc3b-4776-81f6-344f95325ab9</ops:values>
</ops:str-values>
{
  "values" : [ "01e25c6c-2693-47df-b7f9-359a28fbad59" ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The id for the action to be executed template xs:string yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:str-values/>

POST /api/actions/{id}/query

Populate the information needed to run an action

Performing a POST /api/actions/{id}/query would yield a response object that includes the resources that the action would apply to with the populated values of each action context field for the resource. The response contains information about the parameters to the action's method. It also includes a sample input that would be used for running the action with POST /api/actions/{id} if you chose to run it on all applicable resources and not change the default input values.

The json result inside actionExecution can be used directly as input perform the action. In the xml result, the xml element ops:action-execution will need namespace binding added to it in order to use it in the request. xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" Sample Request Body:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:action-population xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:contextResourceId>c5af764a-d4d5-4258-829c-8acb0604e4c7</ops:contextResourceId>
</ops:action-population>
{
  "contextResourceId" : [ "c5af764a-d4d5-4258-829c-8acb0604e4c7" ]
}
Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:populated-action id="PythonRemediationVcenterAdapter-Power Off VM" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:actionContext id="Power Off VM">
        <ops:fields>
            <ops:field hidden="false" displayOrder="0" input="false" component="textfield" name="VM Name" id="Name">
                <ops:expressionResults>
                    <ops:expressionResult>MyVMName</ops:expressionResult>
                </ops:expressionResults>
            </ops:field>
        </ops:fields>
    </ops:actionContext>
    <ops:methodParameters>
        <ops:methodParameter isList="false" isRequired="true" dataType="String" id="mOR"/>
    </ops:methodParameters>
    <ops:action-execution contextId="PowerOffVM">
        <ops:contextResourceId>c5af764a-d4d5-4258-829c-8acb0604e4c7 c5af764a-d4d5-4258-829c-8acb0604e4c7</ops:contextResourceId>
        <ops:parameterGroup resourceId="7e780215-da07-4da1-9167-cd6892dcfdd8">
            <ops:parameterValue name="mOR">vm-99</ops:parameterValue>
        </ops:parameterGroup>
        <ops:parameterGroup resourceId="c5af764a-d4d5-4258-829c-8acb0604e4c7">
            <ops:parameterValue name="mOR">vm-100</ops:parameterValue>
        </ops:parameterGroup>
    </ops:action-execution>
</ops:populated-action>
{
  "id" : "PythonRemediationVcenterAdapter-Power Off VM",
  "actionContext" : {
    "id" : "Power Off VM",
    "field" : [ {
      "id" : "Name",
      "name" : "VM Name",
      "component" : "textfield",
      "input" : false,
      "displayOrder" : 0,
      "parameterKey" : null,
      "hidden" : false,
      "expressionResult" : [ "MyVMName" ]
    } ]
  },
  "resourceId" : null,
  "methodParameter" : [ {
    "id" : "mOR",
    "dataType" : "String",
    "isRequired" : true,
    "isList" : false
  } ],
  "action-execution" : {
    "contextId" : "PowerOffVM",
    "contextResourceId" : [ "c5af764a-d4d5-4258-829c-8acb0604e4c7", "c5af764a-d4d5-4258-829c-8acb0604e4c7" ],
    "parameterGroup" : [ {
      "resourceId" : "7e780215-da07-4da1-9167-cd6892dcfdd8",
      "parameterValue" : [ {
        "name" : "mOR",
        "value" : "vm-99"
      } ]
    }, {
      "resourceId" : "c5af764a-d4d5-4258-829c-8acb0604e4c7",
      "parameterValue" : [ {
        "name" : "mOR",
        "value" : "vm-100"
      } ]
    } ]
  },
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The id for the action to be executed template xs:string yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:populated-action/>

GET /api/adapterkinds/{id}

Get an Adapter Kind using the specified identifier.

Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:adapter-kind key="VMWARE" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>vCenter Adapter</ops:name>
    <ops:description>VMWare vCenter Adapter</ops:description>
    <ops:adapterKindType>GENERAL</ops:adapterKindType>
    <ops:describeVersion>100</ops:describeVersion>
</ops:adapter-kind>
{
  "key" : "VMWARE",
  "name" : "vCenter Adapter",
  "description" : "VMWare vCenter Adapter",
  "adapterKindType" : "GENERAL",
  "describeVersion" : 100,
  "identifiers" : [ ],
  "resourceKinds" : [ ],
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
retrieveResourceKindInfos Optional param that specifies whether need to report resource-kind-keys. query xs:boolean no no true
id Adapter Kind Identifier template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:adapter-kind/>

GET /api/adapterkinds

Gets Adapter Types identified by the specified identifiers or all if 'null' is specified

Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:adapter-kinds xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:adapter-kind key="VMWARE">
        <ops:name>vCenter Adapter</ops:name>
        <ops:description>VMWare vCenter Adapter</ops:description>
        <ops:adapterKindType>GENERAL</ops:adapterKindType>
        <ops:describeVersion>100</ops:describeVersion>
    </ops:adapter-kind>
    <ops:adapter-kind key="vCenter Operations Adapter">
        <ops:name>vCenter Operations Adapter</ops:name>
        <ops:description>vC Ops Adapter for self-monitoring</ops:description>
        <ops:adapterKindType>GENERAL</ops:adapterKindType>
        <ops:describeVersion>101</ops:describeVersion>
    </ops:adapter-kind>
    <ops:adapter-kind key="HttpPost">
        <ops:name>HTTP Post</ops:name>
        <ops:description></ops:description>
        <ops:adapterKindType>OPENAPI</ops:adapterKindType>
    </ops:adapter-kind>
</ops:adapter-kinds>
{
  "adapter-kind" : [ {
    "key" : "VMWARE",
    "name" : "vCenter Adapter",
    "description" : "VMWare vCenter Adapter",
    "adapterKindType" : "GENERAL",
    "describeVersion" : 100,
    "identifiers" : [ ],
    "resourceKinds" : [ ],
    "links" : null
  }, {
    "key" : "vCenter Operations Adapter",
    "name" : "vCenter Operations Adapter",
    "description" : "vC Ops Adapter for self-monitoring",
    "adapterKindType" : "GENERAL",
    "describeVersion" : 101,
    "identifiers" : [ ],
    "resourceKinds" : [ ],
    "links" : null
  }, {
    "key" : "HttpPost",
    "name" : "HTTP Post",
    "description" : "",
    "adapterKindType" : "OPENAPI",
    "describeVersion" : null,
    "identifiers" : [ ],
    "resourceKinds" : [ ],
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
adapterKindKey Optional list of identifiers to filter by. query xs:string no yes
retrieveResourceKindInfos Optional param that specifies whether need to report resource-kind-keys. query xs:boolean no no true

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:adapter-kinds/>

GET /api/adapterkinds/{adapterKindKey}/resourcekinds/{resourceKindKey}/resources

Query for Resources within a particular Adapter Kind and Resource Kind.
Optionally filter these resources based on resource name. The resource name (specified as a query parameter) will be used for doing a partial match.
However, if the resource identifiers and their values are specified, name is ignored and the API enforces all the mandatory (both uniquely identifying and required) identifiers are specified. This allows for looking up a single resource using a ResourceKey and allows the translation between a ResourceKey and a Resource UUID

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
identifiers Resource Identifiers where the Key represents the Resource Identifier Key and the Value represents the Resource Identifier value query :map no no
name Resource Name (partial match) query xs:string no no
resourceKindKey Resource Kind Identifier template xs:string yes no
adapterKindKey Adapter Kind Identifier template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:resources/>

GET /api/adapterkinds/{adapterKindKey}/resources

Query for Resources of a particular Adapter Kind.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
adapterKindKey Adapter Kind Identifier template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:resources/>

GET /api/adapterkinds/{adapterKindKey}/resourcekinds/{resourceKindKey}/statkeys

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


Examples for information about a specific Resource Kind within a particular Adapter in XML and JSON format:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resource-kind-attributes xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resource-kind-attribute>
        <ops:key>key-1</ops:key>
        <ops:description>Some description</ops:description>
        <ops:defaultMonitored>false</ops:defaultMonitored>
        <ops:rollupType>LATEST</ops:rollupType>
        <ops:instanceType>INSTANCED</ops:instanceType>
        <ops:unit>units</ops:unit>
        <ops:dataType>INTEGER</ops:dataType>
        <ops:monitoring>true</ops:monitoring>
        <ops:dtSubType>common</ops:dtSubType>
        <ops:property>true</ops:property>
    </ops:resource-kind-attribute>
    <ops:resource-kind-attribute>
        <ops:key>key-2</ops:key>
        <ops:description>Some description</ops:description>
        <ops:defaultMonitored>false</ops:defaultMonitored>
        <ops:rollupType>LATEST</ops:rollupType>
        <ops:instanceType>INSTANCED</ops:instanceType>
        <ops:unit>units</ops:unit>
        <ops:dataType>INTEGER</ops:dataType>
        <ops:monitoring>true</ops:monitoring>
        <ops:dtSubType>common</ops:dtSubType>
        <ops:property>true</ops:property>
    </ops:resource-kind-attribute>
</ops:resource-kind-attributes>
{
  "resourceTypeAttributes" : [ {
    "key" : "key-1",
    "name" : null,
    "localization" : null,
    "description" : "Some description",
    "defaultMonitored" : false,
    "rollupType" : "LATEST",
    "instanceType" : "INSTANCED",
    "unit" : "units",
    "unitLocalization" : null,
    "dataType" : "INTEGER",
    "dataType2" : null,
    "monitoring" : true,
    "dtSubType" : "common",
    "property" : true
  }, {
    "key" : "key-2",
    "name" : null,
    "localization" : null,
    "description" : "Some description",
    "defaultMonitored" : false,
    "rollupType" : "LATEST",
    "instanceType" : "INSTANCED",
    "unit" : "units",
    "unitLocalization" : null,
    "dataType" : "INTEGER",
    "dataType2" : null,
    "monitoring" : true,
    "dtSubType" : "common",
    "property" : true
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
attributeKeys Optional list of attribute-keys to filter by. query xs:string no yes
statOnly Optional param that indicate whether need to return only stats or stats and properties together. query xs:boolean no no true
retrieveAllLocalizations Optional param that specifies whether need to report names in all localizations. query xs:boolean no no false
resourceKindKey Resource Kind Identifier template xs:string yes no
adapterKindKey Adapter Kind Identifier template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:resource-kind-attributes/>

GET /api/adapterkinds/{adapterKindKey}/resourcekinds/{resourceKindKey}

Get a specific Resource Kind supported by a specific Adapter Kind.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resource-kind key="VirtualMachine" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>VirtualMachine</ops:name>
    <ops:adapterKind>VMWARE</ops:adapterKind>
</ops:resource-kind>
{
  "key" : "VirtualMachine",
  "name" : "VirtualMachine",
  "localization" : null,
  "adapterKind" : "VMWARE",
  "adapterKindName" : null,
  "resourceKindType" : null,
  "resourceKindSubType" : null,
  "resourceIdentifierType" : null,
  "extension" : null,
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
resourceKindKey Resource Kind Identifier template xs:string yes no
adapterKindKey Adapter Kind Identifier template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:resource-kind/>

GET /api/adapterkinds/{adapterKindKey}/resourcekinds/{resourceKindKey}/properties

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


Examples for information about a specific Resource Kind within a particular Adapter in XML and JSON format:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resource-kind-attributes xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resource-kind-attribute>
        <ops:key>key-1</ops:key>
        <ops:description>Some description</ops:description>
        <ops:defaultMonitored>false</ops:defaultMonitored>
        <ops:rollupType>LATEST</ops:rollupType>
        <ops:instanceType>INSTANCED</ops:instanceType>
        <ops:unit>units</ops:unit>
        <ops:dataType>INTEGER</ops:dataType>
        <ops:monitoring>true</ops:monitoring>
        <ops:dtSubType>common</ops:dtSubType>
        <ops:property>true</ops:property>
    </ops:resource-kind-attribute>
    <ops:resource-kind-attribute>
        <ops:key>key-2</ops:key>
        <ops:description>Some description</ops:description>
        <ops:defaultMonitored>false</ops:defaultMonitored>
        <ops:rollupType>LATEST</ops:rollupType>
        <ops:instanceType>INSTANCED</ops:instanceType>
        <ops:unit>units</ops:unit>
        <ops:dataType>INTEGER</ops:dataType>
        <ops:monitoring>true</ops:monitoring>
        <ops:dtSubType>common</ops:dtSubType>
        <ops:property>true</ops:property>
    </ops:resource-kind-attribute>
</ops:resource-kind-attributes>
{
  "resourceTypeAttributes" : [ {
    "key" : "key-1",
    "name" : null,
    "localization" : null,
    "description" : "Some description",
    "defaultMonitored" : false,
    "rollupType" : "LATEST",
    "instanceType" : "INSTANCED",
    "unit" : "units",
    "unitLocalization" : null,
    "dataType" : "INTEGER",
    "dataType2" : null,
    "monitoring" : true,
    "dtSubType" : "common",
    "property" : true
  }, {
    "key" : "key-2",
    "name" : null,
    "localization" : null,
    "description" : "Some description",
    "defaultMonitored" : false,
    "rollupType" : "LATEST",
    "instanceType" : "INSTANCED",
    "unit" : "units",
    "unitLocalization" : null,
    "dataType" : "INTEGER",
    "dataType2" : null,
    "monitoring" : true,
    "dtSubType" : "common",
    "property" : true
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
properties Optional list of property names to filter by. query xs:string no yes
retrieveAllLocalizations Optional param that specifies whether need to report names in all localizations. query xs:boolean no no false
resourceKindKey Resource Kind Identifier template xs:string yes no
adapterKindKey Adapter Kind Identifier template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:resource-kind-attributes/>

GET /api/adapterkinds/{key}/resourcekinds

Get all the Resource Kinds supported by a specific Adapter Kind.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resource-kinds xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:adapterKind>VMWARE</ops:adapterKind>
    <ops:resource-kind key="Datacenter">
        <ops:name>Datacenter</ops:name>
        <ops:adapterKind>VMWARE</ops:adapterKind>
    </ops:resource-kind>
    <ops:resource-kind key="ClusterComputeResource">
        <ops:name>ClusterComputeResource</ops:name>
        <ops:adapterKind>VMWARE</ops:adapterKind>
    </ops:resource-kind>
    <ops:resource-kind key="HostSystem">
        <ops:name>HostSystem</ops:name>
        <ops:adapterKind>VMWARE</ops:adapterKind>
    </ops:resource-kind>
    <ops:resource-kind key="ResourcePool">
        <ops:name>ResourcePool</ops:name>
        <ops:adapterKind>VMWARE</ops:adapterKind>
    </ops:resource-kind>
    <ops:resource-kind key="VirtualMachine">
        <ops:name>VirtualMachine</ops:name>
        <ops:adapterKind>VMWARE</ops:adapterKind>
    </ops:resource-kind>
    <ops:resource-kind key="Datastore">
        <ops:name>Datastore</ops:name>
        <ops:adapterKind>VMWARE</ops:adapterKind>
    </ops:resource-kind>
    <ops:resource-kind key="VmwareDistributedVirtualSwitch">
        <ops:name>VmwareDistributedVirtualSwitch</ops:name>
        <ops:adapterKind>VMWARE</ops:adapterKind>
    </ops:resource-kind>
    <ops:resource-kind key="StoragePod">
        <ops:name>StoragePod</ops:name>
        <ops:adapterKind>VMWARE</ops:adapterKind>
    </ops:resource-kind>
    <ops:resource-kind key="Folder">
        <ops:name>Folder</ops:name>
        <ops:adapterKind>VMWARE</ops:adapterKind>
    </ops:resource-kind>
    <ops:resource-kind key="VMwareAdapter Instance">
        <ops:name>VMwareAdapter Instance</ops:name>
        <ops:adapterKind>VMWARE</ops:adapterKind>
    </ops:resource-kind>
</ops:resource-kinds>
{
  "pageInfo" : null,
  "links" : null,
  "adapterKind" : "VMWARE",
  "resource-kind" : [ {
    "key" : "Datacenter",
    "name" : "Datacenter",
    "localization" : null,
    "adapterKind" : "VMWARE",
    "adapterKindName" : null,
    "resourceKindType" : null,
    "resourceKindSubType" : null,
    "resourceIdentifierType" : null,
    "extension" : null,
    "links" : null
  }, {
    "key" : "ClusterComputeResource",
    "name" : "ClusterComputeResource",
    "localization" : null,
    "adapterKind" : "VMWARE",
    "adapterKindName" : null,
    "resourceKindType" : null,
    "resourceKindSubType" : null,
    "resourceIdentifierType" : null,
    "extension" : null,
    "links" : null
  }, {
    "key" : "HostSystem",
    "name" : "HostSystem",
    "localization" : null,
    "adapterKind" : "VMWARE",
    "adapterKindName" : null,
    "resourceKindType" : null,
    "resourceKindSubType" : null,
    "resourceIdentifierType" : null,
    "extension" : null,
    "links" : null
  }, {
    "key" : "ResourcePool",
    "name" : "ResourcePool",
    "localization" : null,
    "adapterKind" : "VMWARE",
    "adapterKindName" : null,
    "resourceKindType" : null,
    "resourceKindSubType" : null,
    "resourceIdentifierType" : null,
    "extension" : null,
    "links" : null
  }, {
    "key" : "VirtualMachine",
    "name" : "VirtualMachine",
    "localization" : null,
    "adapterKind" : "VMWARE",
    "adapterKindName" : null,
    "resourceKindType" : null,
    "resourceKindSubType" : null,
    "resourceIdentifierType" : null,
    "extension" : null,
    "links" : null
  }, {
    "key" : "Datastore",
    "name" : "Datastore",
    "localization" : null,
    "adapterKind" : "VMWARE",
    "adapterKindName" : null,
    "resourceKindType" : null,
    "resourceKindSubType" : null,
    "resourceIdentifierType" : null,
    "extension" : null,
    "links" : null
  }, {
    "key" : "VmwareDistributedVirtualSwitch",
    "name" : "VmwareDistributedVirtualSwitch",
    "localization" : null,
    "adapterKind" : "VMWARE",
    "adapterKindName" : null,
    "resourceKindType" : null,
    "resourceKindSubType" : null,
    "resourceIdentifierType" : null,
    "extension" : null,
    "links" : null
  }, {
    "key" : "StoragePod",
    "name" : "StoragePod",
    "localization" : null,
    "adapterKind" : "VMWARE",
    "adapterKindName" : null,
    "resourceKindType" : null,
    "resourceKindSubType" : null,
    "resourceIdentifierType" : null,
    "extension" : null,
    "links" : null
  }, {
    "key" : "Folder",
    "name" : "Folder",
    "localization" : null,
    "adapterKind" : "VMWARE",
    "adapterKindName" : null,
    "resourceKindType" : null,
    "resourceKindSubType" : null,
    "resourceIdentifierType" : null,
    "extension" : null,
    "links" : null
  }, {
    "key" : "VMwareAdapter Instance",
    "name" : "VMwareAdapter Instance",
    "localization" : null,
    "adapterKind" : "VMWARE",
    "adapterKindName" : null,
    "resourceKindType" : null,
    "resourceKindSubType" : null,
    "resourceIdentifierType" : null,
    "extension" : null,
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
retrieveAllLocalizations Optional param that specifies whether need to report names in all localizations. query xs:boolean no no false
key identifier of the adapter kind of type 'string' template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:resource-kinds/>

POST /api/adapters

Creates an Adapter Instance.

Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:create-adapter-instance xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>VC Adapter Instance</ops:name>
    <ops:description>A vCenter Adapter Instance</ops:description>
    <ops:collectorId>1</ops:collectorId>
    <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
    <ops:resourceIdentifiers>
        <ops:resourceIdentifier name="AUTODISCOVERY">true</ops:resourceIdentifier>
        <ops:resourceIdentifier name="PROCESSCHANGEEVENTS">true</ops:resourceIdentifier>
        <ops:resourceIdentifier name="VCURL">VC_IP_Address</ops:resourceIdentifier>
    </ops:resourceIdentifiers>
    <ops:credential>
        <ops:name>New Principal Credential</ops:name>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:credentialKindKey>PRINCIPALCREDENTIAL</ops:credentialKindKey>
        <ops:fields>
            <ops:field name="USER">user_name</ops:field>
            <ops:field name="PASSWORD">passwd</ops:field>
        </ops:fields>
    </ops:credential>
</ops:create-adapter-instance>
{
  "name" : "VC Adapter Instance",
  "description" : "A vCenter Adapter Instance",
  "collectorId" : "1",
  "collectorGroupId" : null,
  "adapterKindKey" : "VMWARE",
  "resourceIdentifier" : [ {
    "name" : "AUTODISCOVERY",
    "value" : "true"
  }, {
    "name" : "PROCESSCHANGEEVENTS",
    "value" : "true"
  }, {
    "name" : "VCURL",
    "value" : "VC_IP_Address"
  } ],
  "credential" : {
    "id" : null,
    "name" : "New Principal Credential",
    "adapterKindKey" : "VMWARE",
    "credentialKindKey" : "PRINCIPALCREDENTIAL",
    "field" : [ {
      "name" : "USER",
      "value" : "user_name"
    }, {
      "name" : "PASSWORD",
      "value" : "passwd"
    } ]
  },
  "monitoringInterval" : null
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:adapter-instance id="ddeddb17-ae00-497e-af24-dad1c232ccde" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceKey>
        <ops:name>VC Adapter for 10.20.88.111</ops:name>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:resourceKindKey>Adapter</ops:resourceKindKey>
        <ops:resourceIdentifiers/>
    </ops:resourceKey>
    <ops:description>A vCenter Adapter Instance</ops:description>
    <ops:collectorId>1</ops:collectorId>
    <ops:credentialInstanceId>3d820c16-e4ff-4319-99b9-933d8eb2b384</ops:credentialInstanceId>
</ops:adapter-instance>
{
  "resourceKey" : {
    "name" : "VC Adapter for 10.20.88.111",
    "adapterKindKey" : "VMWARE",
    "resourceKindKey" : "Adapter",
    "resourceIdentifier" : [ ],
    "links" : null,
    "extension" : null
  },
  "description" : "A vCenter Adapter Instance",
  "collectorId" : 1,
  "collectorGroupId" : null,
  "credentialInstanceId" : "fb8883bd-d6a4-4770-bbbf-d0466bef9af4",
  "monitoringInterval" : null,
  "numberOfMetricsCollected" : null,
  "numberOfResourcesCollected" : null,
  "lastHeartbeat" : null,
  "lastCollected" : null,
  "messageFromAdapterInstance" : null,
  "adapter-certificate" : null,
  "links" : null,
  "id" : "3aa925e3-d0f0-4669-ab8e-a3e6fcc0f5b7"
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
extractIdentifierDefaults Indicates whether need to return default value or null in a result for identifiers that have no/null value in request body query xs:boolean no no false

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201, 400
Descriptions
400 - If create 'adapter instance' failed. Typically the service will return extra information as to why the creation failed.
Response type
<ns3:adapter-instance/>

DELETE /api/adapters/{id}

Deletes an Adapter instance given an identifier.
NOTE: Deleting an adapter instance is not synchronous.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
deleteResources If set to true, resources discovered by this adapter instance would be deleted as well. query xs:boolean yes no false
id identifier of the adapter instance template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204, 404
Descriptions
404 - If no adapter instance is found with the specified identifier.
Response type
No content returned by this method.

GET /api/adapters

Returns all the adapter instance resources in the system.

Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:adapter-instances xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:adapter-instance id="9de07f42-e547-4aba-b8fe-6f02a7ac969e">
        <ops:resourceKey>
            <ops:name>VC Adapter for 10.20.88.111</ops:name>
            <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
            <ops:resourceKindKey>Adapter</ops:resourceKindKey>
            <ops:resourceIdentifiers/>
        </ops:resourceKey>
        <ops:description>A vCenter Adapter Instance</ops:description>
        <ops:collectorId>1</ops:collectorId>
        <ops:credentialInstanceId>021e1f2a-8df5-4e3a-9da5-77ecd041a8eb</ops:credentialInstanceId>
    </ops:adapter-instance>
</ops:adapter-instances>
{
  "adapterInstancesInfoDto" : [ {
    "resourceKey" : {
      "name" : "VC Adapter for 10.20.88.111",
      "adapterKindKey" : "VMWARE",
      "resourceKindKey" : "Adapter",
      "resourceIdentifier" : [ ],
      "links" : null,
      "extension" : null
    },
    "description" : "A vCenter Adapter Instance",
    "collectorId" : 1,
    "collectorGroupId" : null,
    "credentialInstanceId" : "e96c7ebf-2cf8-482e-b711-4c09d64a1d66",
    "monitoringInterval" : null,
    "numberOfMetricsCollected" : null,
    "numberOfResourcesCollected" : null,
    "lastHeartbeat" : null,
    "lastCollected" : null,
    "messageFromAdapterInstance" : null,
    "adapter-certificate" : null,
    "links" : null,
    "id" : "3caa7d21-9846-41ad-bb59-2686f6e4e354"
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
adapterKindKey Adapter Kind key, if specified the API returns only instances of this Adapter Kind query xs:string no no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:adapter-instances/>

GET /api/adapters/{adapterId}

Look up a single adapter instance using an identifier.
Returns a specific adapter instance identified by the specified UUID.

Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:adapter-instance id="5ba421b9-1519-4429-93c7-d79469efd7b5" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceKey>
        <ops:name>VC Adapter for 10.20.88.111</ops:name>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:resourceKindKey>Adapter</ops:resourceKindKey>
        <ops:resourceIdentifiers/>
    </ops:resourceKey>
    <ops:description>A vCenter Adapter Instance</ops:description>
    <ops:collectorId>1</ops:collectorId>
    <ops:credentialInstanceId>00b68ee0-8962-4a95-a187-fcdd166c9c76</ops:credentialInstanceId>
</ops:adapter-instance>
{
  "resourceKey" : {
    "name" : "VC Adapter for 10.20.88.111",
    "adapterKindKey" : "VMWARE",
    "resourceKindKey" : "Adapter",
    "resourceIdentifier" : [ ],
    "links" : null,
    "extension" : null
  },
  "description" : "A vCenter Adapter Instance",
  "collectorId" : 1,
  "collectorGroupId" : null,
  "credentialInstanceId" : "e84f1308-148f-4ca1-b1b0-b038111a0700",
  "monitoringInterval" : null,
  "numberOfMetricsCollected" : null,
  "numberOfResourcesCollected" : null,
  "lastHeartbeat" : null,
  "lastCollected" : null,
  "messageFromAdapterInstance" : null,
  "adapter-certificate" : null,
  "links" : null,
  "id" : "52f20933-64de-416d-8769-98553355b958"
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
adapterId identifier of the adapter in UUID format. template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404
Descriptions
404 - If no adapter instance is found with the specified identifier.
Response type
<ns3:adapter-instance/>

GET /api/adapters/{adapterId}/resources

Enumerates all resources managed by an adapter instance.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
adapterId identifier of the adapter in UUID format. template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404
Descriptions
404 - If no adapter instance is found with the specified identifier.
Response type
<ns3:resources/>

PUT /api/adapters/{adapterId}/maintained

Marks the adapter instance as being 'maintained' for the given duration.
After the duration expires, the adapter instance state is automatically set to 'STARTED'

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
duration duration in minutes for which this resource will not be monitored query xs:int yes no
adapterId identifier of the adapter in UUID format. template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404
Descriptions
404 - If no adapter instance is found with the specified identifier.
Response type
No content returned by this method.

PATCH /api/adapters

Patches an Adapter Instance.
This is typically used to indicate vRealize operations manager that the certificates presented by the (data source for which the adapter instance) was created are indeed valid certificates.
Typically the response of the POST /api/adapters API in its entirety needs to be sent as request body when making this PATCH /api/adapters API invocation.

Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:adapter-instance id="76f44c8b-2350-4f53-8f51-624b36fccb86" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceKey>
        <ops:name>Adapter for VC@https://ip/sdk</ops:name>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:resourceKindKey>VMwareAdapter Instance</ops:resourceKindKey>
        <ops:resourceIdentifiers>
            <ops:resourceIdentifier xsi:type="ops:name-value" name="AUTODISCOVERY">true</ops:resourceIdentifier>
            <ops:resourceIdentifier xsi:type="ops:name-value" name="PROCESSCHANGEEVENTS">true</ops:resourceIdentifier>
            <ops:resourceIdentifier xsi:type="ops:name-value" name="VCURL">https://ip/sdk</ops:resourceIdentifier>
        </ops:resourceIdentifiers>
    </ops:resourceKey>
    <ops:description>update certificates for adapter instance...</ops:description>
    <ops:adapter-certificates>
        <ops:adapter-certificate>
            <ops:thumbprint>e81f6867-c751-4774-b19d-4d4d389791f0</ops:thumbprint>
        </ops:adapter-certificate>
    </ops:adapter-certificates>
</ops:adapter-instance>
{
  "resourceKey" : {
    "name" : "Adapter for VC@https://ip/sdk",
    "adapterKindKey" : "VMWARE",
    "resourceKindKey" : "VMwareAdapter Instance",
    "resourceIdentifier" : [ {
      "name" : "AUTODISCOVERY",
      "value" : "true"
    }, {
      "name" : "PROCESSCHANGEEVENTS",
      "value" : "true"
    }, {
      "name" : "VCURL",
      "value" : "https://ip/sdk"
    } ],
    "links" : null,
    "extension" : null
  },
  "description" : "update certificates for adapter instance...",
  "collectorId" : null,
  "collectorGroupId" : null,
  "credentialInstanceId" : null,
  "monitoringInterval" : null,
  "numberOfMetricsCollected" : null,
  "numberOfResourcesCollected" : null,
  "lastHeartbeat" : null,
  "lastCollected" : null,
  "messageFromAdapterInstance" : null,
  "adapter-certificate" : [ {
    "thumbprint" : "bf59f601-a628-4909-9b03-ff0f690d3661",
    "certificateDetails" : null
  } ],
  "links" : null,
  "id" : "b5d141f3-f46f-45db-b221-e90e0f760d2b"
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:adapter-instance id="f62c2178-d168-46b9-b0da-c1e573d6b530" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceKey>
        <ops:name>VC Adapter for 10.20.88.111</ops:name>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:resourceKindKey>Adapter</ops:resourceKindKey>
        <ops:resourceIdentifiers/>
    </ops:resourceKey>
    <ops:description>A vCenter Adapter Instance</ops:description>
    <ops:collectorId>1</ops:collectorId>
    <ops:credentialInstanceId>38876907-f7be-4739-8cf9-1d22092f706d</ops:credentialInstanceId>
</ops:adapter-instance>
{
  "resourceKey" : {
    "name" : "VC Adapter for 10.20.88.111",
    "adapterKindKey" : "VMWARE",
    "resourceKindKey" : "Adapter",
    "resourceIdentifier" : [ ],
    "links" : null,
    "extension" : null
  },
  "description" : "A vCenter Adapter Instance",
  "collectorId" : 1,
  "collectorGroupId" : null,
  "credentialInstanceId" : "773e4a0c-c21e-40d8-8799-bf266d172755",
  "monitoringInterval" : null,
  "numberOfMetricsCollected" : null,
  "numberOfResourcesCollected" : null,
  "lastHeartbeat" : null,
  "lastCollected" : null,
  "messageFromAdapterInstance" : null,
  "adapter-certificate" : null,
  "links" : null,
  "id" : "21cc756b-f535-4e7b-98df-a3b4a0d2a1ca"
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200, 400
Descriptions
400 - If patch 'adapter instance' failed. Typically the service will return extra information as to why update failed.
Response type
<ns3:adapter-instance/>

PUT /api/adapters/{adapterId}/monitoringstate/start

Starts the adapter instance from monitoring its resources.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
adapterId identifier of the adapter in UUID format. template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

PUT /api/adapters/{adapterId}/monitoringstate/stop

Stops the adapter instance from monitoring its resources.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
adapterId identifier of the adapter in UUID format. template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

DELETE /api/adapters/{adapterId}/maintained

Marks the adapter instance as being 'started'.
Removes the adapter instance from being in an maintenance window. The adapter instance will be notified to start collection process immediately.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
adapterId identifier of the adapter in UUID format. template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204, 404
Descriptions
404 - If no adapter instance is found with the specified identifier.
Response type
No content returned by this method.

PUT /api/adapters

Updates an Adapter Instance.

Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:adapter-instance id="64df94a4-a702-4e0e-aeb4-b71acd01c283" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceKey>
        <ops:name>Adapter for VC@https://ip/sdk</ops:name>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:resourceKindKey>VMwareAdapter Instance</ops:resourceKindKey>
        <ops:resourceIdentifiers>
            <ops:resourceIdentifier xsi:type="ops:name-value" name="AUTODISCOVERY">true</ops:resourceIdentifier>
            <ops:resourceIdentifier xsi:type="ops:name-value" name="PROCESSCHANGEEVENTS">true</ops:resourceIdentifier>
            <ops:resourceIdentifier xsi:type="ops:name-value" name="VCURL">https://ip/sdk</ops:resourceIdentifier>
        </ops:resourceIdentifiers>
    </ops:resourceKey>
    <ops:description>This is an updated description for the adapter instance...</ops:description>
</ops:adapter-instance>
{
  "resourceKey" : {
    "name" : "Adapter for VC@https://ip/sdk",
    "adapterKindKey" : "VMWARE",
    "resourceKindKey" : "VMwareAdapter Instance",
    "resourceIdentifier" : [ {
      "name" : "AUTODISCOVERY",
      "value" : "true"
    }, {
      "name" : "PROCESSCHANGEEVENTS",
      "value" : "true"
    }, {
      "name" : "VCURL",
      "value" : "https://ip/sdk"
    } ],
    "links" : null,
    "extension" : null
  },
  "description" : "This is an updated description for the adapter instance...",
  "collectorId" : null,
  "collectorGroupId" : null,
  "credentialInstanceId" : null,
  "monitoringInterval" : null,
  "numberOfMetricsCollected" : null,
  "numberOfResourcesCollected" : null,
  "lastHeartbeat" : null,
  "lastCollected" : null,
  "messageFromAdapterInstance" : null,
  "adapter-certificate" : null,
  "links" : null,
  "id" : "5c5c9e4e-ca71-4463-988c-2597971c7ba0"
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:adapter-instance id="007068f3-6086-4d26-886d-a473da2568a0" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceKey>
        <ops:name>VC Adapter for 10.20.88.111</ops:name>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:resourceKindKey>Adapter</ops:resourceKindKey>
        <ops:resourceIdentifiers/>
    </ops:resourceKey>
    <ops:description>A vCenter Adapter Instance</ops:description>
    <ops:collectorId>1</ops:collectorId>
    <ops:credentialInstanceId>903e7f24-c253-4b6d-96e6-03885a888d71</ops:credentialInstanceId>
</ops:adapter-instance>
{
  "resourceKey" : {
    "name" : "VC Adapter for 10.20.88.111",
    "adapterKindKey" : "VMWARE",
    "resourceKindKey" : "Adapter",
    "resourceIdentifier" : [ ],
    "links" : null,
    "extension" : null
  },
  "description" : "A vCenter Adapter Instance",
  "collectorId" : 1,
  "collectorGroupId" : null,
  "credentialInstanceId" : "8a3aa481-2a2e-4e3f-99ec-17ab6c39ed79",
  "monitoringInterval" : null,
  "numberOfMetricsCollected" : null,
  "numberOfResourcesCollected" : null,
  "lastHeartbeat" : null,
  "lastCollected" : null,
  "messageFromAdapterInstance" : null,
  "adapter-certificate" : null,
  "links" : null,
  "id" : "e1e4a2b9-aa36-4ac0-ac4f-e996e43e1fe3"
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200, 400
Descriptions
400 - If update 'adapter instance' failed. Typically the service will return extra information as to why update failed.
Response type
<ns3:adapter-instance/>

POST /api/alertdefinitions

Creates an Alert Definition.
Once the Alert Definition is created, an unique identifier will be generated by the system for the Alert Definition and returned as part of the API response.

Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alert-definition xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>High CPU/Memory Usage</ops:name>
    <ops:description>CPU or MEM usage too High</ops:description>
    <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
    <ops:resourceKindKey>HostSystem</ops:resourceKindKey>
    <ops:waitCycles>3</ops:waitCycles>
    <ops:cancelCycles>2</ops:cancelCycles>
    <ops:type>0</ops:type>
    <ops:subType>0</ops:subType>
    <ops:states>
        <ops:state severity="WARNING">
            <ops:composite-symptom-set>
                <ops:operator>AND</ops:operator>
                <ops:symptom-sets>
                    <ops:symptom-set>
                        <ops:symptomDefinitionIds>
                            <ops:symptomDefinitionId>Symptom5</ops:symptomDefinitionId>
                            <ops:symptomDefinitionId>!Symptom6</ops:symptomDefinitionId>
                        </ops:symptomDefinitionIds>
                        <ops:relation>SELF</ops:relation>
                        <ops:aggregation>ALL</ops:aggregation>
                        <ops:symptomSetOperator>AND</ops:symptomSetOperator>
                    </ops:symptom-set>
                    <ops:symptom-set>
                        <ops:symptomDefinitionIds>
                            <ops:symptomDefinitionId>Symptom100</ops:symptomDefinitionId>
                            <ops:symptomDefinitionId>Symptom101</ops:symptomDefinitionId>
                        </ops:symptomDefinitionIds>
                        <ops:relation>SELF</ops:relation>
                        <ops:aggregation>ALL</ops:aggregation>
                        <ops:symptomSetOperator>OR</ops:symptomSetOperator>
                    </ops:symptom-set>
                </ops:symptom-sets>
            </ops:composite-symptom-set>
        </ops:state>
    </ops:states>
</ops:alert-definition>
{
  "id" : null,
  "name" : "High CPU/Memory Usage",
  "description" : "CPU or MEM usage too High",
  "adapterKindKey" : "VMWARE",
  "resourceKindKey" : "HostSystem",
  "waitCycles" : 3,
  "cancelCycles" : 2,
  "type" : 0,
  "subType" : 0,
  "state" : [ {
    "severity" : "WARNING",
    "base-symptom-set" : {
      "type" : "SYMPTOM_SET_COMPOSITE",
      "symptomSets" : [ {
        "type" : "SYMPTOM_SET",
        "symptomDefinitionId" : [ "Symptom5", "!Symptom6" ],
        "relation" : "SELF",
        "aggregation" : "ALL",
        "symptomSetOperator" : "AND",
        "populationOperator" : null,
        "traversalSpecType" : null,
        "value" : null
      }, {
        "type" : "SYMPTOM_SET",
        "symptomDefinitionId" : [ "Symptom100", "Symptom101" ],
        "relation" : "SELF",
        "aggregation" : "ALL",
        "symptomSetOperator" : "OR",
        "populationOperator" : null,
        "traversalSpecType" : null,
        "value" : null
      } ],
      "operator" : "AND"
    },
    "impact" : null,
    "recommendationPriorityMap" : null
  } ]
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alert-definition xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>f080147f-c60d-4f08-8801-b602e2931b6f</ops:id>
    <ops:name>High CPU/Memory Usage</ops:name>
    <ops:description>CPU or MEM usage too High</ops:description>
    <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
    <ops:resourceKindKey>HostSystem</ops:resourceKindKey>
    <ops:waitCycles>3</ops:waitCycles>
    <ops:cancelCycles>2</ops:cancelCycles>
    <ops:type>0</ops:type>
    <ops:subType>0</ops:subType>
    <ops:states>
        <ops:state severity="WARNING">
            <ops:composite-symptom-set>
                <ops:operator>AND</ops:operator>
                <ops:symptom-sets>
                    <ops:symptom-set>
                        <ops:symptomDefinitionIds>
                            <ops:symptomDefinitionId>Symptom5</ops:symptomDefinitionId>
                            <ops:symptomDefinitionId>!Symptom6</ops:symptomDefinitionId>
                        </ops:symptomDefinitionIds>
                        <ops:relation>SELF</ops:relation>
                        <ops:aggregation>ALL</ops:aggregation>
                        <ops:symptomSetOperator>AND</ops:symptomSetOperator>
                    </ops:symptom-set>
                    <ops:symptom-set>
                        <ops:symptomDefinitionIds>
                            <ops:symptomDefinitionId>Symptom100</ops:symptomDefinitionId>
                            <ops:symptomDefinitionId>Symptom101</ops:symptomDefinitionId>
                        </ops:symptomDefinitionIds>
                        <ops:relation>SELF</ops:relation>
                        <ops:aggregation>ALL</ops:aggregation>
                        <ops:symptomSetOperator>OR</ops:symptomSetOperator>
                    </ops:symptom-set>
                </ops:symptom-sets>
            </ops:composite-symptom-set>
        </ops:state>
    </ops:states>
</ops:alert-definition>
{
  "id" : "f080147f-c60d-4f08-8801-b602e2931b6f",
  "name" : "High CPU/Memory Usage",
  "description" : "CPU or MEM usage too High",
  "adapterKindKey" : "VMWARE",
  "resourceKindKey" : "HostSystem",
  "waitCycles" : 3,
  "cancelCycles" : 2,
  "type" : 0,
  "subType" : 0,
  "state" : [ {
    "severity" : "WARNING",
    "base-symptom-set" : {
      "type" : "SYMPTOM_SET_COMPOSITE",
      "symptomSets" : [ {
        "type" : "SYMPTOM_SET",
        "symptomDefinitionId" : [ "Symptom5", "!Symptom6" ],
        "relation" : "SELF",
        "aggregation" : "ALL",
        "symptomSetOperator" : "AND",
        "populationOperator" : null,
        "traversalSpecType" : null,
        "value" : null
      }, {
        "type" : "SYMPTOM_SET",
        "symptomDefinitionId" : [ "Symptom100", "Symptom101" ],
        "relation" : "SELF",
        "aggregation" : "ALL",
        "symptomSetOperator" : "OR",
        "populationOperator" : null,
        "traversalSpecType" : null,
        "value" : null
      } ],
      "operator" : "AND"
    },
    "impact" : null,
    "recommendationPriorityMap" : null
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
<ns3:alert-definition/>

DELETE /api/alertdefinitions/{id}

Deletes an Alert Definition.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The id of the Alert Definition template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204, 404
Descriptions
404 - if there is no Alert Definition found for the identifier specified
Response type
No content returned by this method.

GET /api/alertdefinitions/{id}

Gets Alert Definition using the identifier specified.

Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alert-definition xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>AlertDefinition-147ff080-8801-c60d-4f08-931b6fb602e2</ops:id>
    <ops:name>MyAlertDefinition</ops:name>
    <ops:description>An Alert Definition associated with ESX host</ops:description>
    <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
    <ops:resourceKindKey>HostSystem</ops:resourceKindKey>
    <ops:waitCycles>3</ops:waitCycles>
    <ops:cancelCycles>2</ops:cancelCycles>
    <ops:type>0</ops:type>
    <ops:subType>0</ops:subType>
    <ops:states>
        <ops:state severity="CRITICAL">
            <ops:symptom-set>
                <ops:symptomDefinitionIds>
                    <ops:symptomDefinitionId>SymptomDefinition-5</ops:symptomDefinitionId>
                </ops:symptomDefinitionIds>
                <ops:relation>SELF</ops:relation>
                <ops:aggregation>ALL</ops:aggregation>
            </ops:symptom-set>
            <ops:impact>
                <ops:impactType>BADGE</ops:impactType>
                <ops:detail>Health</ops:detail>
            </ops:impact>
        </ops:state>
    </ops:states>
</ops:alert-definition>
{
  "id" : "AlertDefinition-147ff080-8801-c60d-4f08-931b6fb602e2",
  "name" : "MyAlertDefinition",
  "description" : "An Alert Definition associated with ESX host",
  "adapterKindKey" : "VMWARE",
  "resourceKindKey" : "HostSystem",
  "waitCycles" : 3,
  "cancelCycles" : 2,
  "type" : 0,
  "subType" : 0,
  "state" : [ {
    "severity" : "CRITICAL",
    "base-symptom-set" : {
      "type" : "SYMPTOM_SET",
      "symptomDefinitionId" : [ "SymptomDefinition-5" ],
      "relation" : "SELF",
      "aggregation" : "ALL",
      "symptomSetOperator" : null,
      "populationOperator" : null,
      "traversalSpecType" : null,
      "value" : null
    },
    "impact" : {
      "impactType" : "BADGE",
      "detail" : "Health"
    },
    "recommendationPriorityMap" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The id of the Alert Definition template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404
Descriptions
404 - if there is no Alert Definition found for the identifier specified
Response type
<ns3:alert-definition/>

GET /api/alertdefinitions

Returns a collection of Alert Definitions matching the search criteria specified.

Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alert-definitions xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:alert-definition>
        <ops:id>f080147f-c60d-4f08-8801-b602e2931b6f</ops:id>
        <ops:name>High CPU/Memory Usage</ops:name>
        <ops:description>CPU or MEM usage too High</ops:description>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:resourceKindKey>HostSystem</ops:resourceKindKey>
        <ops:waitCycles>3</ops:waitCycles>
        <ops:cancelCycles>2</ops:cancelCycles>
        <ops:type>0</ops:type>
        <ops:subType>0</ops:subType>
        <ops:states>
            <ops:state severity="WARNING">
                <ops:composite-symptom-set>
                    <ops:operator>AND</ops:operator>
                    <ops:symptom-sets>
                        <ops:symptom-set>
                            <ops:symptomDefinitionIds>
                                <ops:symptomDefinitionId>Symptom5</ops:symptomDefinitionId>
                                <ops:symptomDefinitionId>!Symptom6</ops:symptomDefinitionId>
                            </ops:symptomDefinitionIds>
                            <ops:relation>SELF</ops:relation>
                            <ops:aggregation>ALL</ops:aggregation>
                            <ops:symptomSetOperator>AND</ops:symptomSetOperator>
                        </ops:symptom-set>
                        <ops:symptom-set>
                            <ops:symptomDefinitionIds>
                                <ops:symptomDefinitionId>Symptom100</ops:symptomDefinitionId>
                                <ops:symptomDefinitionId>Symptom101</ops:symptomDefinitionId>
                            </ops:symptomDefinitionIds>
                            <ops:relation>SELF</ops:relation>
                            <ops:aggregation>ALL</ops:aggregation>
                            <ops:symptomSetOperator>OR</ops:symptomSetOperator>
                        </ops:symptom-set>
                    </ops:symptom-sets>
                </ops:composite-symptom-set>
            </ops:state>
        </ops:states>
    </ops:alert-definition>
    <ops:alert-definition>
        <ops:id>AlertDefinition-147ff080-8801-c60d-4f08-931b6fb602e2</ops:id>
        <ops:name>MyAlertDefinition</ops:name>
        <ops:description>An Alert Definition associated with ESX host</ops:description>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:resourceKindKey>HostSystem</ops:resourceKindKey>
        <ops:waitCycles>3</ops:waitCycles>
        <ops:cancelCycles>2</ops:cancelCycles>
        <ops:type>0</ops:type>
        <ops:subType>0</ops:subType>
        <ops:states>
            <ops:state severity="CRITICAL">
                <ops:symptom-set>
                    <ops:symptomDefinitionIds>
                        <ops:symptomDefinitionId>SymptomDefinition-5</ops:symptomDefinitionId>
                    </ops:symptomDefinitionIds>
                    <ops:relation>SELF</ops:relation>
                    <ops:aggregation>ALL</ops:aggregation>
                </ops:symptom-set>
                <ops:impact>
                    <ops:impactType>BADGE</ops:impactType>
                    <ops:detail>Health</ops:detail>
                </ops:impact>
            </ops:state>
        </ops:states>
    </ops:alert-definition>
</ops:alert-definitions>
{
  "pageInfo" : null,
  "links" : null,
  "alertDefinitions" : [ {
    "id" : "f080147f-c60d-4f08-8801-b602e2931b6f",
    "name" : "High CPU/Memory Usage",
    "description" : "CPU or MEM usage too High",
    "adapterKindKey" : "VMWARE",
    "resourceKindKey" : "HostSystem",
    "waitCycles" : 3,
    "cancelCycles" : 2,
    "type" : 0,
    "subType" : 0,
    "state" : [ {
      "severity" : "WARNING",
      "base-symptom-set" : {
        "type" : "SYMPTOM_SET_COMPOSITE",
        "symptomSets" : [ {
          "type" : "SYMPTOM_SET",
          "symptomDefinitionId" : [ "Symptom5", "!Symptom6" ],
          "relation" : "SELF",
          "aggregation" : "ALL",
          "symptomSetOperator" : "AND",
          "populationOperator" : null,
          "traversalSpecType" : null,
          "value" : null
        }, {
          "type" : "SYMPTOM_SET",
          "symptomDefinitionId" : [ "Symptom100", "Symptom101" ],
          "relation" : "SELF",
          "aggregation" : "ALL",
          "symptomSetOperator" : "OR",
          "populationOperator" : null,
          "traversalSpecType" : null,
          "value" : null
        } ],
        "operator" : "AND"
      },
      "impact" : null,
      "recommendationPriorityMap" : null
    } ]
  }, {
    "id" : "AlertDefinition-147ff080-8801-c60d-4f08-931b6fb602e2",
    "name" : "MyAlertDefinition",
    "description" : "An Alert Definition associated with ESX host",
    "adapterKindKey" : "VMWARE",
    "resourceKindKey" : "HostSystem",
    "waitCycles" : 3,
    "cancelCycles" : 2,
    "type" : 0,
    "subType" : 0,
    "state" : [ {
      "severity" : "CRITICAL",
      "base-symptom-set" : {
        "type" : "SYMPTOM_SET",
        "symptomDefinitionId" : [ "SymptomDefinition-5" ],
        "relation" : "SELF",
        "aggregation" : "ALL",
        "symptomSetOperator" : null,
        "populationOperator" : null,
        "traversalSpecType" : null,
        "value" : null
      },
      "impact" : {
        "impactType" : "BADGE",
        "detail" : "Health"
      },
      "recommendationPriorityMap" : null
    } ]
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
adapterKind Adapter Kind key of the Alert Definitions to search for query xs:string no no
id The identifier(s) of the Alert Definitions to search for.
Do not specify adapterKind or resourceKind if searching by the identifier		 query xs:string no yes
resourceKind Resource Kind key of the Alert Definitions to search for query xs:string no no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:alert-definitions/>

PUT /api/alertdefinitions

Updates an existing Alert Definition.

Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alert-definition xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>f080147f-c60d-4f08-8801-b602e2931b6f</ops:id>
    <ops:name>High CPU/Memory Usage</ops:name>
    <ops:description>CPU or MEM usage too High</ops:description>
    <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
    <ops:resourceKindKey>HostSystem</ops:resourceKindKey>
    <ops:waitCycles>3</ops:waitCycles>
    <ops:cancelCycles>2</ops:cancelCycles>
    <ops:type>0</ops:type>
    <ops:subType>0</ops:subType>
    <ops:states>
        <ops:state severity="WARNING">
            <ops:composite-symptom-set>
                <ops:operator>AND</ops:operator>
                <ops:symptom-sets>
                    <ops:symptom-set>
                        <ops:symptomDefinitionIds>
                            <ops:symptomDefinitionId>Symptom5</ops:symptomDefinitionId>
                            <ops:symptomDefinitionId>!Symptom6</ops:symptomDefinitionId>
                        </ops:symptomDefinitionIds>
                        <ops:relation>SELF</ops:relation>
                        <ops:aggregation>ALL</ops:aggregation>
                        <ops:symptomSetOperator>AND</ops:symptomSetOperator>
                    </ops:symptom-set>
                    <ops:symptom-set>
                        <ops:symptomDefinitionIds>
                            <ops:symptomDefinitionId>Symptom100</ops:symptomDefinitionId>
                            <ops:symptomDefinitionId>Symptom101</ops:symptomDefinitionId>
                        </ops:symptomDefinitionIds>
                        <ops:relation>SELF</ops:relation>
                        <ops:aggregation>ALL</ops:aggregation>
                        <ops:symptomSetOperator>OR</ops:symptomSetOperator>
                    </ops:symptom-set>
                </ops:symptom-sets>
            </ops:composite-symptom-set>
        </ops:state>
    </ops:states>
</ops:alert-definition>
{
  "id" : "f080147f-c60d-4f08-8801-b602e2931b6f",
  "name" : "High CPU/Memory Usage",
  "description" : "CPU or MEM usage too High",
  "adapterKindKey" : "VMWARE",
  "resourceKindKey" : "HostSystem",
  "waitCycles" : 3,
  "cancelCycles" : 2,
  "type" : 0,
  "subType" : 0,
  "state" : [ {
    "severity" : "WARNING",
    "base-symptom-set" : {
      "type" : "SYMPTOM_SET_COMPOSITE",
      "symptomSets" : [ {
        "type" : "SYMPTOM_SET",
        "symptomDefinitionId" : [ "Symptom5", "!Symptom6" ],
        "relation" : "SELF",
        "aggregation" : "ALL",
        "symptomSetOperator" : "AND",
        "populationOperator" : null,
        "traversalSpecType" : null,
        "value" : null
      }, {
        "type" : "SYMPTOM_SET",
        "symptomDefinitionId" : [ "Symptom100", "Symptom101" ],
        "relation" : "SELF",
        "aggregation" : "ALL",
        "symptomSetOperator" : "OR",
        "populationOperator" : null,
        "traversalSpecType" : null,
        "value" : null
      } ],
      "operator" : "AND"
    },
    "impact" : null,
    "recommendationPriorityMap" : null
  } ]
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alert-definition xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>f080147f-c60d-4f08-8801-b602e2931b6f</ops:id>
    <ops:name>High CPU/Memory Usage</ops:name>
    <ops:description>CPU or MEM usage too High</ops:description>
    <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
    <ops:resourceKindKey>HostSystem</ops:resourceKindKey>
    <ops:waitCycles>3</ops:waitCycles>
    <ops:cancelCycles>2</ops:cancelCycles>
    <ops:type>0</ops:type>
    <ops:subType>0</ops:subType>
    <ops:states>
        <ops:state severity="WARNING">
            <ops:composite-symptom-set>
                <ops:operator>AND</ops:operator>
                <ops:symptom-sets>
                    <ops:symptom-set>
                        <ops:symptomDefinitionIds>
                            <ops:symptomDefinitionId>Symptom5</ops:symptomDefinitionId>
                            <ops:symptomDefinitionId>!Symptom6</ops:symptomDefinitionId>
                        </ops:symptomDefinitionIds>
                        <ops:relation>SELF</ops:relation>
                        <ops:aggregation>ALL</ops:aggregation>
                        <ops:symptomSetOperator>AND</ops:symptomSetOperator>
                    </ops:symptom-set>
                    <ops:symptom-set>
                        <ops:symptomDefinitionIds>
                            <ops:symptomDefinitionId>Symptom100</ops:symptomDefinitionId>
                            <ops:symptomDefinitionId>Symptom101</ops:symptomDefinitionId>
                        </ops:symptomDefinitionIds>
                        <ops:relation>SELF</ops:relation>
                        <ops:aggregation>ALL</ops:aggregation>
                        <ops:symptomSetOperator>OR</ops:symptomSetOperator>
                    </ops:symptom-set>
                </ops:symptom-sets>
            </ops:composite-symptom-set>
        </ops:state>
    </ops:states>
</ops:alert-definition>
{
  "id" : "f080147f-c60d-4f08-8801-b602e2931b6f",
  "name" : "High CPU/Memory Usage",
  "description" : "CPU or MEM usage too High",
  "adapterKindKey" : "VMWARE",
  "resourceKindKey" : "HostSystem",
  "waitCycles" : 3,
  "cancelCycles" : 2,
  "type" : 0,
  "subType" : 0,
  "state" : [ {
    "severity" : "WARNING",
    "base-symptom-set" : {
      "type" : "SYMPTOM_SET_COMPOSITE",
      "symptomSets" : [ {
        "type" : "SYMPTOM_SET",
        "symptomDefinitionId" : [ "Symptom5", "!Symptom6" ],
        "relation" : "SELF",
        "aggregation" : "ALL",
        "symptomSetOperator" : "AND",
        "populationOperator" : null,
        "traversalSpecType" : null,
        "value" : null
      }, {
        "type" : "SYMPTOM_SET",
        "symptomDefinitionId" : [ "Symptom100", "Symptom101" ],
        "relation" : "SELF",
        "aggregation" : "ALL",
        "symptomSetOperator" : "OR",
        "populationOperator" : null,
        "traversalSpecType" : null,
        "value" : null
      } ],
      "operator" : "AND"
    },
    "impact" : null,
    "recommendationPriorityMap" : null
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404
Descriptions
404 - if there is no Alert Definition found for it to be updated.
Response type
<ns3:alert-definition/>

POST /api/alertplugins

Create a new Notification Plugin Instance.
If the Notification plugin is a standard email plugin, then any untrusted certificates from the secure SMTP server is returned as part of the response , the api client should invoke a PATCH call to store these certificates.
By default the notification plugin is be in a disabled state after being created.
Use the enableAlertPlugin API to enable the plugin. Sample Request Body:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:notification-plugin version="0" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:pluginTypeId>StandardEmailPlugin</ops:pluginTypeId>
    <ops:description>Where to notify Example</ops:description>
    <ops:configValues>
        <ops:configValue name="IS_SECURE_CONNECTION">true</ops:configValue>
        <ops:configValue name="SMTP_HOST">10.118.48.101</ops:configValue>
        <ops:configValue name="SMTP_PORT">25</ops:configValue>
        <ops:configValue name="senderEmailAddress">[email protected]</ops:configValue>
        <ops:configValue name="senderName">Somebody</ops:configValue>
    </ops:configValues>
</ops:notification-plugin>
{
  "pluginTypeId" : "StandardEmailPlugin",
  "pluginId" : null,
  "name" : null,
  "description" : "Where to notify Example",
  "version" : 0,
  "enabled" : null,
  "configValue" : [ {
    "name" : "IS_SECURE_CONNECTION",
    "value" : "true"
  }, {
    "name" : "SMTP_HOST",
    "value" : "10.118.48.101"
  }, {
    "name" : "SMTP_PORT",
    "value" : "25"
  }, {
    "name" : "senderEmailAddress",
    "value" : "[email protected]"
  }, {
    "name" : "senderName",
    "value" : "Somebody"
  } ],
  "certificate" : null
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:notification-plugin version="0" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:pluginTypeId>StandardEmailPlugin</ops:pluginTypeId>
    <ops:pluginId>96d83c1b-e406-454c-ae72-60afcd13ff06</ops:pluginId>
    <ops:description>Where to notify Example</ops:description>
    <ops:configValues>
        <ops:configValue name="IS_SECURE_CONNECTION">true</ops:configValue>
        <ops:configValue name="SMTP_HOST">10.118.48.101</ops:configValue>
        <ops:configValue name="SMTP_PORT">25</ops:configValue>
        <ops:configValue name="senderEmailAddress">[email protected]</ops:configValue>
        <ops:configValue name="senderName">Somebody</ops:configValue>
    </ops:configValues>
    <ops:certificates>
        <ops:certificate>
            <ops:thumbprint>935e15ac-1643-4591-a84d-04231ee4ca30</ops:thumbprint>
            <ops:certificateDetails>Issued: vmware , expiry:10/01/2014</ops:certificateDetails>
        </ops:certificate>
    </ops:certificates>
</ops:notification-plugin>
{
  "pluginTypeId" : "StandardEmailPlugin",
  "pluginId" : "8f730d4e-5ce8-40a1-8d63-6b786f5c90f7",
  "name" : null,
  "description" : "Where to notify Example",
  "version" : 0,
  "enabled" : null,
  "configValue" : [ {
    "name" : "IS_SECURE_CONNECTION",
    "value" : "true"
  }, {
    "name" : "SMTP_HOST",
    "value" : "10.118.48.101"
  }, {
    "name" : "SMTP_PORT",
    "value" : "25"
  }, {
    "name" : "senderEmailAddress",
    "value" : "[email protected]"
  }, {
    "name" : "senderName",
    "value" : "Somebody"
  } ],
  "certificate" : [ {
    "thumbprint" : "3b867e7f-8b59-46fa-ad73-8960ada2285f",
    "certificateDetails" : "Issued: vmware , expiry:10/01/2014"
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
<ns3:notification-plugin/>

DELETE /api/alertplugins/{pluginId}

Delete an existing Notification Plugin Instance.
Response Status is HttpStatus No Content when successful.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
pluginId the identifier for the plugin instance template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

GET /api/alertplugins/{pluginId}

Get Notification Plugin specified by plugin id

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
pluginId the identifier for the plugin instance template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:notification-plugin/>

GET /api/alertplugins

Get Notification Plugins, optionally filtered for a specific type

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
pluginTypeId the type query xs:string no no

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:notification-plugins/>

GET /api/alertplugins/types

Get the Notification Plugin Types available

Request description about parameters and structure of input data

This method does not take any request parameters.

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:alert-plugin-types/>

GET /api/alertplugins/types/{pluginTypeId}

Get the Notification Plugin Type Metadata

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
pluginTypeId the notification type template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:alert-plugin-type/>

GET /api/alertplugins/{pluginId}/rules

Retrieve all the notification rule of the plugin instance.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
pluginId the identifier for the plugin instance template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:notification-rules/>

PUT /api/alertplugins/{pluginId}/enable/{enabled}

Start an existing Notification Plugin Instance.
Response Status is HttpStatus No Content when successful.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
enabled template xs:boolean yes no
pluginId the identifier for the plugin instance template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

PATCH /api/alertplugins

Patch a new Notification Plugin Instance.
Sample Request Body:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:notification-plugin version="0" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:pluginTypeId>StandardEmailPlugin</ops:pluginTypeId>
    <ops:description>Where to notify Example</ops:description>
    <ops:configValues>
        <ops:configValue name="IS_SECURE_CONNECTION">true</ops:configValue>
        <ops:configValue name="SMTP_HOST">10.118.48.101</ops:configValue>
        <ops:configValue name="SMTP_PORT">25</ops:configValue>
        <ops:configValue name="senderEmailAddress">[email protected]</ops:configValue>
        <ops:configValue name="senderName">Somebody</ops:configValue>
    </ops:configValues>
    <ops:certificates>
        <ops:certificate>
            <ops:thumbprint>c08b4651-fc89-4b0d-a0b1-8e7d4f33e841</ops:thumbprint>
            <ops:certificateDetails>Issued: vmware , expiry:10/01/2014</ops:certificateDetails>
        </ops:certificate>
    </ops:certificates>
</ops:notification-plugin>
{
  "pluginTypeId" : "StandardEmailPlugin",
  "pluginId" : null,
  "name" : null,
  "description" : "Where to notify Example",
  "version" : 0,
  "enabled" : null,
  "configValue" : [ {
    "name" : "IS_SECURE_CONNECTION",
    "value" : "true"
  }, {
    "name" : "SMTP_HOST",
    "value" : "10.118.48.101"
  }, {
    "name" : "SMTP_PORT",
    "value" : "25"
  }, {
    "name" : "senderEmailAddress",
    "value" : "[email protected]"
  }, {
    "name" : "senderName",
    "value" : "Somebody"
  } ],
  "certificate" : [ {
    "thumbprint" : "79158837-d3e7-4418-82e3-a742f80ddb0c",
    "certificateDetails" : "Issued: vmware , expiry:10/01/2014"
  } ]
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:notification-plugin version="0" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:pluginTypeId>StandardEmailPlugin</ops:pluginTypeId>
    <ops:pluginId>3d452a11-90a8-4819-b643-7a0075d838fa</ops:pluginId>
    <ops:description>Where to notify Example</ops:description>
    <ops:configValues>
        <ops:configValue name="IS_SECURE_CONNECTION">true</ops:configValue>
        <ops:configValue name="SMTP_HOST">10.118.48.101</ops:configValue>
        <ops:configValue name="SMTP_PORT">25</ops:configValue>
        <ops:configValue name="senderEmailAddress">[email protected]</ops:configValue>
        <ops:configValue name="senderName">Somebody</ops:configValue>
    </ops:configValues>
</ops:notification-plugin>
{
  "pluginTypeId" : "StandardEmailPlugin",
  "pluginId" : "befbc6d4-0560-44ef-a010-4cb46896864d",
  "name" : null,
  "description" : "Where to notify Example",
  "version" : 0,
  "enabled" : null,
  "configValue" : [ {
    "name" : "IS_SECURE_CONNECTION",
    "value" : "true"
  }, {
    "name" : "SMTP_HOST",
    "value" : "10.118.48.101"
  }, {
    "name" : "SMTP_PORT",
    "value" : "25"
  }, {
    "name" : "senderEmailAddress",
    "value" : "[email protected]"
  }, {
    "name" : "senderName",
    "value" : "Somebody"
  } ],
  "certificate" : null
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:notification-plugin/>

PUT /api/alertplugins

Update an existing Notification Plugin Instance
Examples in XML and JSON format:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:notification-plugin version="140592123" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:pluginTypeId>StandardEmailPlugin</ops:pluginTypeId>
    <ops:pluginId>18589dea-9999-1234-abba-f1ee73004dac</ops:pluginId>
    <ops:description>Where to notify Example</ops:description>
    <ops:configValues>
        <ops:configValue name="IS_SECURE_CONNECTION">true</ops:configValue>
        <ops:configValue name="SMTP_HOST">10.118.48.101</ops:configValue>
        <ops:configValue name="SMTP_PORT">25</ops:configValue>
        <ops:configValue name="senderEmailAddress">[email protected]</ops:configValue>
        <ops:configValue name="senderName">Somebody</ops:configValue>
    </ops:configValues>
</ops:notification-plugin>
{
  "pluginTypeId" : "StandardEmailPlugin",
  "pluginId" : "18589dea-9999-1234-abba-f1ee73004dac",
  "name" : null,
  "description" : "Where to notify Example",
  "version" : 140592123,
  "enabled" : null,
  "configValue" : [ {
    "name" : "IS_SECURE_CONNECTION",
    "value" : "true"
  }, {
    "name" : "SMTP_HOST",
    "value" : "10.118.48.101"
  }, {
    "name" : "SMTP_PORT",
    "value" : "25"
  }, {
    "name" : "senderEmailAddress",
    "value" : "[email protected]"
  }, {
    "name" : "senderName",
    "value" : "Somebody"
  } ],
  "certificate" : null
}

Before updating a notification plugin, the plugin should be disabled then updated, And during the update process
if there are any untrusted certificates returned by the server, A patchAlertPlugin call should be made
Once the update is successfully completed then a call to the enable the plugin enableAlertplugin should be made

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:notification-plugin/>

POST /api/alerts/{id}/notes

Adds a Note to an Alert.

Example: POST /api/alerts/{id}/notes
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alert-note-content xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:content>sample note</ops:content>
</ops:alert-note-content>
{
  "content" : "sample note"
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alert-note id="ea3f7bcc-12f0-432b-9ba4-a808b14b8891" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:alertId>0d9ff4f7-1603-43c9-b51d-db2b5b47c65e</ops:alertId>
    <ops:creationTimeUTC>0</ops:creationTimeUTC>
    <ops:type>USER</ops:type>
    <ops:userId>2d8b511a-676a-4b9b-a032-aae9278c4f1f</ops:userId>
    <ops:userName>testUser</ops:userName>
    <ops:note>sample note</ops:note>
</ops:alert-note>
{
  "id" : "ea3f7bcc-12f0-432b-9ba4-a808b14b8891",
  "alertId" : "0d9ff4f7-1603-43c9-b51d-db2b5b47c65e",
  "creationTimeUTC" : 0,
  "type" : "USER",
  "userId" : "2d8b511a-676a-4b9b-a032-aae9278c4f1f",
  "userName" : "testUser",
  "note" : "sample note",
  "extension" : null,
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id UUID of the alert. template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201, 404, 500
Descriptions
201 - Returns the Alert Note created in the system
404 - If there is no Alert with the specified identifier
500 - If there is any error creating the Alert Note
Response type
<ns3:alert-note/>

DELETE /api/alerts/{id}/notes/{noteId}

Deletes a specific Alert Note for a specific Alert.

Example: DELETE /api/alerts/{id}/notes/{noteId}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
noteId Alert Note identifier template xs:uuid yes no
id UUID of the alert. template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204, 404, 500
Descriptions
204 - If the Alert Note was successfully deleted from the system
404 - If an Alert specified by the Alert identifier doesn't exist
404 - If an Alert Note specified by the Note identifier doesn't exist
500 - If there is an error deleting the Alert Note from the system
Response type
No content returned by this method.

GET /api/alerts/{id}

Look up an Alert by its identifier.

Example: GET /api/alerts/{id}
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alert xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:alertId>31eeaeec-82d5-4037-a59b-efed2e7c8e3a</ops:alertId>
    <ops:resourceId>40000000-0000-0000-0000-000000000004</ops:resourceId>
    <ops:alertLevel>NONE</ops:alertLevel>
    <ops:startTimeUTC>0</ops:startTimeUTC>
    <ops:cancelTimeUTC>0</ops:cancelTimeUTC>
    <ops:updateTimeUTC>0</ops:updateTimeUTC>
    <ops:suspendUntilTimeUTC>0</ops:suspendUntilTimeUTC>
</ops:alert>
{
  "alertId" : "31eeaeec-82d5-4037-a59b-efed2e7c8e3a",
  "resourceId" : "40000000-0000-0000-0000-000000000004",
  "alertLevel" : "NONE",
  "type" : null,
  "subType" : null,
  "status" : null,
  "startTimeUTC" : 0,
  "cancelTimeUTC" : 0,
  "updateTimeUTC" : 0,
  "suspendUntilTimeUTC" : 0,
  "controlState" : null,
  "statKey" : null,
  "ownerId" : null,
  "ownerName" : null,
  "alertDefinitionId" : null,
  "alertDefinitionName" : null,
  "alertImpact" : null,
  "extension" : null,
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id UUID of the alert. template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404, 500
Descriptions
200 - Returns the Alert for the specified identifier
404 - If there is no Alert with the specified identifier
500 - If there is an error retrieving the Alert with the specified identifier
Response type
<ns3:alert/>

GET /api/alerts/contributingsymptoms

Gets the list of triggered symptoms for the requested alerts.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id Identifiers of the Alerts query xs:uuid yes yes

Response http response codes, description about schema of return types

HTTP Response Codes
200, 500
Descriptions
200 - On success
500 - If there is an error retrieving the list of triggered symptoms
Response type
<ns3:alert-contributing-symptoms/>

GET /api/alerts/{id}/notes/{noteId}

Returns requested Alert Note associated with an Alert.

Example: GET /api/alerts/{id}/notes/{noteId}
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alert-note id="ea3f7bcc-12f0-432b-9ba4-a808b14b8891" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:alertId>0d9ff4f7-1603-43c9-b51d-db2b5b47c65e</ops:alertId>
    <ops:creationTimeUTC>0</ops:creationTimeUTC>
    <ops:type>USER</ops:type>
    <ops:userId>2d8b511a-676a-4b9b-a032-aae9278c4f1f</ops:userId>
    <ops:userName>testUser</ops:userName>
    <ops:note>sample note</ops:note>
</ops:alert-note>
{
  "id" : "ea3f7bcc-12f0-432b-9ba4-a808b14b8891",
  "alertId" : "0d9ff4f7-1603-43c9-b51d-db2b5b47c65e",
  "creationTimeUTC" : 0,
  "type" : "USER",
  "userId" : "2d8b511a-676a-4b9b-a032-aae9278c4f1f",
  "userName" : "testUser",
  "note" : "sample note",
  "extension" : null,
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
noteId Alert Note identifier template xs:uuid yes no
id UUID of the alert. template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404, 500
Descriptions
200 - Returns the requested Alert Note
404 - If there is no Alert or no note with the specified identifier
500 - If there is any error retrieving the Alert Note
Response type
<ns3:alert-note/>

GET /api/alerts/{id}/notes

Returns all the Alert Notes associated with an Alert.

Example: GET /api/alerts/{id}/notes
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alert-notes xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:alert-note id="ea3f7bcc-12f0-432b-9ba4-a808b14b8891">
        <ops:alertId>0d9ff4f7-1603-43c9-b51d-db2b5b47c65e</ops:alertId>
        <ops:creationTimeUTC>0</ops:creationTimeUTC>
        <ops:type>USER</ops:type>
        <ops:userId>2d8b511a-676a-4b9b-a032-aae9278c4f1f</ops:userId>
        <ops:userName>testUser</ops:userName>
        <ops:note>sample note</ops:note>
    </ops:alert-note>
    <ops:alert-note id="24c93393-eba2-450c-85fb-105c6d97c7ab">
        <ops:alertId>0d9ff4f7-1603-43c9-b51d-db2b5b47c65e</ops:alertId>
        <ops:creationTimeUTC>0</ops:creationTimeUTC>
        <ops:type>SYSTEM</ops:type>
        <ops:userId>2d8b511a-676a-4b9b-a032-aae9278c4f1f</ops:userId>
        <ops:userName>testUser</ops:userName>
        <ops:note>sample note</ops:note>
    </ops:alert-note>
</ops:alert-notes>
{
  "pageInfo" : null,
  "links" : null,
  "alertNotes" : [ {
    "id" : "ea3f7bcc-12f0-432b-9ba4-a808b14b8891",
    "alertId" : "0d9ff4f7-1603-43c9-b51d-db2b5b47c65e",
    "creationTimeUTC" : 0,
    "type" : "USER",
    "userId" : "2d8b511a-676a-4b9b-a032-aae9278c4f1f",
    "userName" : "testUser",
    "note" : "sample note",
    "extension" : null,
    "links" : null
  }, {
    "id" : "24c93393-eba2-450c-85fb-105c6d97c7ab",
    "alertId" : "0d9ff4f7-1603-43c9-b51d-db2b5b47c65e",
    "creationTimeUTC" : 0,
    "type" : "SYSTEM",
    "userId" : "2d8b511a-676a-4b9b-a032-aae9278c4f1f",
    "userName" : "testUser",
    "note" : "sample note",
    "extension" : null,
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
id UUID of the alert. template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404, 500
Descriptions
200 - Returns all the Alert Notes for the specified Alert
404 - If there is no Alert with the specified identifier
500 - If there is any error retrieving the Alert Notes
Response type
<ns3:alert-notes/>

GET /api/alerts

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

Example: GET /api/alerts?id={id1}&id={id2}&resourceId={resId1}&resourceId={resId2}
Sample Response:

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
id query xs:uuid no yes
resourceId query xs:uuid no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200, 500
Descriptions
200 - If there are Alerts matching the specified identifiers. Can be empty
500 - If there is an error retrieving the Alerts with the specified identifiers
Response type
<ns3:alerts/>

GET /api/alerts/types

Gets the Alert Types and Subtypes defined in the system.

Examples:
GET /api/alerts/types returns the Problem Alerts specific Alert Types & Subtypes
GET /api/alerts/types?ignoreLegacy=false returns all the Alert Types & Subtypes

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
ignoreLegacy If set to true will filter out the legacy Alert Types & Subtypes Defaults to true. query xs:boolean no no true

Response http response codes, description about schema of return types

HTTP Response Codes
200, 500
Descriptions
200 - Returns all the Alert Types and the associated Subtypes
500 - If there is an error retrieving the Alert Types & Subtypes
Response type
<ns3:alert-types/>

POST /api/alerts

Modify multiple Alerts by looking them up using their identifiers and performing one of the following actions - Suspend, Cancel, Take Ownership, Release Ownership
Examples:
POST /api/alerts?action=suspend&minutes=1
POST /api/alerts?action=cancel
POST /api/alerts?action=takeownership
POST /api/alerts?action=releaseownership
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:uuid-values xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:uuids>31eeaeec-82d5-4037-a59b-efed2e7c8e3a 18589dea-9999-1234-abba-f1ee73004dac</ops:uuids>
</ops:uuid-values>
{
  "uuids" : [ "31eeaeec-82d5-4037-a59b-efed2e7c8e3a", "18589dea-9999-1234-abba-f1ee73004dac" ]
}

Sample Response:

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
action The action to take query xs:string yes no
minutes The number of minutes to suspend an alert. Required when action is suspend, otherwise ignored. query xs:int no no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200, 500
Descriptions
200 - Returns the Alerts on which the action has been performed
500 - If there is an error performing the specified action
Response type
<ns3:alerts/>

POST /api/alerts/query

Query for Alerts using one or more criteria specified in the Query Spec.
Example: POST /api/alerts/query
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alert-query compositeOperator="AND" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:alertId></ops:alertId>
    <ops:resource-query>
        <ops:resourceId>5748438c-41d5-4397-a59b-efe973674653</ops:resourceId>
        <ops:statKeyInclusive>true</ops:statKeyInclusive>
    </ops:resource-query>
    <ops:activeOnly>true</ops:activeOnly>
    <ops:alertCriticality>CRITICAL IMMEDIATE WARNING INFORMATION</ops:alertCriticality>
    <ops:alertStatus></ops:alertStatus>
    <ops:alertImpact></ops:alertImpact>
    <ops:alertControlState></ops:alertControlState>
    <ops:includeChildrenResources>true</ops:includeChildrenResources>
    <ops:extractOwnerName>false</ops:extractOwnerName>
</ops:alert-query>
{
  "compositeOperator" : "AND",
  "alertId" : [ ],
  "alertName" : null,
  "resource-query" : {
    "name" : null,
    "regex" : null,
    "adapterKind" : null,
    "resourceKind" : null,
    "collectorName" : null,
    "collectorId" : null,
    "maintenanceScheduleId" : null,
    "adapterInstanceId" : null,
    "recentlyAdded" : null,
    "resourceState" : null,
    "resourceStatus" : null,
    "resourceHealth" : null,
    "parentId" : null,
    "credentialId" : null,
    "resourceId" : [ "5748438c-41d5-4397-a59b-efe973674653" ],
    "propertyName" : null,
    "propertyValue" : null,
    "statKey" : null,
    "statKeyLowerBound" : null,
    "statKeyUpperBound" : null,
    "statKeyInclusive" : true,
    "propertyConditions" : null,
    "statConditions" : null,
    "includeRelated" : null
  },
  "activeOnly" : true,
  "alertTypeSubtype" : [ ],
  "alertCriticality" : [ "CRITICAL", "IMMEDIATE", "WARNING", "INFORMATION" ],
  "alertStatus" : [ ],
  "alertImpact" : [ ],
  "alertDefinitionId" : null,
  "alertControlState" : [ ],
  "startTimeRange" : null,
  "updateTimeRange" : null,
  "cancelTimeRange" : null,
  "includeChildrenResources" : true,
  "extractOwnerName" : false,
  "userId" : null,
  "userName" : null,
  "resourceKind" : null,
  "groupingCondition" : null,
  "groupId" : null
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alerts xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:alert>
        <ops:alertId>31eeaeec-82d5-4037-a59b-efed2e7c8e3a</ops:alertId>
        <ops:resourceId>40000000-0000-0000-0000-000000000004</ops:resourceId>
        <ops:alertLevel>NONE</ops:alertLevel>
        <ops:startTimeUTC>0</ops:startTimeUTC>
        <ops:cancelTimeUTC>0</ops:cancelTimeUTC>
        <ops:updateTimeUTC>0</ops:updateTimeUTC>
        <ops:suspendUntilTimeUTC>0</ops:suspendUntilTimeUTC>
    </ops:alert>
    <ops:alert>
        <ops:alertId>18589dea-9999-1234-abba-f1ee73004dac</ops:alertId>
        <ops:resourceId>40000000-0000-0000-0000-000000000004</ops:resourceId>
        <ops:alertLevel>NONE</ops:alertLevel>
        <ops:startTimeUTC>0</ops:startTimeUTC>
        <ops:cancelTimeUTC>0</ops:cancelTimeUTC>
        <ops:updateTimeUTC>0</ops:updateTimeUTC>
        <ops:suspendUntilTimeUTC>0</ops:suspendUntilTimeUTC>
    </ops:alert>
</ops:alerts>
{
  "pageInfo" : null,
  "links" : null,
  "alerts" : [ {
    "alertId" : "31eeaeec-82d5-4037-a59b-efed2e7c8e3a",
    "resourceId" : "40000000-0000-0000-0000-000000000004",
    "alertLevel" : "NONE",
    "type" : null,
    "subType" : null,
    "status" : null,
    "startTimeUTC" : 0,
    "cancelTimeUTC" : 0,
    "updateTimeUTC" : 0,
    "suspendUntilTimeUTC" : 0,
    "controlState" : null,
    "statKey" : null,
    "ownerId" : null,
    "ownerName" : null,
    "alertDefinitionId" : null,
    "alertDefinitionName" : null,
    "alertImpact" : null,
    "extension" : null,
    "links" : null
  }, {
    "alertId" : "18589dea-9999-1234-abba-f1ee73004dac",
    "resourceId" : "40000000-0000-0000-0000-000000000004",
    "alertLevel" : "NONE",
    "type" : null,
    "subType" : null,
    "status" : null,
    "startTimeUTC" : 0,
    "cancelTimeUTC" : 0,
    "updateTimeUTC" : 0,
    "suspendUntilTimeUTC" : 0,
    "controlState" : null,
    "statKey" : null,
    "ownerId" : null,
    "ownerName" : null,
    "alertDefinitionId" : null,
    "alertDefinitionName" : null,
    "alertImpact" : null,
    "extension" : null,
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200, 500
Descriptions
200 - Returns the Alerts matching the specified Query Spec (Collection can be empty)
500 - If there is an error retrieving the Alerts
Response type
<ns3:alerts/>

POST /api/alerts/group/{groupingCondition}/query

Query for Alert groups using one or more criteria specified in the Query Spec.
Example: POST /api/alerts/group/{groupingCondition}/query
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alert-query compositeOperator="AND" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:alertId></ops:alertId>
    <ops:resource-query>
        <ops:resourceId>5748438c-41d5-4397-a59b-efe973674653</ops:resourceId>
        <ops:statKeyInclusive>true</ops:statKeyInclusive>
    </ops:resource-query>
    <ops:activeOnly>true</ops:activeOnly>
    <ops:alertCriticality>CRITICAL IMMEDIATE WARNING INFORMATION</ops:alertCriticality>
    <ops:alertStatus></ops:alertStatus>
    <ops:alertImpact></ops:alertImpact>
    <ops:alertControlState></ops:alertControlState>
    <ops:includeChildrenResources>true</ops:includeChildrenResources>
    <ops:extractOwnerName>false</ops:extractOwnerName>
</ops:alert-query>
{
  "compositeOperator" : "AND",
  "alertId" : [ ],
  "alertName" : null,
  "resource-query" : {
    "name" : null,
    "regex" : null,
    "adapterKind" : null,
    "resourceKind" : null,
    "collectorName" : null,
    "collectorId" : null,
    "maintenanceScheduleId" : null,
    "adapterInstanceId" : null,
    "recentlyAdded" : null,
    "resourceState" : null,
    "resourceStatus" : null,
    "resourceHealth" : null,
    "parentId" : null,
    "credentialId" : null,
    "resourceId" : [ "5748438c-41d5-4397-a59b-efe973674653" ],
    "propertyName" : null,
    "propertyValue" : null,
    "statKey" : null,
    "statKeyLowerBound" : null,
    "statKeyUpperBound" : null,
    "statKeyInclusive" : true,
    "propertyConditions" : null,
    "statConditions" : null,
    "includeRelated" : null
  },
  "activeOnly" : true,
  "alertTypeSubtype" : [ ],
  "alertCriticality" : [ "CRITICAL", "IMMEDIATE", "WARNING", "INFORMATION" ],
  "alertStatus" : [ ],
  "alertImpact" : [ ],
  "alertDefinitionId" : null,
  "alertControlState" : [ ],
  "startTimeRange" : null,
  "updateTimeRange" : null,
  "cancelTimeRange" : null,
  "includeChildrenResources" : true,
  "extractOwnerName" : false,
  "userId" : null,
  "userName" : null,
  "resourceKind" : null,
  "groupingCondition" : null,
  "groupId" : null
}

Sample Response:
Show

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
groupingCondition the condition to be used for grouping template <ns3:alert-grouping-condition> yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200, 500
Descriptions
200 - Returns the AlertGroups of alerts matching the specified Query Spec (Collection can be empty)
500 - If there is an error retrieving the AlertGroups
Response type
<ns3:alert-groups/>

POST /api/alerts/notes/query

Query for Alert Notes based on specified criteria.
Example: POST /api/alerts/notes/query
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alert-notes-query compositeOperator="AND" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:alertNoteId></ops:alertNoteId>
    <ops:alert-query compositeOperator="AND">
        <ops:alertId>24c93393-eba2-450c-85fb-105c6d97c7ab</ops:alertId>
        <ops:activeOnly>false</ops:activeOnly>
        <ops:alertCriticality></ops:alertCriticality>
        <ops:alertStatus></ops:alertStatus>
        <ops:alertImpact></ops:alertImpact>
        <ops:alertControlState></ops:alertControlState>
        <ops:includeChildrenResources>false</ops:includeChildrenResources>
        <ops:extractOwnerName>false</ops:extractOwnerName>
    </ops:alert-query>
</ops:alert-notes-query>
{
  "compositeOperator" : "AND",
  "alertNoteId" : [ ],
  "alert-query" : {
    "compositeOperator" : "AND",
    "alertId" : [ "24c93393-eba2-450c-85fb-105c6d97c7ab" ],
    "alertName" : null,
    "resource-query" : null,
    "activeOnly" : false,
    "alertTypeSubtype" : [ ],
    "alertCriticality" : [ ],
    "alertStatus" : [ ],
    "alertImpact" : [ ],
    "alertDefinitionId" : null,
    "alertControlState" : [ ],
    "startTimeRange" : null,
    "updateTimeRange" : null,
    "cancelTimeRange" : null,
    "includeChildrenResources" : false,
    "extractOwnerName" : false,
    "userId" : null,
    "userName" : null,
    "resourceKind" : null,
    "groupingCondition" : null,
    "groupId" : null
  },
  "creationTimeRange" : null,
  "userName" : [ ],
  "alertNoteType" : [ ],
  "content" : [ ]
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:alert-notes xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:alert-note id="ea3f7bcc-12f0-432b-9ba4-a808b14b8891">
        <ops:alertId>0d9ff4f7-1603-43c9-b51d-db2b5b47c65e</ops:alertId>
        <ops:creationTimeUTC>0</ops:creationTimeUTC>
        <ops:type>USER</ops:type>
        <ops:userId>2d8b511a-676a-4b9b-a032-aae9278c4f1f</ops:userId>
        <ops:userName>testUser</ops:userName>
        <ops:note>sample note</ops:note>
    </ops:alert-note>
    <ops:alert-note id="24c93393-eba2-450c-85fb-105c6d97c7ab">
        <ops:alertId>0d9ff4f7-1603-43c9-b51d-db2b5b47c65e</ops:alertId>
        <ops:creationTimeUTC>0</ops:creationTimeUTC>
        <ops:type>SYSTEM</ops:type>
        <ops:userId>2d8b511a-676a-4b9b-a032-aae9278c4f1f</ops:userId>
        <ops:userName>testUser</ops:userName>
        <ops:note>sample note</ops:note>
    </ops:alert-note>
</ops:alert-notes>
{
  "pageInfo" : null,
  "links" : null,
  "alertNotes" : [ {
    "id" : "ea3f7bcc-12f0-432b-9ba4-a808b14b8891",
    "alertId" : "0d9ff4f7-1603-43c9-b51d-db2b5b47c65e",
    "creationTimeUTC" : 0,
    "type" : "USER",
    "userId" : "2d8b511a-676a-4b9b-a032-aae9278c4f1f",
    "userName" : "testUser",
    "note" : "sample note",
    "extension" : null,
    "links" : null
  }, {
    "id" : "24c93393-eba2-450c-85fb-105c6d97c7ab",
    "alertId" : "0d9ff4f7-1603-43c9-b51d-db2b5b47c65e",
    "creationTimeUTC" : 0,
    "type" : "SYSTEM",
    "userId" : "2d8b511a-676a-4b9b-a032-aae9278c4f1f",
    "userName" : "testUser",
    "note" : "sample note",
    "extension" : null,
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200, 500
Descriptions
200 - Returns the Alert Notes matching the query specified (Collection can be empty)
500 - If there is any error retrieving the Alert Notes
Response type
<ns3:alert-notes/>

POST /api/auth/token/acquire

Acquire a token to perform REST API calls.. Performing a POST /api/auth/token/acquire would yield a response object that includes token and its validity.
HTTP Status 401 will be sent back if the authentication operation has failed.


Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:username-password xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:username>Some-LDAP-User</ops:username>
    <ops:authSource>Imported LDAP Server</ops:authSource>
    <ops:password>Some-LDAP-User-Password</ops:password>
</ops:username-password>
Sample Request in JSON format
Show
{
  "username" : "Some-LDAP-User",
  "authSource" : "Imported LDAP Server",
  "password" : "Some-LDAP-User-Password"
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:auth-token/>

POST /api/auth/sources

Add a new authentication source in the system.. If the authentication source is of type LDAP or AD and if ssl is enabled, the response object will contain a list of certificates found matching with the provided host.if the authentication source is not of type LDAP or AD (or) if ssl is not enabled, then the authentication source is available for use as soon as the api call is successful.It is the duty of the caller to call the PATCH (/sources) api with the certificate details. Once the PATCH api call is successful, the authentication source is available for use.

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:auth-source lastModified="1523035908002" created="1523035908002" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>TEST</ops:name>
    <ops:sourceType id="ACTIVE_DIRECTORY">
        <ops:name>ACTIVE_DIRECTORY</ops:name>
        <ops:description>DESC</ops:description>
    </ops:sourceType>
    <ops:name-value name="display-name">Test_11</ops:name-value>
    <ops:name-value name="host">brlrootdc01.vmware.com</ops:name-value>
    <ops:name-value name="use-ssl">true</ops:name-value>
    <ops:name-value name="base-domain">dc=vmware,dc=com</ops:name-value>
    <ops:name-value name="user-name">[email protected]</ops:name-value>
    <ops:name-value name="password">password</ops:name-value>
    <ops:name-value name="base-domain">dc=vmware,dc=com</ops:name-value>
    <ops:name-value name="common-name">userPrincipalName</ops:name-value>
    <ops:name-value name="port">636</ops:name-value>
    <ops:name-value name="group-search-criteria">(|(objectClass=group)(objectClass=groupOfNames))</ops:name-value>
    <ops:name-value name="member-attribute">member</ops:name-value>
    <ops:name-value name="user-search-criteria"></ops:name-value>
    <ops:name-value name="member-match-field"></ops:name-value>
    <ops:name-value name="ldap-context-attributes"></ops:name-value>
</ops:auth-source>
Sample Response in XML format
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:auth-source lastModified="1523035908024" created="1523035908024" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>00000000-0000-000a-0000-000000000014</ops:id>
    <ops:name>TEST</ops:name>
    <ops:sourceType id="ACTIVE_DIRECTORY">
        <ops:name>ACTIVE_DIRECTORY</ops:name>
        <ops:description>DESC</ops:description>
    </ops:sourceType>
    <ops:name-value name="display-name">Test_11</ops:name-value>
    <ops:name-value name="host">brlrootdc01.vmware.com</ops:name-value>
    <ops:name-value name="use-ssl">true</ops:name-value>
    <ops:name-value name="base-domain">dc=vmware,dc=com</ops:name-value>
    <ops:name-value name="user-name">[email protected]</ops:name-value>
    <ops:name-value name="password">password</ops:name-value>
    <ops:name-value name="base-domain">dc=vmware,dc=com</ops:name-value>
    <ops:name-value name="common-name">userPrincipalName</ops:name-value>
    <ops:name-value name="port">636</ops:name-value>
    <ops:name-value name="group-search-criteria">(|(objectClass=group)(objectClass=groupOfNames))</ops:name-value>
    <ops:name-value name="member-attribute">member</ops:name-value>
    <ops:name-value name="user-search-criteria"></ops:name-value>
    <ops:name-value name="member-match-field"></ops:name-value>
    <ops:name-value name="ldap-context-attributes"></ops:name-value>
    <ops:certificates>
        <ops:thumbprint>1@34343453dfr#@gsrakgb454</ops:thumbprint>
        <ops:certificateDetails>CERT_DETAILS</ops:certificateDetails>
    </ops:certificates>
</ops:auth-source>
Sample Request in JSON format
Show
{
  "id" : null,
  "name" : "TEST",
  "sourceType" : {
    "id" : "ACTIVE_DIRECTORY",
    "name" : "ACTIVE_DIRECTORY",
    "description" : "DESC",
    "links" : null,
    "properties" : null
  },
  "created" : 1523035908043,
  "lastModified" : 1523035908043,
  "links" : null,
  "property" : [ {
    "name" : "display-name",
    "value" : "Test_11"
  }, {
    "name" : "host",
    "value" : "brlrootdc01.vmware.com"
  }, {
    "name" : "use-ssl",
    "value" : "true"
  }, {
    "name" : "base-domain",
    "value" : "dc=vmware,dc=com"
  }, {
    "name" : "user-name",
    "value" : "[email protected]"
  }, {
    "name" : "password",
    "value" : "password"
  }, {
    "name" : "base-domain",
    "value" : "dc=vmware,dc=com"
  }, {
    "name" : "common-name",
    "value" : "userPrincipalName"
  }, {
    "name" : "port",
    "value" : "636"
  }, {
    "name" : "group-search-criteria",
    "value" : "(|(objectClass=group)(objectClass=groupOfNames))"
  }, {
    "name" : "member-attribute",
    "value" : "member"
  }, {
    "name" : "user-search-criteria",
    "value" : ""
  }, {
    "name" : "member-match-field",
    "value" : ""
  }, {
    "name" : "ldap-context-attributes",
    "value" : ""
  } ],
  "certificates" : [ ]
}
Sample Response in JSON format
Show
{
  "id" : "00000000-0000-000a-0000-000000000014",
  "name" : "TEST",
  "sourceType" : {
    "id" : "ACTIVE_DIRECTORY",
    "name" : "ACTIVE_DIRECTORY",
    "description" : "DESC",
    "links" : null,
    "properties" : null
  },
  "created" : 1523035908044,
  "lastModified" : 1523035908044,
  "links" : null,
  "property" : [ {
    "name" : "display-name",
    "value" : "Test_11"
  }, {
    "name" : "host",
    "value" : "brlrootdc01.vmware.com"
  }, {
    "name" : "use-ssl",
    "value" : "true"
  }, {
    "name" : "base-domain",
    "value" : "dc=vmware,dc=com"
  }, {
    "name" : "user-name",
    "value" : "[email protected]"
  }, {
    "name" : "password",
    "value" : "password"
  }, {
    "name" : "base-domain",
    "value" : "dc=vmware,dc=com"
  }, {
    "name" : "common-name",
    "value" : "userPrincipalName"
  }, {
    "name" : "port",
    "value" : "636"
  }, {
    "name" : "group-search-criteria",
    "value" : "(|(objectClass=group)(objectClass=groupOfNames))"
  }, {
    "name" : "member-attribute",
    "value" : "member"
  }, {
    "name" : "user-search-criteria",
    "value" : ""
  }, {
    "name" : "member-match-field",
    "value" : ""
  }, {
    "name" : "ldap-context-attributes",
    "value" : ""
  } ],
  "certificates" : [ {
    "thumbprint" : "1@34343453dfr#@gsrakgb454",
    "certificateDetails" : "CERT_DETAILS"
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201, 200
Descriptions
201 - auth source is created in the system.
200 - auth source is not created in the system and ssl certificate details are returned as response. The caller has to call the PATCH (/auth/sources) API with the certificate details.
Response type
<ns3:auth-source/>

POST /api/auth/roles/{roleName}/privileges

Add the privileges to a user role.. New privileges union with any previous privileges.

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:privilege-keys xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:privilege-key>Power On VM</ops:privilege-key>
    <ops:privilege-key>Power Off VM</ops:privilege-key>
</ops:privilege-keys>
Sample Response in XML format
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:privilege-keys xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:privilege-key>Power On VM</ops:privilege-key>
    <ops:privilege-key>Power Off VM</ops:privilege-key>
</ops:privilege-keys>
Sample Request in JSON format
Show
{
  "privilege-key" : [ "Power On VM", "Power Off VM" ]
}
Sample Response in JSON format
Show
{
  "privilege-key" : [ "Power On VM", "Power Off VM" ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
roleName name of the role template xs:string yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:privilege-keys/>

PUT /api/auth/users/{userId}/permissions

Assign a role permission to a particular user. Replaces existing role permission in its entirety if it exists already for the named role..

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
userId Identifier of the user to which the role permission needs to be assigned template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:role-permissions/>

PUT /api/auth/usergroups/{groupId}/permissions

Assign a role permission to a particular user group. Replaces existing role permission in its entirety if it exists already for the named role..

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
groupId Identifier of the user group to which the role permission needs to be assigned template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:role-permissions/>

PUT /api/auth/users/{userId}/traversalspecs

(Deprecated) Assign a traversal specification to a particular user.. Traversal specifications assigned through this API will add the specified traversal specification to a role permission for the ReadOnly role. It will also update the user's existing role permissions with this traversal specification.

This API is replaced by the assignRolePermissionToUser and unassignRolePermissionFromUser APIs which are PUT and DELETE operations respectively at the /auth/usergroups/{groupId}/permissions endpoint.
Note: mixing current and deprecated APIs is not recommended and may result in undefined behavior.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
userId Identifier of the user to which the role permission needs to be assigned template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

PUT /api/auth/usergroups/{groupId}/traversalspecs

(Deprecated) Assign a traversal specification to a particular user.. Traversal specifications assigned through this API will add the specified traversal specification to a role permission for the ReadOnly role. It will also update the user's existing role permissions with this traversal specification.

This API is replaced by the assignRolePermissionToUser and unassignRolePermissionFromUser APIs which are PUT and DELETE operations respectively at the /auth/usergroups/{groupId}/permissions endpoint.
Note: mixing current and deprecated APIs is not recommended and may result in undefined behavior.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
groupId Identifier of the user group to which the role permission needs to be assigned template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

PUT /api/auth/users/passwordchange

Changes the password of the logged in user..

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:password-change xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:currentPassword>Current Password</ops:currentPassword>
    <ops:newPassword>New Password</ops:newPassword>
</ops:password-change>
Sample Request in JSON format
Show
{
  "currentPassword" : "Current Password",
  "newPassword" : "New Password"
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

POST /api/auth/users

Create a new user..

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
<ns3:user/>

POST /api/auth/usergroups

Create a new local user group. The id of the user group has to be null

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:user-group xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>user_group_name</ops:name>
    <ops:description>user_group_desc</ops:description>
    <ops:userIds>
        <ops:userId>85290b27-2ff2-465b-afc9-1407c4c16ea7</ops:userId>
    </ops:userIds>
    <ops:roleNames>
        <ops:roleName>Administrator</ops:roleName>
    </ops:roleNames>
    <ops:role-permissions>
        <ops:role-permission allowAllObjects="true">
            <ops:roleName>Administrator</ops:roleName>
            <ops:traversal-spec-instances>
                <ops:traversal-spec-instance selectAllResources="true">
                    <ops:adapterKind>adap_kind</ops:adapterKind>
                    <ops:resourceKind>resource_kind</ops:resourceKind>
                    <ops:name>traversal_spec_name</ops:name>
                </ops:traversal-spec-instance>
            </ops:traversal-spec-instances>
        </ops:role-permission>
    </ops:role-permissions>
</ops:user-group>
Sample Response in XML format
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:user-group xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>1a4387bc-a5ad-4f73-9ebd-bb9229050213</ops:id>
    <ops:name>user_group_name</ops:name>
    <ops:description>user_group_desc</ops:description>
    <ops:userIds>
        <ops:userId>15a9eca7-99fd-463a-a78b-522b54a6068a</ops:userId>
    </ops:userIds>
    <ops:roleNames>
        <ops:roleName>Administrator</ops:roleName>
    </ops:roleNames>
    <ops:role-permissions>
        <ops:role-permission allowAllObjects="true">
            <ops:roleName>Administrator</ops:roleName>
            <ops:traversal-spec-instances>
                <ops:traversal-spec-instance selectAllResources="true">
                    <ops:adapterKind>adap_kind</ops:adapterKind>
                    <ops:resourceKind>resource_kind</ops:resourceKind>
                    <ops:name>traversal_spec_name</ops:name>
                </ops:traversal-spec-instance>
            </ops:traversal-spec-instances>
        </ops:role-permission>
    </ops:role-permissions>
</ops:user-group>
Sample Request in JSON format
Show
{
  "id" : null,
  "authSourceId" : null,
  "name" : "user_group_name",
  "description" : "user_group_desc",
  "userId" : [ "d5d38824-0d27-42b5-be4c-cd2e8b5d0829" ],
  "roleName" : [ "Administrator" ],
  "rolePermissions" : [ {
    "roleName" : "Administrator",
    "traversalSpecInstances" : [ {
      "adapterKind" : "adap_kind",
      "resourceKind" : "resource_kind",
      "name" : "traversal_spec_name",
      "resourceSelection" : null,
      "selectAllResources" : true,
      "includedAdapterKinds" : null
    } ],
    "allowAllObjects" : true,
    "links" : null
  } ],
  "links" : null
}
Sample Response in JSON format
Show
{
  "id" : "111f64e2-398d-4d2a-a64d-65aa3ba5b4b5",
  "authSourceId" : null,
  "name" : "user_group_name",
  "description" : "user_group_desc",
  "userId" : [ "a1454ab7-649a-4131-af6b-9068561d6cbd" ],
  "roleName" : [ "Administrator" ],
  "rolePermissions" : [ {
    "roleName" : "Administrator",
    "traversalSpecInstances" : [ {
      "adapterKind" : "adap_kind",
      "resourceKind" : "resource_kind",
      "name" : "traversal_spec_name",
      "resourceSelection" : null,
      "selectAllResources" : true,
      "includedAdapterKinds" : null
    } ],
    "allowAllObjects" : true,
    "links" : null
  } ],
  "links" : null
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
<ns3:user-group/>

POST /api/auth/roles

Create a user role..

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:user-role system-created="false" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>API Administrator</ops:name>
    <ops:description>Role to allow administrative access to all Suite API methods</ops:description>
    <ops:privilege-keys>
        <ops:privilege-key>ManageAlerts</ops:privilege-key>
        <ops:privilege-key>ManageAlarms</ops:privilege-key>
        <ops:privilege-key>ManageNotificationPlugins</ops:privilege-key>
    </ops:privilege-keys>
</ops:user-role>
Sample Request in JSON format
Show
{
  "name" : "API Administrator",
  "description" : "Role to allow administrative access to all Suite API methods",
  "displayName" : null,
  "privilege-key" : [ "ManageAlerts", "ManageAlarms", "ManageNotificationPlugins" ],
  "system-created" : false,
  "links" : null
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
<ns3:user-role/>

DELETE /api/auth/sources/{sourceId}

delete an authentication source. when deleting an SSO auth source, the 'user-name' and 'password' used during creation of the sso auth source should be sent in the payload object.

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:name-values xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name-value name="user-name">username</ops:name-value>
    <ops:name-value name="password">password</ops:name-value>
</ops:name-values>
Sample Request in JSON format
Show
{
  "nameValuePairs" : [ {
    "name" : "user-name",
    "value" : "username"
  }, {
    "name" : "password",
    "value" : "password"
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
sourceId id of the authSource template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

DELETE /api/auth/users/{id}

Create a new user.. An admin operation, using this a particular local user can be deleted from the system.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id identifier of the user. template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

DELETE /api/auth/usergroups/{id}

Delete a local user group.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id identifier of the user group template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

DELETE /api/auth/usergroups

Delete a list of user groups using their identifiers..

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id identifiers of the local user group objects. query xs:uuid yes yes

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

DELETE /api/auth/roles/{roleName}

Delete a role with the given roleName..

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
roleName name of the role template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

DELETE /api/auth/users

Delete a collection of users with the given identifiers..

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id identifiers of all users that need to be deleted from the system. query xs:uuid yes yes

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

GET /api/auth/users/{userId}/permissions

Get assigned role permissions for a user..

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
userId Identifier of the user to which the role permission needs to be assigned template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:role-permissions/>

GET /api/auth/usergroups/{groupId}/permissions

Get assigned role permissions for a user group.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
groupId Identifier of the user group to which the role permission needs to be assigned template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:role-permissions/>

GET /api/auth/sources/{sourceId}

Retrieve information about a particular authentication source.

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:auth-source lastModified="1523035907879" created="1523035907879" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>00000000-0000-000a-0000-000000000014</ops:id>
    <ops:name>TEST</ops:name>
    <ops:sourceType id="ACTIVE_DIRECTORY">
        <ops:name>ACTIVE_DIRECTORY</ops:name>
        <ops:description>DESC</ops:description>
    </ops:sourceType>
    <ops:name-value name="display-name">Test_11</ops:name-value>
    <ops:name-value name="host">brlrootdc01.vmware.com</ops:name-value>
    <ops:name-value name="use-ssl">true</ops:name-value>
    <ops:name-value name="base-domain">dc=vmware,dc=com</ops:name-value>
    <ops:name-value name="user-name">[email protected]</ops:name-value>
    <ops:name-value name="password">password</ops:name-value>
    <ops:name-value name="base-domain">dc=vmware,dc=com</ops:name-value>
    <ops:name-value name="common-name">userPrincipalName</ops:name-value>
    <ops:name-value name="port">636</ops:name-value>
    <ops:name-value name="group-search-criteria">(|(objectClass=group)(objectClass=groupOfNames))</ops:name-value>
    <ops:name-value name="member-attribute">member</ops:name-value>
    <ops:name-value name="user-search-criteria"></ops:name-value>
    <ops:name-value name="member-match-field"></ops:name-value>
    <ops:name-value name="ldap-context-attributes"></ops:name-value>
</ops:auth-source>
Sample Response in JSON format
Show
{
  "id" : "00000000-0000-000a-0000-000000000014",
  "name" : "TEST",
  "sourceType" : {
    "id" : "ACTIVE_DIRECTORY",
    "name" : "ACTIVE_DIRECTORY",
    "description" : "DESC",
    "links" : null,
    "properties" : null
  },
  "created" : 1523035907902,
  "lastModified" : 1523035907902,
  "links" : null,
  "property" : [ {
    "name" : "display-name",
    "value" : "Test_11"
  }, {
    "name" : "host",
    "value" : "brlrootdc01.vmware.com"
  }, {
    "name" : "use-ssl",
    "value" : "true"
  }, {
    "name" : "base-domain",
    "value" : "dc=vmware,dc=com"
  }, {
    "name" : "user-name",
    "value" : "[email protected]"
  }, {
    "name" : "password",
    "value" : "password"
  }, {
    "name" : "base-domain",
    "value" : "dc=vmware,dc=com"
  }, {
    "name" : "common-name",
    "value" : "userPrincipalName"
  }, {
    "name" : "port",
    "value" : "636"
  }, {
    "name" : "group-search-criteria",
    "value" : "(|(objectClass=group)(objectClass=groupOfNames))"
  }, {
    "name" : "member-attribute",
    "value" : "member"
  }, {
    "name" : "user-search-criteria",
    "value" : ""
  }, {
    "name" : "member-match-field",
    "value" : ""
  }, {
    "name" : "ldap-context-attributes",
    "value" : ""
  } ],
  "certificates" : [ ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
sourceId id of the authSource template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:auth-source/>

GET /api/auth/sources

Lists all the available auth sources in the system.

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:auth-sources xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:auth-source lastModified="0" created="0">
        <ops:id>dc01ad43-3c82-40c6-9f8a-0f4fb9a4260e</ops:id>
        <ops:name>test-dc01ad43-3c82-40c6-9f8a-0f4fb9a4260e</ops:name>
        <ops:sourceType id="VC">
            <ops:name>VC</ops:name>
            <ops:description>xyzabcedefs</ops:description>
        </ops:sourceType>
    </ops:auth-source>
    <ops:auth-source lastModified="0" created="0">
        <ops:id>da0ee2a3-3f38-425b-b270-5bcf6effd8a6</ops:id>
        <ops:name>test-da0ee2a3-3f38-425b-b270-5bcf6effd8a6</ops:name>
        <ops:sourceType id="OPEN_LDAP">
            <ops:name>OPEN_LDAP</ops:name>
            <ops:description>xyzabcedefs</ops:description>
        </ops:sourceType>
    </ops:auth-source>
    <ops:auth-source lastModified="0" created="0">
        <ops:id>30d0703d-cfd1-409e-88ca-23ac8c6d58fa</ops:id>
        <ops:name>test-30d0703d-cfd1-409e-88ca-23ac8c6d58fa</ops:name>
        <ops:sourceType id="ACTIVE_DIRECTORY">
            <ops:name>ACTIVE_DIRECTORY</ops:name>
            <ops:description>xyzabcedefs</ops:description>
        </ops:sourceType>
    </ops:auth-source>
    <ops:auth-source lastModified="0" created="0">
        <ops:id>a14da1c4-8031-4c36-9929-4041e0805d93</ops:id>
        <ops:name>test-a14da1c4-8031-4c36-9929-4041e0805d93</ops:name>
        <ops:sourceType id="OTHER">
            <ops:name>OTHER</ops:name>
            <ops:description>xyzabcedefs</ops:description>
        </ops:sourceType>
    </ops:auth-source>
    <ops:auth-source lastModified="0" created="0">
        <ops:id>f5968224-96bb-45d0-b373-80dc68f57490</ops:id>
        <ops:name>test-f5968224-96bb-45d0-b373-80dc68f57490</ops:name>
        <ops:sourceType id="VC_GROUP">
            <ops:name>VC_GROUP</ops:name>
            <ops:description>xyzabcedefs</ops:description>
        </ops:sourceType>
    </ops:auth-source>
    <ops:auth-source lastModified="0" created="0">
        <ops:id>caed8fb2-7419-4f45-af2d-c17e06c216d6</ops:id>
        <ops:name>test-caed8fb2-7419-4f45-af2d-c17e06c216d6</ops:name>
        <ops:sourceType id="LOCAL">
            <ops:name>LOCAL</ops:name>
            <ops:description>xyzabcedefs</ops:description>
        </ops:sourceType>
    </ops:auth-source>
    <ops:auth-source lastModified="0" created="0">
        <ops:id>57db262b-452c-4ec1-ab7e-fed17167d48a</ops:id>
        <ops:name>test-57db262b-452c-4ec1-ab7e-fed17167d48a</ops:name>
        <ops:sourceType id="SSO_SAML">
            <ops:name>SSO_SAML</ops:name>
            <ops:description>xyzabcedefs</ops:description>
        </ops:sourceType>
    </ops:auth-source>
    <ops:auth-source lastModified="0" created="0">
        <ops:id>93aed118-e6b5-45a3-b8dd-b096aee2be3f</ops:id>
        <ops:name>test-93aed118-e6b5-45a3-b8dd-b096aee2be3f</ops:name>
        <ops:sourceType id="VIDM">
            <ops:name>VIDM</ops:name>
            <ops:description>xyzabcedefs</ops:description>
        </ops:sourceType>
    </ops:auth-source>
</ops:auth-sources>
Sample Response in JSON format
Show
{
  "sources" : [ {
    "id" : "a09d5afb-afbc-415b-a0dc-5dcea8dca5e8",
    "name" : "test-a09d5afb-afbc-415b-a0dc-5dcea8dca5e8",
    "sourceType" : {
      "id" : "VC",
      "name" : "VC",
      "description" : "xyzabcedefs",
      "links" : null,
      "properties" : null
    },
    "created" : 0,
    "lastModified" : 0,
    "links" : null,
    "property" : [ ],
    "certificates" : [ ]
  }, {
    "id" : "04162113-a479-4814-a35c-01af2b698d8e",
    "name" : "test-04162113-a479-4814-a35c-01af2b698d8e",
    "sourceType" : {
      "id" : "OPEN_LDAP",
      "name" : "OPEN_LDAP",
      "description" : "xyzabcedefs",
      "links" : null,
      "properties" : null
    },
    "created" : 0,
    "lastModified" : 0,
    "links" : null,
    "property" : [ ],
    "certificates" : [ ]
  }, {
    "id" : "e8e675b8-2c1c-42ff-a93b-60b24d9aca8a",
    "name" : "test-e8e675b8-2c1c-42ff-a93b-60b24d9aca8a",
    "sourceType" : {
      "id" : "ACTIVE_DIRECTORY",
      "name" : "ACTIVE_DIRECTORY",
      "description" : "xyzabcedefs",
      "links" : null,
      "properties" : null
    },
    "created" : 0,
    "lastModified" : 0,
    "links" : null,
    "property" : [ ],
    "certificates" : [ ]
  }, {
    "id" : "59d06cfa-16f2-4efd-b884-a0a69913f404",
    "name" : "test-59d06cfa-16f2-4efd-b884-a0a69913f404",
    "sourceType" : {
      "id" : "OTHER",
      "name" : "OTHER",
      "description" : "xyzabcedefs",
      "links" : null,
      "properties" : null
    },
    "created" : 0,
    "lastModified" : 0,
    "links" : null,
    "property" : [ ],
    "certificates" : [ ]
  }, {
    "id" : "38f259c2-62b0-44f5-8e80-fc75c32c7bbb",
    "name" : "test-38f259c2-62b0-44f5-8e80-fc75c32c7bbb",
    "sourceType" : {
      "id" : "VC_GROUP",
      "name" : "VC_GROUP",
      "description" : "xyzabcedefs",
      "links" : null,
      "properties" : null
    },
    "created" : 0,
    "lastModified" : 0,
    "links" : null,
    "property" : [ ],
    "certificates" : [ ]
  }, {
    "id" : "6062b98d-0dfc-4fd0-9afc-c873c53b31af",
    "name" : "test-6062b98d-0dfc-4fd0-9afc-c873c53b31af",
    "sourceType" : {
      "id" : "LOCAL",
      "name" : "LOCAL",
      "description" : "xyzabcedefs",
      "links" : null,
      "properties" : null
    },
    "created" : 0,
    "lastModified" : 0,
    "links" : null,
    "property" : [ ],
    "certificates" : [ ]
  }, {
    "id" : "9d90c729-95b9-4ff5-9451-f62a3cb9f917",
    "name" : "test-9d90c729-95b9-4ff5-9451-f62a3cb9f917",
    "sourceType" : {
      "id" : "SSO_SAML",
      "name" : "SSO_SAML",
      "description" : "xyzabcedefs",
      "links" : null,
      "properties" : null
    },
    "created" : 0,
    "lastModified" : 0,
    "links" : null,
    "property" : [ ],
    "certificates" : [ ]
  }, {
    "id" : "64d06e5d-a198-4b14-8d93-f820e1498bdb",
    "name" : "test-64d06e5d-a198-4b14-8d93-f820e1498bdb",
    "sourceType" : {
      "id" : "VIDM",
      "name" : "VIDM",
      "description" : "xyzabcedefs",
      "links" : null,
      "properties" : null
    },
    "created" : 0,
    "lastModified" : 0,
    "links" : null,
    "property" : [ ],
    "certificates" : [ ]
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:auth-sources/>

GET /api/auth/sourcetypes/{sourceId}

Retrieve information about a particular authentication source type..

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
sourceId identifier of the source type. template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:auth-sourcetype/>

GET /api/auth/sourcetypes

Lists all the available authentication source types..

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:auth-sourcetypes xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:auth-sourcetype id="VC">
        <ops:name>VC</ops:name>
        <ops:description>xyzabcedefs</ops:description>
    </ops:auth-sourcetype>
    <ops:auth-sourcetype id="OPEN_LDAP">
        <ops:name>OPEN_LDAP</ops:name>
        <ops:description>xyzabcedefs</ops:description>
    </ops:auth-sourcetype>
    <ops:auth-sourcetype id="ACTIVE_DIRECTORY">
        <ops:name>ACTIVE_DIRECTORY</ops:name>
        <ops:description>xyzabcedefs</ops:description>
    </ops:auth-sourcetype>
    <ops:auth-sourcetype id="OTHER">
        <ops:name>OTHER</ops:name>
        <ops:description>xyzabcedefs</ops:description>
    </ops:auth-sourcetype>
    <ops:auth-sourcetype id="VC_GROUP">
        <ops:name>VC_GROUP</ops:name>
        <ops:description>xyzabcedefs</ops:description>
    </ops:auth-sourcetype>
    <ops:auth-sourcetype id="LOCAL">
        <ops:name>LOCAL</ops:name>
        <ops:description>xyzabcedefs</ops:description>
    </ops:auth-sourcetype>
    <ops:auth-sourcetype id="SSO_SAML">
        <ops:name>SSO_SAML</ops:name>
        <ops:description>xyzabcedefs</ops:description>
    </ops:auth-sourcetype>
    <ops:auth-sourcetype id="VIDM">
        <ops:name>VIDM</ops:name>
        <ops:description>xyzabcedefs</ops:description>
    </ops:auth-sourcetype>
</ops:auth-sourcetypes>
Sample Response in JSON format
Show
{
  "sourceTypes" : [ {
    "id" : "VC",
    "name" : "VC",
    "description" : "xyzabcedefs",
    "links" : null,
    "properties" : null
  }, {
    "id" : "OPEN_LDAP",
    "name" : "OPEN_LDAP",
    "description" : "xyzabcedefs",
    "links" : null,
    "properties" : null
  }, {
    "id" : "ACTIVE_DIRECTORY",
    "name" : "ACTIVE_DIRECTORY",
    "description" : "xyzabcedefs",
    "links" : null,
    "properties" : null
  }, {
    "id" : "OTHER",
    "name" : "OTHER",
    "description" : "xyzabcedefs",
    "links" : null,
    "properties" : null
  }, {
    "id" : "VC_GROUP",
    "name" : "VC_GROUP",
    "description" : "xyzabcedefs",
    "links" : null,
    "properties" : null
  }, {
    "id" : "LOCAL",
    "name" : "LOCAL",
    "description" : "xyzabcedefs",
    "links" : null,
    "properties" : null
  }, {
    "id" : "SSO_SAML",
    "name" : "SSO_SAML",
    "description" : "xyzabcedefs",
    "links" : null,
    "properties" : null
  }, {
    "id" : "VIDM",
    "name" : "VIDM",
    "description" : "xyzabcedefs",
    "links" : null,
    "properties" : null
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:auth-sourcetypes/>

GET /api/auth/privilegegroups

Get the available privilege groups.

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:privilege-groups xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:privilege-group key="PowerUses">
        <ops:name>Power Users</ops:name>
        <ops:description>Users with elevated but not adminitrator privileges</ops:description>
    </ops:privilege-group>
</ops:privilege-groups>
Sample Response in JSON format
Show
{
  "privilegeGroups" : [ {
    "key" : "PowerUses",
    "name" : "Power Users",
    "description" : "Users with elevated but not adminitrator privileges",
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
key the key of the privilege group to get, null or empty to return all query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:privilege-groups/>

GET /api/auth/privileges

Get the available privileges..

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:privileges xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:privilege key="ManageAlerts">
        <ops:name>Manage Alerts</ops:name>
        <ops:description>Manage and view Alerts in the system</ops:description>
    </ops:privilege>
    <ops:privilege key="ManageAlarms">
        <ops:name>Manage Alarms</ops:name>
        <ops:description>Manage and view Alarms in the system</ops:description>
    </ops:privilege>
</ops:privileges>
Sample Response in JSON format
Show
{
  "privileges" : [ {
    "key" : "ManageAlerts",
    "name" : "Manage Alerts",
    "description" : "Manage and view Alerts in the system",
    "links" : null
  }, {
    "key" : "ManageAlarms",
    "name" : "Manage Alarms",
    "description" : "Manage and view Alarms in the system",
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
key the key of the privilege to get, null or empty to return all query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:privileges/>

GET /api/auth/roles/{roleName}

Look up a role with the given roleName..

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
roleName name of the role template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:user-role/>

GET /api/auth/roles/{roleName}/privileges

Get the privileges for a user role..

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:privileges xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:privilege key="ManageAlerts">
        <ops:name>Manage Alerts</ops:name>
        <ops:description>Manage and view Alerts in the system</ops:description>
    </ops:privilege>
    <ops:privilege key="ManageAlarms">
        <ops:name>Manage Alarms</ops:name>
        <ops:description>Manage and view Alarms in the system</ops:description>
    </ops:privilege>
</ops:privileges>
Sample Response in JSON format
Show
{
  "privileges" : [ {
    "key" : "ManageAlerts",
    "name" : "Manage Alerts",
    "description" : "Manage and view Alerts in the system",
    "links" : null
  }, {
    "key" : "ManageAlarms",
    "name" : "Manage Alarms",
    "description" : "Manage and view Alarms in the system",
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
roleName name of the role template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:privileges/>

GET /api/auth/roles

Query for a list of application roles using the role names..

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
roleName list of valid role names query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:user-roles/>

GET /api/auth/traversalspecs

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

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
adapterKind type of adapter query xs:string no yes
resourceKind type of resource query xs:string no yes
name name of the traversal spec. query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:traversal-specs/>

GET /api/auth/users/{id}

Look up a particular user using her identifier. Using this method, you can look up details about a particular local user

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id identifier of the user. template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:user/>

GET /api/auth/usergroups/{id}

Look up a local user group using its identifier..

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id identifier of the user group template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:user-group/>

GET /api/auth/usergroups

Retrieve a list of local user groups using identifiers or names or all.. If none of the parameters are specified, all the user groups in the system are returned.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id identifiers of the local user groups. query xs:uuid no yes
name the names of the local user groups query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:user-groups/>

GET /api/auth/users

Look up a list of users using the user identifiers or their role names.. If both ids and roleNames are not specified, information about all the local users are returned.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id list of identifiers in UUID format query xs:uuid no yes
roleName list of valid role names. query xs:string no yes
username list of usernames that is used for partial and complete matching. query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:user-list/>

POST /api/auth/sources/{id}/users

import users from auth source. Auth source can be SSO/LDAP/AD.
When a user is being re-imported, make sure to populate the "id" field of the user. Sample Request in XML/JSON:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:user-list xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:user enabled="false">
        <ops:username>alexr</ops:username>
        <ops:firstName>alex</ops:firstName>
        <ops:lastName>richard</ops:lastName>
        <ops:password xsi:nil="true"/>
        <ops:emailAddress>[email protected]</ops:emailAddress>
        <ops:distinguishedName>CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=vmware,DC=com</ops:distinguishedName>
        <ops:roleNames>
            <ops:roleName>Administrator</ops:roleName>
        </ops:roleNames>
        <ops:role-permissions>
            <ops:role-permission allowAllObjects="true">
                <ops:roleName>Administrator</ops:roleName>
                <ops:traversal-spec-instances>
                    <ops:traversal-spec-instance selectAllResources="true">
                        <ops:adapterKind>adap_kind</ops:adapterKind>
                        <ops:resourceKind>resource_kind</ops:resourceKind>
                        <ops:name>traversal_spec_name</ops:name>
                    </ops:traversal-spec-instance>
                </ops:traversal-spec-instances>
            </ops:role-permission>
        </ops:role-permissions>
    </ops:user>
    <ops:user enabled="false">
        <ops:username>bobw</ops:username>
        <ops:firstName>bob</ops:firstName>
        <ops:lastName>williams</ops:lastName>
        <ops:password xsi:nil="true"/>
        <ops:emailAddress>[email protected]</ops:emailAddress>
        <ops:distinguishedName>CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=vmware,DC=com</ops:distinguishedName>
        <ops:roleNames>
            <ops:roleName>Administrator</ops:roleName>
        </ops:roleNames>
        <ops:role-permissions>
            <ops:role-permission allowAllObjects="true">
                <ops:roleName>Administrator</ops:roleName>
                <ops:traversal-spec-instances>
                    <ops:traversal-spec-instance selectAllResources="true">
                        <ops:adapterKind>adap_kind</ops:adapterKind>
                        <ops:resourceKind>resource_kind</ops:resourceKind>
                        <ops:name>traversal_spec_name</ops:name>
                    </ops:traversal-spec-instance>
                </ops:traversal-spec-instances>
            </ops:role-permission>
        </ops:role-permissions>
    </ops:user>
</ops:user-list>
{
  "users" : [ {
    "id" : null,
    "username" : "alexr",
    "firstName" : "alex",
    "lastName" : "richard",
    "password" : null,
    "emailAddress" : "[email protected]",
    "distinguishedName" : "CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=vmware,DC=com",
    "enabled" : false,
    "groupIds" : null,
    "roleName" : [ "Administrator" ],
    "rolePermissions" : [ {
      "roleName" : "Administrator",
      "traversalSpecInstances" : [ {
        "adapterKind" : "adap_kind",
        "resourceKind" : "resource_kind",
        "name" : "traversal_spec_name",
        "resourceSelection" : null,
        "selectAllResources" : true,
        "includedAdapterKinds" : null
      } ],
      "allowAllObjects" : true,
      "links" : null
    } ],
    "links" : null
  }, {
    "id" : null,
    "username" : "bobw",
    "firstName" : "bob",
    "lastName" : "williams",
    "password" : null,
    "emailAddress" : "[email protected]",
    "distinguishedName" : "CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=vmware,DC=com",
    "enabled" : false,
    "groupIds" : null,
    "roleName" : [ "Administrator" ],
    "rolePermissions" : [ {
      "roleName" : "Administrator",
      "traversalSpecInstances" : [ {
        "adapterKind" : "adap_kind",
        "resourceKind" : "resource_kind",
        "name" : "traversal_spec_name",
        "resourceSelection" : null,
        "selectAllResources" : true,
        "includedAdapterKinds" : null
      } ],
      "allowAllObjects" : true,
      "links" : null
    } ],
    "links" : null
  } ]
}
Sample Response in XML/JSON:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:user-list xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:user enabled="false">
        <ops:id>488acdc6-06c9-4a3f-b848-20f70612f2f1</ops:id>
        <ops:username>alexr</ops:username>
        <ops:firstName>alex</ops:firstName>
        <ops:lastName>richard</ops:lastName>
        <ops:password xsi:nil="true"/>
        <ops:emailAddress>[email protected]</ops:emailAddress>
        <ops:distinguishedName>CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=vmware,DC=com</ops:distinguishedName>
        <ops:roleNames>
            <ops:roleName>Administrator</ops:roleName>
        </ops:roleNames>
        <ops:role-permissions>
            <ops:role-permission allowAllObjects="true">
                <ops:roleName>Administrator</ops:roleName>
                <ops:traversal-spec-instances>
                    <ops:traversal-spec-instance selectAllResources="true">
                        <ops:adapterKind>adap_kind</ops:adapterKind>
                        <ops:resourceKind>resource_kind</ops:resourceKind>
                        <ops:name>traversal_spec_name</ops:name>
                    </ops:traversal-spec-instance>
                </ops:traversal-spec-instances>
            </ops:role-permission>
        </ops:role-permissions>
    </ops:user>
    <ops:user enabled="false">
        <ops:id>df0a1cac-075d-4f35-ae93-4d642c8dafd9</ops:id>
        <ops:username>bobw</ops:username>
        <ops:firstName>bob</ops:firstName>
        <ops:lastName>williams</ops:lastName>
        <ops:password xsi:nil="true"/>
        <ops:emailAddress>[email protected]</ops:emailAddress>
        <ops:distinguishedName>CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=vmware,DC=com</ops:distinguishedName>
        <ops:roleNames>
            <ops:roleName>Administrator</ops:roleName>
        </ops:roleNames>
        <ops:role-permissions>
            <ops:role-permission allowAllObjects="true">
                <ops:roleName>Administrator</ops:roleName>
                <ops:traversal-spec-instances>
                    <ops:traversal-spec-instance selectAllResources="true">
                        <ops:adapterKind>adap_kind</ops:adapterKind>
                        <ops:resourceKind>resource_kind</ops:resourceKind>
                        <ops:name>traversal_spec_name</ops:name>
                    </ops:traversal-spec-instance>
                </ops:traversal-spec-instances>
            </ops:role-permission>
        </ops:role-permissions>
    </ops:user>
</ops:user-list>
{
  "users" : [ {
    "id" : "eef79f21-cf22-47b1-9d7a-478089b80478",
    "username" : "alexr",
    "firstName" : "alex",
    "lastName" : "richard",
    "password" : null,
    "emailAddress" : "[email protected]",
    "distinguishedName" : "CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=vmware,DC=com",
    "enabled" : false,
    "groupIds" : null,
    "roleName" : [ "Administrator" ],
    "rolePermissions" : [ {
      "roleName" : "Administrator",
      "traversalSpecInstances" : [ {
        "adapterKind" : "adap_kind",
        "resourceKind" : "resource_kind",
        "name" : "traversal_spec_name",
        "resourceSelection" : null,
        "selectAllResources" : true,
        "includedAdapterKinds" : null
      } ],
      "allowAllObjects" : true,
      "links" : null
    } ],
    "links" : null
  }, {
    "id" : "44f0710e-94da-482c-97e1-e10cdf0087d1",
    "username" : "bobw",
    "firstName" : "bob",
    "lastName" : "williams",
    "password" : null,
    "emailAddress" : "[email protected]",
    "distinguishedName" : "CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=vmware,DC=com",
    "enabled" : false,
    "groupIds" : null,
    "roleName" : [ "Administrator" ],
    "rolePermissions" : [ {
      "roleName" : "Administrator",
      "traversalSpecInstances" : [ {
        "adapterKind" : "adap_kind",
        "resourceKind" : "resource_kind",
        "name" : "traversal_spec_name",
        "resourceSelection" : null,
        "selectAllResources" : true,
        "includedAdapterKinds" : null
      } ],
      "allowAllObjects" : true,
      "links" : null
    } ],
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
<ns3:user-list/>

PUT /api/auth/users

Modify the details of a particular user..

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:user/>

PUT /api/auth/usergroups

Modify a local user group.. You can add or remove users from the group. Name and id of the group cannot be changed.

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

PATCH /api/auth/sources

Patch an already added authentication source with the certificate data.

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:auth-source lastModified="1523035908123" created="1523035908123" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>00000000-0000-000a-0000-000000000014</ops:id>
    <ops:name>TEST</ops:name>
    <ops:sourceType id="ACTIVE_DIRECTORY">
        <ops:name>ACTIVE_DIRECTORY</ops:name>
        <ops:description>DESC</ops:description>
    </ops:sourceType>
    <ops:name-value name="display-name">Test_11</ops:name-value>
    <ops:name-value name="host">brlrootdc01.vmware.com</ops:name-value>
    <ops:name-value name="use-ssl">true</ops:name-value>
    <ops:name-value name="base-domain">dc=vmware,dc=com</ops:name-value>
    <ops:name-value name="user-name">[email protected]</ops:name-value>
    <ops:name-value name="password">password</ops:name-value>
    <ops:name-value name="base-domain">dc=vmware,dc=com</ops:name-value>
    <ops:name-value name="common-name">userPrincipalName</ops:name-value>
    <ops:name-value name="port">636</ops:name-value>
    <ops:name-value name="group-search-criteria">(|(objectClass=group)(objectClass=groupOfNames))</ops:name-value>
    <ops:name-value name="member-attribute">member</ops:name-value>
    <ops:name-value name="user-search-criteria"></ops:name-value>
    <ops:name-value name="member-match-field"></ops:name-value>
    <ops:name-value name="ldap-context-attributes"></ops:name-value>
    <ops:certificates>
        <ops:thumbprint>1@34343453dfr#@gsrakgb454</ops:thumbprint>
        <ops:certificateDetails>CERT_DETAILS</ops:certificateDetails>
    </ops:certificates>
</ops:auth-source>
Sample Response in XML format
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:auth-source lastModified="1523035908144" created="1523035908144" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>00000000-0000-000a-0000-000000000014</ops:id>
    <ops:name>TEST</ops:name>
    <ops:sourceType id="ACTIVE_DIRECTORY">
        <ops:name>ACTIVE_DIRECTORY</ops:name>
        <ops:description>DESC</ops:description>
    </ops:sourceType>
    <ops:name-value name="display-name">Test_11</ops:name-value>
    <ops:name-value name="host">brlrootdc01.vmware.com</ops:name-value>
    <ops:name-value name="use-ssl">true</ops:name-value>
    <ops:name-value name="base-domain">dc=vmware,dc=com</ops:name-value>
    <ops:name-value name="user-name">[email protected]</ops:name-value>
    <ops:name-value name="password">password</ops:name-value>
    <ops:name-value name="base-domain">dc=vmware,dc=com</ops:name-value>
    <ops:name-value name="common-name">userPrincipalName</ops:name-value>
    <ops:name-value name="port">636</ops:name-value>
    <ops:name-value name="group-search-criteria">(|(objectClass=group)(objectClass=groupOfNames))</ops:name-value>
    <ops:name-value name="member-attribute">member</ops:name-value>
    <ops:name-value name="user-search-criteria"></ops:name-value>
    <ops:name-value name="member-match-field"></ops:name-value>
    <ops:name-value name="ldap-context-attributes"></ops:name-value>
</ops:auth-source>
Sample Request in JSON format
Show
{
  "id" : "00000000-0000-000a-0000-000000000014",
  "name" : "TEST",
  "sourceType" : {
    "id" : "ACTIVE_DIRECTORY",
    "name" : "ACTIVE_DIRECTORY",
    "description" : "DESC",
    "links" : null,
    "properties" : null
  },
  "created" : 1523035908162,
  "lastModified" : 1523035908162,
  "links" : null,
  "property" : [ {
    "name" : "display-name",
    "value" : "Test_11"
  }, {
    "name" : "host",
    "value" : "brlrootdc01.vmware.com"
  }, {
    "name" : "use-ssl",
    "value" : "true"
  }, {
    "name" : "base-domain",
    "value" : "dc=vmware,dc=com"
  }, {
    "name" : "user-name",
    "value" : "[email protected]"
  }, {
    "name" : "password",
    "value" : "password"
  }, {
    "name" : "base-domain",
    "value" : "dc=vmware,dc=com"
  }, {
    "name" : "common-name",
    "value" : "userPrincipalName"
  }, {
    "name" : "port",
    "value" : "636"
  }, {
    "name" : "group-search-criteria",
    "value" : "(|(objectClass=group)(objectClass=groupOfNames))"
  }, {
    "name" : "member-attribute",
    "value" : "member"
  }, {
    "name" : "user-search-criteria",
    "value" : ""
  }, {
    "name" : "member-match-field",
    "value" : ""
  }, {
    "name" : "ldap-context-attributes",
    "value" : ""
  } ],
  "certificates" : [ {
    "thumbprint" : "1@34343453dfr#@gsrakgb454",
    "certificateDetails" : "CERT_DETAILS"
  } ]
}
Sample Response in JSON format
Show
{
  "id" : "00000000-0000-000a-0000-000000000014",
  "name" : "TEST",
  "sourceType" : {
    "id" : "ACTIVE_DIRECTORY",
    "name" : "ACTIVE_DIRECTORY",
    "description" : "DESC",
    "links" : null,
    "properties" : null
  },
  "created" : 1523035908163,
  "lastModified" : 1523035908163,
  "links" : null,
  "property" : [ {
    "name" : "display-name",
    "value" : "Test_11"
  }, {
    "name" : "host",
    "value" : "brlrootdc01.vmware.com"
  }, {
    "name" : "use-ssl",
    "value" : "true"
  }, {
    "name" : "base-domain",
    "value" : "dc=vmware,dc=com"
  }, {
    "name" : "user-name",
    "value" : "[email protected]"
  }, {
    "name" : "password",
    "value" : "password"
  }, {
    "name" : "base-domain",
    "value" : "dc=vmware,dc=com"
  }, {
    "name" : "common-name",
    "value" : "userPrincipalName"
  }, {
    "name" : "port",
    "value" : "636"
  }, {
    "name" : "group-search-criteria",
    "value" : "(|(objectClass=group)(objectClass=groupOfNames))"
  }, {
    "name" : "member-attribute",
    "value" : "member"
  }, {
    "name" : "user-search-criteria",
    "value" : ""
  }, {
    "name" : "member-match-field",
    "value" : ""
  }, {
    "name" : "ldap-context-attributes",
    "value" : ""
  } ],
  "certificates" : [ ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
<ns3:auth-source/>

POST /api/auth/token/release

Call this URL to terminate the current sessionId.

Request description about parameters and structure of input data

This method does not take any request parameters.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

DELETE /api/auth/roles/{roleName}/privileges

Remove specified privileges from a user role..

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:privilege-keys xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:privilege-key>Power On VM</ops:privilege-key>
    <ops:privilege-key>Power Off VM</ops:privilege-key>
</ops:privilege-keys>
Sample Response in XML format
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:privilege-keys xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:privilege-key>Power On VM</ops:privilege-key>
    <ops:privilege-key>Power Off VM</ops:privilege-key>
</ops:privilege-keys>
Sample Request in JSON format
Show
{
  "privilege-key" : [ "Power On VM", "Power Off VM" ]
}
Sample Response in JSON format
Show
{
  "privilege-key" : [ "Power On VM", "Power Off VM" ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
roleName name of the role template xs:string yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:privilege-keys/>

POST /api/auth/sources/{id}/usergroups/search

search user-groups for an auth source. auth source can be SSO/LDAP/AD. for an LDAP/AD auth source, the request should contain the name of the user. for an SSO auth source, request should contain the name of the user and the sso domain. usergroup name can contain wildcards. Maximum of 25 usergroups are returned for SSO auth source. Sample Request in JSON and XML for LDAP/AD User Group search:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:usergroup-search-request xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>vcadmin*</ops:name>
</ops:usergroup-search-request>
{
  "name" : "vcadmin*",
  "domain" : null
}
Sample Response in JSON and XML for LDAP/AD User Group search:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:usergroup-search-responses xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:usergroup-search-response name="admin-group">
        <ops:distinguishedName>CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=vmware,DC=com</ops:distinguishedName>
        <ops:description>admin people</ops:description>
    </ops:usergroup-search-response>
    <ops:usergroup-search-response name="read-only-group">
        <ops:distinguishedName>CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=vmware,DC=com</ops:distinguishedName>
        <ops:description>read only access</ops:description>
    </ops:usergroup-search-response>
</ops:usergroup-search-responses>
{
  "usergroup-search-response" : [ {
    "name" : "admin-group",
    "distinguishedName" : "CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=vmware,DC=com",
    "description" : "admin people"
  }, {
    "name" : "read-only-group",
    "distinguishedName" : "CN=USER,OU=PAO_Users,OU=PaloAlto_California_USA,OU=NALA,OU=SITES,OU=Engineering,DC=vmware,DC=com",
    "description" : "read only access"
  } ]
}
Sample Request in JSON and XML for SSO User Group search:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:usergroup-search-request xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>vcadmin*</ops:name>
    <ops:domain>cat.local</ops:domain>
</ops:usergroup-search-request>
{
  "name" : "vcadmin*",
  "domain" : "cat.local"
}
Sample Response in JSON and XML for SSO User Group search:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:usergroup-search-responses xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:usergroup-search-response name="admin-group"/>
    <ops:usergroup-search-response name="read-only-group"/>
</ops:usergroup-search-responses>
{
  "usergroup-search-response" : [ {
    "name" : "admin-group",
    "distinguishedName" : null,
    "description" : null
  }, {
    "name" : "read-only-group",
    "distinguishedName" : null,
    "description" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:usergroup-search-responses/>

POST /api/auth/sources/{id}/users/search

search users for an auth source. auth source can be SSO/LDAP/AD. for an LDAP/AD auth source, the request should contain the name of the user. for an SSO auth source, request should contain the name of the user and the sso domain. user name can contain wildcards. Maximum of 25 users are returned for SSO auth source. Sample Request in JSON and XML for LDAP/AD User search:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:user-search-request xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>vcadmin*</ops:name>
</ops:user-search-request>
{
  "name" : "vcadmin*",
  "domain" : null
}
Sample Response in JSON and XML for LDAP/AD User search:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:user-search-responses xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:user-search-response name="vcadmin-1">
        <ops:firstName>alex</ops:firstName>
        <ops:lastName>richard</ops:lastName>
        <ops:distinguishedName></ops:distinguishedName>
        <ops:emailAddress>[email protected]</ops:emailAddress>
    </ops:user-search-response>
    <ops:user-search-response name="vcadmin-2">
        <ops:firstName>bob</ops:firstName>
        <ops:lastName>watson</ops:lastName>
        <ops:distinguishedName></ops:distinguishedName>
        <ops:emailAddress>[email protected]</ops:emailAddress>
    </ops:user-search-response>
</ops:user-search-responses>
{
  "user-search-response" : [ {
    "name" : "vcadmin-1",
    "firstName" : "alex",
    "lastName" : "richard",
    "distinguishedName" : "",
    "emailAddress" : "[email protected]"
  }, {
    "name" : "vcadmin-2",
    "firstName" : "bob",
    "lastName" : "watson",
    "distinguishedName" : "",
    "emailAddress" : "[email protected]"
  } ]
}
Sample Request in JSON and XML for SSO User search:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:user-search-request xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>vcadmin*</ops:name>
    <ops:domain>cat.local</ops:domain>
</ops:user-search-request>
{
  "name" : "vcadmin*",
  "domain" : "cat.local"
}
Sample Response in JSON and XML for SSO User search:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:user-search-responses xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:user-search-response name="vcadmin-1"/>
    <ops:user-search-response name="vcadmin-2"/>
</ops:user-search-responses>
{
  "user-search-response" : [ {
    "name" : "vcadmin-1",
    "firstName" : null,
    "lastName" : null,
    "distinguishedName" : null,
    "emailAddress" : null
  }, {
    "name" : "vcadmin-2",
    "firstName" : null,
    "lastName" : null,
    "distinguishedName" : null,
    "emailAddress" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:user-search-responses/>

PUT /api/auth/roles/{roleName}/privileges

Set the privileges for a user role.. Replaces any previous privileges.

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:privilege-keys xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:privilege-key>Power On VM</ops:privilege-key>
    <ops:privilege-key>Power Off VM</ops:privilege-key>
</ops:privilege-keys>
Sample Response in XML format
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:privilege-keys xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:privilege-key>Power On VM</ops:privilege-key>
    <ops:privilege-key>Power Off VM</ops:privilege-key>
</ops:privilege-keys>
Sample Request in JSON format
Show
{
  "privilege-key" : [ "Power On VM", "Power Off VM" ]
}
Sample Response in JSON format
Show
{
  "privilege-key" : [ "Power On VM", "Power Off VM" ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
roleName name of the role template xs:string yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:privilege-keys/>

DELETE /api/auth/users/{userId}/permissions/{roleName}

Unassign role permission from a user..

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
roleName The name of the role of the role permission to unassign template xs:string yes no
userId Identifier of the user to which the role permission needs to be assigned template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

DELETE /api/auth/usergroups/{groupId}/permissions/{roleName}

Unassign role permission from a user group.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
roleName template xs:string yes no
groupId Identifier of the user group to which the role permission needs to be assigned template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

PUT /api/auth/sources

updates an authentication source in the system. if the host is an ldap host and if host/port is changed, then the response will contain a list of certificates found matching with the host. It is the duty of the caller to call the PATCH (/sources) api with the certificate details. Once the PATCH api call is successful, the authentication source is available for use.

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:auth-source lastModified="1523035908045" created="1523035908045" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>00000000-0000-000a-0000-000000000014</ops:id>
    <ops:name>TEST</ops:name>
    <ops:sourceType id="ACTIVE_DIRECTORY">
        <ops:name>ACTIVE_DIRECTORY</ops:name>
        <ops:description>DESC</ops:description>
    </ops:sourceType>
    <ops:name-value name="display-name">Test_11</ops:name-value>
    <ops:name-value name="host">brlrootdc01.vmware.com</ops:name-value>
    <ops:name-value name="use-ssl">true</ops:name-value>
    <ops:name-value name="base-domain">dc=vmware,dc=com</ops:name-value>
    <ops:name-value name="user-name">[email protected]</ops:name-value>
    <ops:name-value name="password">password</ops:name-value>
    <ops:name-value name="base-domain">dc=vmware,dc=com</ops:name-value>
    <ops:name-value name="common-name">userPrincipalName</ops:name-value>
    <ops:name-value name="port">636</ops:name-value>
    <ops:name-value name="group-search-criteria">(|(objectClass=group)(objectClass=groupOfNames))</ops:name-value>
    <ops:name-value name="member-attribute">member</ops:name-value>
    <ops:name-value name="user-search-criteria"></ops:name-value>
    <ops:name-value name="member-match-field"></ops:name-value>
    <ops:name-value name="ldap-context-attributes"></ops:name-value>
</ops:auth-source>
Sample Response in XML format
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:auth-source lastModified="1523035908063" created="1523035908063" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>00000000-0000-000a-0000-000000000014</ops:id>
    <ops:name>TEST</ops:name>
    <ops:sourceType id="ACTIVE_DIRECTORY">
        <ops:name>ACTIVE_DIRECTORY</ops:name>
        <ops:description>DESC</ops:description>
    </ops:sourceType>
    <ops:name-value name="display-name">Test_11</ops:name-value>
    <ops:name-value name="host">brlrootdc01.vmware.com</ops:name-value>
    <ops:name-value name="use-ssl">true</ops:name-value>
    <ops:name-value name="base-domain">dc=vmware,dc=com</ops:name-value>
    <ops:name-value name="user-name">[email protected]</ops:name-value>
    <ops:name-value name="password">password</ops:name-value>
    <ops:name-value name="base-domain">dc=vmware,dc=com</ops:name-value>
    <ops:name-value name="common-name">userPrincipalName</ops:name-value>
    <ops:name-value name="port">636</ops:name-value>
    <ops:name-value name="group-search-criteria">(|(objectClass=group)(objectClass=groupOfNames))</ops:name-value>
    <ops:name-value name="member-attribute">member</ops:name-value>
    <ops:name-value name="user-search-criteria"></ops:name-value>
    <ops:name-value name="member-match-field"></ops:name-value>
    <ops:name-value name="ldap-context-attributes"></ops:name-value>
    <ops:certificates>
        <ops:thumbprint>1@34343453dfr#@gsrakgb454</ops:thumbprint>
        <ops:certificateDetails>CERT_DETAILS</ops:certificateDetails>
    </ops:certificates>
</ops:auth-source>
Sample Request in JSON format
Show
{
  "id" : "00000000-0000-000a-0000-000000000014",
  "name" : "TEST",
  "sourceType" : {
    "id" : "ACTIVE_DIRECTORY",
    "name" : "ACTIVE_DIRECTORY",
    "description" : "DESC",
    "links" : null,
    "properties" : null
  },
  "created" : 1523035908082,
  "lastModified" : 1523035908082,
  "links" : null,
  "property" : [ {
    "name" : "display-name",
    "value" : "Test_11"
  }, {
    "name" : "host",
    "value" : "brlrootdc01.vmware.com"
  }, {
    "name" : "use-ssl",
    "value" : "true"
  }, {
    "name" : "base-domain",
    "value" : "dc=vmware,dc=com"
  }, {
    "name" : "user-name",
    "value" : "[email protected]"
  }, {
    "name" : "password",
    "value" : "password"
  }, {
    "name" : "base-domain",
    "value" : "dc=vmware,dc=com"
  }, {
    "name" : "common-name",
    "value" : "userPrincipalName"
  }, {
    "name" : "port",
    "value" : "636"
  }, {
    "name" : "group-search-criteria",
    "value" : "(|(objectClass=group)(objectClass=groupOfNames))"
  }, {
    "name" : "member-attribute",
    "value" : "member"
  }, {
    "name" : "user-search-criteria",
    "value" : ""
  }, {
    "name" : "member-match-field",
    "value" : ""
  }, {
    "name" : "ldap-context-attributes",
    "value" : ""
  } ],
  "certificates" : [ ]
}
Sample Response in JSON format
Show
{
  "id" : "00000000-0000-000a-0000-000000000014",
  "name" : "TEST",
  "sourceType" : {
    "id" : "ACTIVE_DIRECTORY",
    "name" : "ACTIVE_DIRECTORY",
    "description" : "DESC",
    "links" : null,
    "properties" : null
  },
  "created" : 1523035908082,
  "lastModified" : 1523035908082,
  "links" : null,
  "property" : [ {
    "name" : "display-name",
    "value" : "Test_11"
  }, {
    "name" : "host",
    "value" : "brlrootdc01.vmware.com"
  }, {
    "name" : "use-ssl",
    "value" : "true"
  }, {
    "name" : "base-domain",
    "value" : "dc=vmware,dc=com"
  }, {
    "name" : "user-name",
    "value" : "[email protected]"
  }, {
    "name" : "password",
    "value" : "password"
  }, {
    "name" : "base-domain",
    "value" : "dc=vmware,dc=com"
  }, {
    "name" : "common-name",
    "value" : "userPrincipalName"
  }, {
    "name" : "port",
    "value" : "636"
  }, {
    "name" : "group-search-criteria",
    "value" : "(|(objectClass=group)(objectClass=groupOfNames))"
  }, {
    "name" : "member-attribute",
    "value" : "member"
  }, {
    "name" : "user-search-criteria",
    "value" : ""
  }, {
    "name" : "member-match-field",
    "value" : ""
  }, {
    "name" : "ldap-context-attributes",
    "value" : ""
  } ],
  "certificates" : [ {
    "thumbprint" : "1@34343453dfr#@gsrakgb454",
    "certificateDetails" : "CERT_DETAILS"
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:auth-source/>

PUT /api/auth/roles

Update a user role.. Name of the role cannot be changed.

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:user-role system-created="false" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>API Administrator</ops:name>
    <ops:description>Role to allow administrative access to all Suite API methods</ops:description>
    <ops:privilege-keys>
        <ops:privilege-key>ManageAlerts</ops:privilege-key>
        <ops:privilege-key>ManageAlarms</ops:privilege-key>
        <ops:privilege-key>ManageNotificationPlugins</ops:privilege-key>
    </ops:privilege-keys>
</ops:user-role>
Sample Request in JSON format
Show
{
  "name" : "API Administrator",
  "description" : "Role to allow administrative access to all Suite API methods",
  "displayName" : null,
  "privilege-key" : [ "ManageAlerts", "ManageAlarms", "ManageNotificationPlugins" ],
  "system-created" : false,
  "links" : null
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:user-role/>

PUT /api/collectorgroups/{id}/collector/{collectorId}

Adds a Collector to Collector Group..

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:collector-group name="collector_group_1" id="eebcc74c-4474-41f9-ac71-00d4d7230fc0" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:description>collector_group_1 description</ops:description>
    <ops:collectorId>3 4</ops:collectorId>
    <ops:systemDefined>false</ops:systemDefined>
</ops:collector-group>
Sample Response in JSON format
Show
{
  "id" : "493c1ef5-29d0-4dd3-8eb0-428f17c4ba53",
  "name" : "collector_group_1",
  "description" : "collector_group_1 description",
  "collectorId" : [ 3, 4 ],
  "systemDefined" : false,
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
collectorId Identifier of the Collector to add template xs:int yes no
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 500
Descriptions
200 - If the Collector was successfully added to the Collector Group
500 - In case of any error adding the Collector to the Collector Group
Response type
<ns3:collector-group/>

POST /api/collectorgroups

Creates a Collector Group in the System..

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:collector-group name="collector_group_1" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:description>collector_group_1 description</ops:description>
    <ops:collectorId>3 4</ops:collectorId>
    <ops:systemDefined>false</ops:systemDefined>
</ops:collector-group>
Sample Response in XML format
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:collector-group name="collector_group_1" id="1d150bcf-7634-4767-a6b2-8a09eb36ab4b" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:description>collector_group_1 description</ops:description>
    <ops:collectorId>3 4</ops:collectorId>
    <ops:systemDefined>false</ops:systemDefined>
</ops:collector-group>
Sample Request in JSON format
Show
{
  "id" : null,
  "name" : "collector_group_1",
  "description" : "collector_group_1 description",
  "collectorId" : [ 3, 4 ],
  "systemDefined" : false,
  "links" : null
}
Sample Response in JSON format
Show
{
  "id" : "390051fe-89a5-4f45-841c-d7c8771b935a",
  "name" : "collector_group_1",
  "description" : "collector_group_1 description",
  "collectorId" : [ 3, 4 ],
  "systemDefined" : false,
  "links" : null
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201, 500
Descriptions
201 - If the Collector Group was successfully created in the system
500 - In case of any error creating the Collector Group
Response type
<ns3:collector-group/>

DELETE /api/collectorgroups/{id}

Deletes a Collector Group from the system using its identifier..

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204, 500
Descriptions
204 - If the Collector Group was successfully deleted
500 - In case of any error deleting the Collector Group
Response type
No content returned by this method.

GET /api/collectorgroups/{id}

Gets details of a particular Collector Group in the system..

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:collector-group name="collector_group_1" id="e8bf6f0b-52f4-4ef4-84f9-270aea49dab6" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:description>collector_group_1 description</ops:description>
    <ops:collectorId>3 4</ops:collectorId>
    <ops:systemDefined>false</ops:systemDefined>
</ops:collector-group>
Sample Response in JSON format
Show
{
  "id" : "00fbd002-7d76-40f0-9f8e-2d1e2ce35192",
  "name" : "collector_group_1",
  "description" : "collector_group_1 description",
  "collectorId" : [ 3, 4 ],
  "systemDefined" : false,
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404, 500
Descriptions
200 - When all the Collector Groups defined are returned as part of the API response
404 - If there isn't any Collector Group in the system with the specified identifier
500 - In case of any error processing the API response
Response type
<ns3:collector-group/>

GET /api/collectorgroups

Enumerates all the Collector Groups defined in the system..

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:collector-groups xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:collector-group name="collector_group_1" id="d3803159-25d8-48c7-a4fe-cec56eb76a51">
        <ops:description>collector_group_1 description</ops:description>
        <ops:collectorId>1 2</ops:collectorId>
        <ops:systemDefined>false</ops:systemDefined>
    </ops:collector-group>
</ops:collector-groups>
Sample Response in JSON format
Show
{
  "collectorGroups" : [ {
    "id" : "39060ccb-4252-4683-ae0d-ef0668730d49",
    "name" : "collector_group_1",
    "description" : "collector_group_1 description",
    "collectorId" : [ 1, 2 ],
    "systemDefined" : false,
    "links" : null
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Response http response codes, description about schema of return types

HTTP Response Codes
200, 500
Descriptions
200 - When all the Collector Groups defined are returned as part of the API response
500 - In case of any error processing the API response
Response type
<ns3:collector-groups/>

DELETE /api/collectorgroups/{id}/collector/{collectorId}

Removes a Collector from a Collector Group..

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:collector-group name="collector_group_1" id="2634aad4-6183-46b3-bcb9-42f67c5998fd" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:description>collector_group_1 description</ops:description>
    <ops:collectorId>3 4</ops:collectorId>
    <ops:systemDefined>false</ops:systemDefined>
</ops:collector-group>
Sample Response in JSON format
Show
{
  "id" : "8fecae22-4af2-4936-8d74-9ef89a361e90",
  "name" : "collector_group_1",
  "description" : "collector_group_1 description",
  "collectorId" : [ 3, 4 ],
  "systemDefined" : false,
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
collectorId Identifier of the Collector to add template xs:int yes no
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 500
Descriptions
200 - If the Collector was successfully removed from the Collector Group
500 - In case of any error removing the Collector from the Collector Group
Response type
<ns3:collector-group/>

PUT /api/collectorgroups

Updates a Collector Group in the system. This Replaces all existing configuration of a Collector Group with the data specified as part of the Request..

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:collector-group name="collector_group_1" id="c41cce64-4f4a-4b32-ae00-30e4dc88af22" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:description>collector_group_1 description</ops:description>
    <ops:collectorId>3 4</ops:collectorId>
    <ops:systemDefined>false</ops:systemDefined>
</ops:collector-group>
Sample Response in XML format
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:collector-group name="collector_group_1" id="447fc6c0-0774-4cf5-bfc4-f9598d0ddfb8" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:description>collector_group_1 description</ops:description>
    <ops:collectorId>3 4</ops:collectorId>
    <ops:systemDefined>false</ops:systemDefined>
</ops:collector-group>
Sample Request in JSON format
Show
{
  "id" : "56b049c3-0316-4e12-b93d-2103ecd79e2f",
  "name" : "collector_group_1",
  "description" : "collector_group_1 description",
  "collectorId" : [ 3, 4 ],
  "systemDefined" : false,
  "links" : null
}
Sample Response in JSON format
Show
{
  "id" : "701ce3d7-398b-4126-b9cd-90ed151c681d",
  "name" : "collector_group_1",
  "description" : "collector_group_1 description",
  "collectorId" : [ 3, 4 ],
  "systemDefined" : false,
  "links" : null
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200, 500
Descriptions
200 - If the Collector Group was successfully updated in the system
500 - In case of any error updating the Collector Group
Response type
<ns3:collector-group/>

GET /api/collectors/{id}/adapters

Gets all the Adapters registered (bound) to a specific Collector.

Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:adapter-instances xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:adapter-instance id="345875f9-07be-4466-805b-b11dc74d275c">
        <ops:resourceKey>
            <ops:name>VC Adapter for 10.20.88.111</ops:name>
            <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
            <ops:resourceKindKey>Adapter</ops:resourceKindKey>
            <ops:resourceIdentifiers/>
        </ops:resourceKey>
        <ops:description>A vCenter Adapter Instance</ops:description>
        <ops:collectorId>1</ops:collectorId>
        <ops:credentialInstanceId>aca1cdb2-da44-45d9-bd17-706d834fd494</ops:credentialInstanceId>
    </ops:adapter-instance>
</ops:adapter-instances>
{
  "adapterInstancesInfoDto" : [ {
    "resourceKey" : {
      "name" : "VC Adapter for 10.20.88.111",
      "adapterKindKey" : "VMWARE",
      "resourceKindKey" : "Adapter",
      "resourceIdentifier" : [ ],
      "links" : null,
      "extension" : null
    },
    "description" : "A vCenter Adapter Instance",
    "collectorId" : 1,
    "collectorGroupId" : null,
    "credentialInstanceId" : "8f899cf2-0c33-4c0e-b7b1-1bbefa92a26a",
    "monitoringInterval" : null,
    "numberOfMetricsCollected" : null,
    "numberOfResourcesCollected" : null,
    "lastHeartbeat" : null,
    "lastCollected" : null,
    "messageFromAdapterInstance" : null,
    "adapter-certificate" : null,
    "links" : null,
    "id" : "aeaf09bc-7912-4ff3-a739-60b8fd4acd39"
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:adapter-instances/>

GET /api/collectors

Gets all the Collectors registered with the vRealize Operations Manager system.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:collectors xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:collector uuId="384714da-be45-4db5-932c-3b26c399bbc4" id="1">
        <ops:name>A Local Collector</ops:name>
        <ops:state>UP</ops:state>
        <ops:local>true</ops:local>
        <ops:adapterInstanceIds>ed20b7bd-66a2-4a40-8c41-1f68966c6830</ops:adapterInstanceIds>
        <ops:adapterInstanceIds>245241fc-3dab-45bf-aca0-be0c9ef2fe50</ops:adapterInstanceIds>
    </ops:collector>
    <ops:collector id="2">
        <ops:name>A Remote Collector</ops:name>
        <ops:state>DOWN</ops:state>
        <ops:local>false</ops:local>
        <ops:adapterInstanceIds>a2f07533-2d78-410a-b157-bd9a22a4f760</ops:adapterInstanceIds>
    </ops:collector>
</ops:collectors>
{
  "collector" : [ {
    "name" : "A Local Collector",
    "state" : "UP",
    "hostName" : null,
    "local" : true,
    "lastHeartbeat" : null,
    "adapterInstanceIds" : [ "713ac1b5-efe1-444b-b0ac-0d02b49fc3bc", "892dc89d-bdb3-4b58-8d8a-e621c6cbceb5" ],
    "links" : null,
    "id" : "1",
    "uuId" : "12adf04d-1878-435d-9ed2-c3b027fdd35e",
    "nodeIdentifier" : null
  }, {
    "name" : "A Remote Collector",
    "state" : "DOWN",
    "hostName" : null,
    "local" : false,
    "lastHeartbeat" : null,
    "adapterInstanceIds" : [ "8364e667-cfd2-4d53-bb60-8f55aff58de3" ],
    "links" : null,
    "id" : "2",
    "uuId" : null,
    "nodeIdentifier" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
host Optional list of host names to filter by. query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:collectors/>

GET /api/costconfig/currency

Retrieves details of currently selected currency such as display name, code, etc. Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:currency symbol="$" numericCode="840" code="USD" name="US Dollar" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
{
  "name" : "US Dollar",
  "code" : "USD",
  "numericCode" : "840",
  "symbol" : "$"
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:currency/>

GET /api/credentialkinds

Get all Credential Kinds defined in the system. Gets all the Credential Kinds defined in the system. Optionally filter by adapter kind keys.

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:credential-instances xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:credential-kind id="PRINCIPALCREDENTIAL">
        <ops:name>Principal Credential</ops:name>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:fields>
            <ops:field enumerated="false" required="false" valueType="STRING" key="USER"/>
            <ops:field enumerated="false" required="false" valueType="STRING" key="PASSWORD"/>
        </ops:fields>
    </ops:credential-kind>
    <ops:credential-kind id="PRINCIPALCREDENTIAL">
        <ops:name>Principal Credential</ops:name>
        <ops:adapterKindKey>InvSvcAdapter</ops:adapterKindKey>
        <ops:fields>
            <ops:field enumerated="false" required="false" valueType="STRING" key="VCADMIN"/>
            <ops:field enumerated="false" required="false" valueType="STRING" key="VCADMINPASSWORD"/>
        </ops:fields>
    </ops:credential-kind>
    <ops:credential-kind id="HTTP">
        <ops:name>Http Credential</ops:name>
        <ops:adapterKindKey>ExampleAdapter</ops:adapterKindKey>
        <ops:fields>
            <ops:field enumerated="true" required="false" valueType="string" defaultValue="User" key="UserType">
                <ops:enumeratedValues>
                    <ops:enumeratedValue>Admin</ops:enumeratedValue>
                    <ops:enumeratedValue>User</ops:enumeratedValue>
                    <ops:enumeratedValue>Anonymous</ops:enumeratedValue>
                </ops:enumeratedValues>
            </ops:field>
            <ops:field enumerated="false" required="false" valueType="STRING" key="Password"/>
        </ops:fields>
    </ops:credential-kind>
</ops:credential-instances>
Sample Response in JSON format
Show
{
  "credentialInstances" : [ {
    "name" : "Principal Credential",
    "adapterKindKey" : "VMWARE",
    "field" : [ {
      "key" : "USER",
      "defaultValue" : null,
      "valueType" : "STRING",
      "required" : false,
      "enumerated" : false,
      "enumeratedValue" : null
    }, {
      "key" : "PASSWORD",
      "defaultValue" : null,
      "valueType" : "STRING",
      "required" : false,
      "enumerated" : false,
      "enumeratedValue" : null
    } ],
    "id" : "PRINCIPALCREDENTIAL"
  }, {
    "name" : "Principal Credential",
    "adapterKindKey" : "InvSvcAdapter",
    "field" : [ {
      "key" : "VCADMIN",
      "defaultValue" : null,
      "valueType" : "STRING",
      "required" : false,
      "enumerated" : false,
      "enumeratedValue" : null
    }, {
      "key" : "VCADMINPASSWORD",
      "defaultValue" : null,
      "valueType" : "STRING",
      "required" : false,
      "enumerated" : false,
      "enumeratedValue" : null
    } ],
    "id" : "PRINCIPALCREDENTIAL"
  }, {
    "name" : "Http Credential",
    "adapterKindKey" : "ExampleAdapter",
    "field" : [ {
      "key" : "UserType",
      "defaultValue" : "User",
      "valueType" : "string",
      "required" : false,
      "enumerated" : true,
      "enumeratedValue" : [ "Admin", "User", "Anonymous" ]
    }, {
      "key" : "Password",
      "defaultValue" : null,
      "valueType" : "STRING",
      "required" : false,
      "enumerated" : false,
      "enumeratedValue" : null
    } ],
    "id" : "HTTP"
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
adapterKind Filter by Adapter Kind Key query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:credential-kinds/>

POST /api/credentials

Creates a new Credential Instance.

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:credential xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>My VC Credential</ops:name>
    <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
    <ops:credentialKindKey>PRINCIPALCREDENTIAL</ops:credentialKindKey>
    <ops:fields>
        <ops:field name="USER">root</ops:field>
        <ops:field name="PASSWORD"/>
    </ops:fields>
</ops:credential>
Sample Response in XML format
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:credential id="0899d5f5-339d-4954-b587-2f8e482acd49" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>My VC Credential</ops:name>
    <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
    <ops:credentialKindKey>PRINCIPALCREDENTIAL</ops:credentialKindKey>
    <ops:fields>
        <ops:field name="USER">root</ops:field>
        <ops:field name="PASSWORD"/>
    </ops:fields>
</ops:credential>
Sample Request in JSON format
Show
{
  "id" : null,
  "name" : "My VC Credential",
  "adapterKindKey" : "VMWARE",
  "credentialKindKey" : "PRINCIPALCREDENTIAL",
  "field" : [ {
    "name" : "USER",
    "value" : "root"
  }, {
    "name" : "PASSWORD",
    "value" : null
  } ]
}
Sample Response in JSON format
Show
{
  "id" : "0be1ef77-5d9c-4f29-95ef-3bac30e5f80d",
  "name" : "My VC Credential",
  "adapterKindKey" : "VMWARE",
  "credentialKindKey" : "PRINCIPALCREDENTIAL",
  "field" : [ {
    "name" : "USER",
    "value" : "root"
  }, {
    "name" : "PASSWORD",
    "value" : null
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
<ns3:credential/>

DELETE /api/credentials/{id}

Delete a Credential Instance. Delete a Credential Instance using the identifier specified. Requires the authenticated user to have correct privilege.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The identifier of the specific Credential Instance template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Descriptions
204 - Credential Instance deleted successfully
Response type
No content returned by this method.

GET /api/credentials/{id}/adapters

Get the Adapter Instances using the Credential Instance. Gets the Adapter Instances using the Credential Instance specified by the identifier.

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:adapter-instances xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:adapter-instance id="39847ae2-f97c-46d0-8f8d-14f9523dcda2">
        <ops:resourceKey>
            <ops:name>VC Adapter for 10.20.88.111</ops:name>
            <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
            <ops:resourceKindKey>Adapter</ops:resourceKindKey>
            <ops:resourceIdentifiers/>
        </ops:resourceKey>
        <ops:description>A vCenter Adapter Instance</ops:description>
        <ops:collectorId>1</ops:collectorId>
        <ops:credentialInstanceId>8e235b26-708b-4dca-af2e-96eed91e3aa2</ops:credentialInstanceId>
    </ops:adapter-instance>
</ops:adapter-instances>
Sample Response in JSON format
Show
{
  "adapterInstancesInfoDto" : [ {
    "resourceKey" : {
      "name" : "VC Adapter for 10.20.88.111",
      "adapterKindKey" : "VMWARE",
      "resourceKindKey" : "Adapter",
      "resourceIdentifier" : [ ],
      "links" : null,
      "extension" : null
    },
    "description" : "A vCenter Adapter Instance",
    "collectorId" : 1,
    "collectorGroupId" : null,
    "credentialInstanceId" : "c90ef968-4576-4942-ad68-df55913f30cc",
    "monitoringInterval" : null,
    "numberOfMetricsCollected" : null,
    "numberOfResourcesCollected" : null,
    "lastHeartbeat" : null,
    "lastCollected" : null,
    "messageFromAdapterInstance" : null,
    "adapter-certificate" : null,
    "links" : null,
    "id" : "d50fb52d-9bc7-473a-84dc-4488e88c1fc7"
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The identifier of the specific Credential Instance template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404
Descriptions
404 - If the Credential Instance specified by id does not exist
Response type
<ns3:adapter-instances/>

GET /api/credentials/{id}

Get a Credential Instance. Get a Credential Instance using the identifier specified

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:credential id="cfbc6bcc-6184-459d-b39a-3ee75b898ef3" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>My VC Credential</ops:name>
    <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
    <ops:credentialKindKey>PRINCIPALCREDENTIAL</ops:credentialKindKey>
    <ops:fields>
        <ops:field name="USER">root</ops:field>
        <ops:field name="PASSWORD"/>
    </ops:fields>
</ops:credential>
Sample Response in JSON format
Show
{
  "id" : "d3c1a5b1-db8d-44fd-bec0-cacf0a66389b",
  "name" : "My VC Credential",
  "adapterKindKey" : "VMWARE",
  "credentialKindKey" : "PRINCIPALCREDENTIAL",
  "field" : [ {
    "name" : "USER",
    "value" : "root"
  }, {
    "name" : "PASSWORD",
    "value" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The identifier of the specific Credential Instance template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404
Descriptions
404 - If the Credential Instance specified by id does not exist
Response type
<ns3:credential/>

GET /api/credentials

Get all Credential Instances in the system. Gets all the Credential Instances in the system. Optionally filter by adapter kind keys or credential instance identifiers.

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:credential-instances xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:credential id="fa3e0115-565d-48a9-94c2-2b5ed17535a6">
        <ops:name>My VC Credential</ops:name>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:credentialKindKey>PRINCIPALCREDENTIAL</ops:credentialKindKey>
        <ops:fields>
            <ops:field name="USER">root</ops:field>
            <ops:field name="PASSWORD"/>
        </ops:fields>
    </ops:credential>
    <ops:credential id="e2a42405-461c-4061-84d3-fd69c598d043">
        <ops:name>My IS Credential</ops:name>
        <ops:adapterKindKey>InvSvcAdapter</ops:adapterKindKey>
        <ops:credentialKindKey>PRINCIPALCREDENTIAL</ops:credentialKindKey>
        <ops:fields>
            <ops:field name="VCUSER">root</ops:field>
            <ops:field name="VCPASSWORD"/>
        </ops:fields>
    </ops:credential>
</ops:credential-instances>
Sample Response in JSON format
Show
{
  "credentialInstances" : [ {
    "id" : "6066b19b-1569-4e64-aa60-a7c311f9c59a",
    "name" : "My VC Credential",
    "adapterKindKey" : "VMWARE",
    "credentialKindKey" : "PRINCIPALCREDENTIAL",
    "field" : [ {
      "name" : "USER",
      "value" : "root"
    }, {
      "name" : "PASSWORD",
      "value" : null
    } ]
  }, {
    "id" : "2228637d-a5c9-4db5-ab16-131a82c2f6b7",
    "name" : "My IS Credential",
    "adapterKindKey" : "InvSvcAdapter",
    "credentialKindKey" : "PRINCIPALCREDENTIAL",
    "field" : [ {
      "name" : "VCUSER",
      "value" : "root"
    }, {
      "name" : "VCPASSWORD",
      "value" : null
    } ]
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id Filter by CredentialInstance Id query xs:uuid no yes
adapterKind Filter by AdapterKind Id query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:credential-instances/>

GET /api/credentials/{id}/resources

Get the Objects using the Credential Instance. Gets the Objects using the Credential Instance specified by the identifier.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
id The identifier of the specific Credential Instance template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404
Descriptions
404 - If the Credential Instance specified by id does not exist
Response type
<ns3:resources/>

PUT /api/credentials

Update an existing Credential Instance.

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:credential id="083e9a71-1421-40a4-bf84-e148a686d6f4" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>My VC Credential</ops:name>
    <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
    <ops:credentialKindKey>PRINCIPALCREDENTIAL</ops:credentialKindKey>
    <ops:fields>
        <ops:field name="USER">root</ops:field>
        <ops:field name="PASSWORD"/>
    </ops:fields>
</ops:credential>
Sample Response in XML format
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:credential id="280bc23c-e00b-4740-8ffb-70d49faf825c" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>My VC Credential</ops:name>
    <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
    <ops:credentialKindKey>PRINCIPALCREDENTIAL</ops:credentialKindKey>
    <ops:fields>
        <ops:field name="USER">root</ops:field>
        <ops:field name="PASSWORD"/>
    </ops:fields>
</ops:credential>
Sample Request in JSON format
Show
{
  "id" : "4380bcad-f555-4079-8add-7e6658d8befe",
  "name" : "My VC Credential",
  "adapterKindKey" : "VMWARE",
  "credentialKindKey" : "PRINCIPALCREDENTIAL",
  "field" : [ {
    "name" : "USER",
    "value" : "root"
  }, {
    "name" : "PASSWORD",
    "value" : null
  } ]
}
Sample Response in JSON format
Show
{
  "id" : "2c4adb45-83c1-493b-894c-3042b0d3b377",
  "name" : "My VC Credential",
  "adapterKindKey" : "VMWARE",
  "credentialKindKey" : "PRINCIPALCREDENTIAL",
  "field" : [ {
    "name" : "USER",
    "value" : "root"
  }, {
    "name" : "PASSWORD",
    "value" : null
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404
Descriptions
404 - If the Credential Instance does not exist
Response type
<ns3:credential/>

POST /api/deployment/licenses

Add one or more License keys to the vRealize Operations Manager instance..

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:solution-licenses xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:solution-license licenseKey="R502G-N0Z0J-N8U88-0QPRK-AADER"/>
</ops:solution-licenses>
Sample Response in XML format
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:solution-licenses xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:solution-license licenseKey="R502G-N0Z0J-N8U88-0QPRK-AADER" id="928da069-b5db-4312-b073-34869763ef6e">
        <ops:expirationDate>1523035908893</ops:expirationDate>
        <ops:capacity> 100 Virtual Machines</ops:capacity>
        <ops:usage> 120 Virtual Machines</ops:usage>
    </ops:solution-license>
</ops:solution-licenses>
Sample Request in JSON format
Show
{
  "solutionLicenses" : [ {
    "id" : null,
    "licenseKey" : "R502G-N0Z0J-N8U88-0QPRK-AADER",
    "expirationDate" : null,
    "capacity" : null,
    "usage" : null,
    "edition" : null,
    "links" : null
  } ]
}
Sample Response in JSON format
Show
{
  "solutionLicenses" : [ {
    "id" : "928da069-b5db-4312-b073-34869763ef6e",
    "licenseKey" : "R502G-N0Z0J-N8U88-0QPRK-AADER",
    "expirationDate" : 1523035908898,
    "capacity" : " 100 Virtual Machines",
    "usage" : " 120 Virtual Machines",
    "edition" : null,
    "links" : null
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:solution-licenses/>

DELETE /api/deployment/licenses/{id}

Deletes a speicific License associated with a vRealize Operations Manager instance..

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204, 500
Descriptions
204 - If the license was deleted successfully.
500 - If there is any error in deleting the license.
Response type
No content returned by this method.

DELETE /api/deployment/config/properties/{namespace}/{key}

delete a key and its values.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
key key to delete template xs:string yes no
namespace template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

GET /api/deployment/config/globalsettings/metadata

Get global settings metadata.

Request description about parameters and structure of input data

This method does not take any request parameters.

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:global-settings-properties/>

GET /api/deployment/config/globalsettings

get all global setting values.

Request description about parameters and structure of input data

This method does not take any request parameters.

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:entries/>

GET /api/deployment/config/globalsettings/{key}

Get global setting value for the requested key.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
key template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:entry/>

GET /api/deployment/licenses

Gets all the License Details associated with a vRealize Operations Manager instance..

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:solution-licenses xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:solution-license licenseKey="R502G-N0Z0J-N8U88-0QPRK-AADER" id="928da069-b5db-4312-b073-34869763ef6e">
        <ops:expirationDate>1523035908899</ops:expirationDate>
        <ops:capacity> 100 Virtual Machines</ops:capacity>
        <ops:usage> 120 Virtual Machines</ops:usage>
    </ops:solution-license>
</ops:solution-licenses>
Sample Response in JSON format
Show
{
  "solutionLicenses" : [ {
    "id" : "928da069-b5db-4312-b073-34869763ef6e",
    "licenseKey" : "R502G-N0Z0J-N8U88-0QPRK-AADER",
    "expirationDate" : 1523035908901,
    "capacity" : " 100 Virtual Machines",
    "usage" : " 120 Virtual Machines",
    "edition" : null,
    "links" : null
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:solution-licenses/>

GET /api/deployment/config/properties/{namespace}

get all key/values from the namespace.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
namespace template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:entries/>

GET /api/deployment/node/status

get the status of the node.. get the status of the node. status is ONLINE if all the services are running and responsive. else status is OFFLINE

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:node-status xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:status>ONLINE</ops:status>
    <ops:systemTime>0</ops:systemTime>
</ops:node-status>
Sample Response in JSON format
Show
{
  "status" : "ONLINE",
  "details" : null,
  "systemTime" : 0,
  "humanlyReadableSystemTime" : null
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:node-status/>

GET /api/deployment/node/services/{name}/info

Gets information about a specific Service that is part of the vRealize Operations Manager stack.
The information returned includes the Health of the Service, uptime, when the service was started etc.
Specifically the Health of the Service is 'OK' is the Service is running and responsive. Otherwise Health is 'Error'.
Sample Response (Service is Healthy):

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:service health="OK" name="ADMINUI" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
{
  "name" : "ADMINUI",
  "health" : "OK",
  "details" : null,
  "uptime" : null,
  "startedOn" : null,
  "startedBy" : null,
  "links" : null
}

Sample Response (Service is Not Healthy):
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:service health="ERROR" name="ADMINUI" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
{
  "name" : "ADMINUI",
  "health" : "ERROR",
  "details" : null,
  "uptime" : null,
  "startedOn" : null,
  "startedBy" : null,
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
name template <ns3:service-directory> yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 400, 503
Descriptions
200 - Service is responding
400 - Service name is not a valid one
503 - Service is not responding
Response type
<ns3:service/>

GET /api/deployment/node/services/info

Gets the health of all Services
The information returned includes the Health of the Service, uptime, when the service was started etc.
Specifically the Health of the Service is 'OK' is the Service is running and responsive. Otherwise Health is 'Error'.
Sample Response in XML/JSON :

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:services xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:service health="OK" name="ADMINUI"/>
    <ops:service health="OK" name="API"/>
</ops:services>
{
  "pageInfo" : null,
  "links" : null,
  "service" : [ {
    "name" : "ADMINUI",
    "health" : "OK",
    "details" : null,
    "uptime" : null,
    "startedOn" : null,
    "startedBy" : null,
    "links" : null
  }, {
    "name" : "API",
    "health" : "OK",
    "details" : null,
    "uptime" : null,
    "startedOn" : null,
    "startedBy" : null,
    "links" : null
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:services/>

PUT /api/deployment/cluster/dt

Manages a specific run of Dynamic Threshold (DT) Computation in a vRealize Operations Manager Cluster.
Currently one can Start or Stop a DT Run.
Sample URI:
PUT /api/deployment/cluster/dt?action=start
PUT /api/deployment/cluster/dt?action=stop

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
action The type of action that one needs to perform - can be either "start" or "stop" query xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204, 500
Descriptions
204 - If DT Calculation task was started or stopped successfully without any error.
500 - If DT Calculation task was not started successfully and there were some errors.
Response type
No content returned by this method.

POST /api/deployment/config/properties/{namespace}

set values for the given namespace key.

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:entries xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:entry values="VALUE_1 VALUE_2" key="KEY_1"/>
</ops:entries>
Sample Request in JSON format
Show
{
  "pageInfo" : null,
  "links" : null,
  "keyValues" : [ {
    "key" : "KEY_1",
    "values" : [ "VALUE_1", "VALUE_2" ]
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
namespace template xs:string yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
No content returned by this method.

PUT /api/deployment/config/globalsettings/{key}/{value}

update global settings value for specified key.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
value template xs:string yes no
key template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
No content returned by this method.

POST /api/events

Push a single Event into the system.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:event managedExternally="true" keyIndicator="false" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685500000" resourceId="f3a5e68c-670b-40bf-8aa4-d16a97e76e19" eventType="NOTIFICATION" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:message>There is a problem somewhere nearby.</ops:message>
</ops:event>
{
  "eventType" : "NOTIFICATION",
  "resourceId" : "31d15a4a-f1fe-4b5e-b92a-afa5574730d4",
  "startTimeUTC" : 946685500000,
  "cancelTimeUTC" : 0,
  "message" : "There is a problem somewhere nearby.",
  "severity" : "NONE",
  "key" : null,
  "htType" : null,
  "value" : null,
  "keyIndicator" : false,
  "managedExternally" : true
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

POST /api/events/adapterkinds/{adapterKind}

Push a single Event into the system with associating an adapter kind as the event source.
If the adapter kind specified is not present in the system, it will be created dynamically. However, if the adapter kind specified already exists, then it must be of OPENAPI adapter kind type.
Also the API sanitizes the Push Adapter Kind key by removing invalid characters (e.g.: Embedded HTML & JS)
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:event managedExternally="true" keyIndicator="false" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685500000" resourceId="b335dff1-b514-4c9c-871e-dc35b2773b1c" eventType="NOTIFICATION" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:message>There is a problem somewhere nearby.</ops:message>
</ops:event>
{
  "eventType" : "NOTIFICATION",
  "resourceId" : "0e549219-44cc-4c98-b341-7e19ed4d06e8",
  "startTimeUTC" : 946685500000,
  "cancelTimeUTC" : 0,
  "message" : "There is a problem somewhere nearby.",
  "severity" : "NONE",
  "key" : null,
  "htType" : null,
  "value" : null,
  "keyIndicator" : false,
  "managedExternally" : true
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
adapterKind template xs:string yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

POST /api/events/bulk

Push one or more Events into the system.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:events xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:event managedExternally="true" keyIndicator="false" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685500000" resourceId="b0fcf7d7-cc61-4f85-b699-c76a8d58bbe1" eventType="NOTIFICATION">
        <ops:message>I have a notification for you.</ops:message>
    </ops:event>
    <ops:event managedExternally="true" keyIndicator="false" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685500000" resourceId="67cc8909-ec89-4888-8f21-81718c3fafca" eventType="RESOURCE_DOWN">
        <ops:message>There is another problem somewhere far far away in the Environment.</ops:message>
    </ops:event>
    <ops:event managedExternally="true" keyIndicator="false" severity="WARNING" cancelTimeUTC="0" startTimeUTC="946685500000" resourceId="a44c45ba-ad78-4cae-8a5a-1065f8824c4d" eventType="SYSTEM_DEGRADATION">
        <ops:message>What is this problem with the system</ops:message>
    </ops:event>
    <ops:event managedExternally="false" keyIndicator="false" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685500000" resourceId="80921b05-7366-4b63-80c5-31408bde08ad" eventType="CHANGE">
        <ops:message>A change will do you good</ops:message>
    </ops:event>
    <ops:event managedExternally="true" keyIndicator="false" htType="ABOVE" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685520002" resourceId="0ff85aab-3a9d-4967-b21a-ecfa36ac866b" eventType="HARD_THRESHOLD">
        <ops:message>metric is above expected threshold</ops:message>
        <ops:key>cpu|demandmhz</ops:key>
        <ops:value>90.0</ops:value>
    </ops:event>
    <ops:event managedExternally="true" keyIndicator="true" htType="BELOW" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685530003" resourceId="74a87f69-8e09-423a-94b8-c652db7c4c9e" eventType="HARD_THRESHOLD">
        <ops:message>metric is below expected threshold</ops:message>
        <ops:key>cpu|demandmhz</ops:key>
        <ops:value>20.0</ops:value>
    </ops:event>
    <ops:event managedExternally="false" keyIndicator="false" htType="EQUAL" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685540004" resourceId="5196c73f-107e-4cd8-a849-3ff6390912be" eventType="HARD_THRESHOLD">
        <ops:message>metric is not equal to expected target 5000</ops:message>
        <ops:key>cpu|demandmhz</ops:key>
        <ops:value>12345.0</ops:value>
    </ops:event>
    <ops:event managedExternally="true" keyIndicator="false" htType="NOT_EQUAL" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685550005" resourceId="1ccbdff6-e1a1-4c27-a946-7b7c68281f27" eventType="HARD_THRESHOLD">
        <ops:message>metric is equal to abnormal value</ops:message>
        <ops:key>cpu|demandmhz</ops:key>
        <ops:value>3.14</ops:value>
    </ops:event>
</ops:events>
{
  "event" : [ {
    "eventType" : "NOTIFICATION",
    "resourceId" : "93569e4b-73fb-409a-abee-f31c9c7f77ac",
    "startTimeUTC" : 946685500000,
    "cancelTimeUTC" : 0,
    "message" : "I have a notification for you.",
    "severity" : "NONE",
    "key" : null,
    "htType" : null,
    "value" : null,
    "keyIndicator" : false,
    "managedExternally" : true
  }, {
    "eventType" : "RESOURCE_DOWN",
    "resourceId" : "01420a7c-3e32-47d8-b66f-0f60b03d14ab",
    "startTimeUTC" : 946685500000,
    "cancelTimeUTC" : 0,
    "message" : "There is another problem somewhere far far away in the Environment.",
    "severity" : "NONE",
    "key" : null,
    "htType" : null,
    "value" : null,
    "keyIndicator" : false,
    "managedExternally" : true
  }, {
    "eventType" : "SYSTEM_DEGRADATION",
    "resourceId" : "a082d651-15d7-474f-8bfc-460085676924",
    "startTimeUTC" : 946685500000,
    "cancelTimeUTC" : 0,
    "message" : "What is this problem with the system",
    "severity" : "WARNING",
    "key" : null,
    "htType" : null,
    "value" : null,
    "keyIndicator" : false,
    "managedExternally" : true
  }, {
    "eventType" : "CHANGE",
    "resourceId" : "2cf530c9-4e69-45c9-9c10-0ac09f86bc31",
    "startTimeUTC" : 946685500000,
    "cancelTimeUTC" : 0,
    "message" : "A change will do you good",
    "severity" : "NONE",
    "key" : null,
    "htType" : null,
    "value" : null,
    "keyIndicator" : false,
    "managedExternally" : false
  }, {
    "eventType" : "HARD_THRESHOLD",
    "resourceId" : "9bea8ca2-1650-4183-94a7-91d7ed67f55f",
    "startTimeUTC" : 946685520002,
    "cancelTimeUTC" : 0,
    "message" : "metric is above expected threshold",
    "severity" : "NONE",
    "key" : "cpu|demandmhz",
    "htType" : "ABOVE",
    "value" : 90.0,
    "keyIndicator" : false,
    "managedExternally" : true
  }, {
    "eventType" : "HARD_THRESHOLD",
    "resourceId" : "f2362d7c-6a12-42ad-9668-3498ff4de1cf",
    "startTimeUTC" : 946685530003,
    "cancelTimeUTC" : 0,
    "message" : "metric is below expected threshold",
    "severity" : "NONE",
    "key" : "cpu|demandmhz",
    "htType" : "BELOW",
    "value" : 20.0,
    "keyIndicator" : true,
    "managedExternally" : true
  }, {
    "eventType" : "HARD_THRESHOLD",
    "resourceId" : "90e7dd93-6bac-40da-af0c-edaa623f54e4",
    "startTimeUTC" : 946685540004,
    "cancelTimeUTC" : 0,
    "message" : "metric is not equal to expected target 5000",
    "severity" : "NONE",
    "key" : "cpu|demandmhz",
    "htType" : "EQUAL",
    "value" : 12345.0,
    "keyIndicator" : false,
    "managedExternally" : false
  }, {
    "eventType" : "HARD_THRESHOLD",
    "resourceId" : "3bc1f171-037d-47c2-b545-9f0ca53930ce",
    "startTimeUTC" : 946685550005,
    "cancelTimeUTC" : 0,
    "message" : "metric is equal to abnormal value",
    "severity" : "NONE",
    "key" : "cpu|demandmhz",
    "htType" : "NOT_EQUAL",
    "value" : 3.14,
    "keyIndicator" : false,
    "managedExternally" : true
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

POST /api/events/bulk/adapterkinds/{adapterKind}

Push one or more Events into the system with associating an adapter kind as the event source.
If the adapter kind specified is not present in the system, it will be created dynamically. However, if the adapter kind specified already exists, then it must be of OPENAPI adapter kind type.
Also the API sanitizes the Push Adapter Kind key by removing invalid characters (e.g.: Embedded HTML & JS)
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:events xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:event managedExternally="true" keyIndicator="false" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685500000" resourceId="3a4c1be8-ea79-4c96-836e-720bb04cc8fb" eventType="NOTIFICATION">
        <ops:message>I have a notification for you.</ops:message>
    </ops:event>
    <ops:event managedExternally="true" keyIndicator="false" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685500000" resourceId="d6eb01b0-8f9e-4d52-b1c1-bb7d15b81722" eventType="RESOURCE_DOWN">
        <ops:message>There is another problem somewhere far far away in the Environment.</ops:message>
    </ops:event>
    <ops:event managedExternally="true" keyIndicator="false" severity="WARNING" cancelTimeUTC="0" startTimeUTC="946685500000" resourceId="3e235501-d871-4680-a02d-ca96615fe1eb" eventType="SYSTEM_DEGRADATION">
        <ops:message>What is this problem with the system</ops:message>
    </ops:event>
    <ops:event managedExternally="false" keyIndicator="false" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685500000" resourceId="543e7486-3e33-4d74-83f4-78d24aa2b631" eventType="CHANGE">
        <ops:message>A change will do you good</ops:message>
    </ops:event>
    <ops:event managedExternally="true" keyIndicator="false" htType="ABOVE" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685520002" resourceId="2f84af48-1a75-4b0a-bd15-ff4bd0f1604e" eventType="HARD_THRESHOLD">
        <ops:message>metric is above expected threshold</ops:message>
        <ops:key>cpu|demandmhz</ops:key>
        <ops:value>90.0</ops:value>
    </ops:event>
    <ops:event managedExternally="true" keyIndicator="true" htType="BELOW" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685530003" resourceId="08a1b65c-4ed3-4c8b-bdb1-331ccdc9329e" eventType="HARD_THRESHOLD">
        <ops:message>metric is below expected threshold</ops:message>
        <ops:key>cpu|demandmhz</ops:key>
        <ops:value>20.0</ops:value>
    </ops:event>
    <ops:event managedExternally="false" keyIndicator="false" htType="EQUAL" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685540004" resourceId="99599200-b8f8-441d-bdd7-8c4d7952d71f" eventType="HARD_THRESHOLD">
        <ops:message>metric is not equal to expected target 5000</ops:message>
        <ops:key>cpu|demandmhz</ops:key>
        <ops:value>12345.0</ops:value>
    </ops:event>
    <ops:event managedExternally="true" keyIndicator="false" htType="NOT_EQUAL" severity="NONE" cancelTimeUTC="0" startTimeUTC="946685550005" resourceId="1c3c7967-eecd-445e-9af7-f282e6df46ab" eventType="HARD_THRESHOLD">
        <ops:message>metric is equal to abnormal value</ops:message>
        <ops:key>cpu|demandmhz</ops:key>
        <ops:value>3.14</ops:value>
    </ops:event>
</ops:events>
{
  "event" : [ {
    "eventType" : "NOTIFICATION",
    "resourceId" : "4c344c2a-733d-46c1-bbde-52d16d931b08",
    "startTimeUTC" : 946685500000,
    "cancelTimeUTC" : 0,
    "message" : "I have a notification for you.",
    "severity" : "NONE",
    "key" : null,
    "htType" : null,
    "value" : null,
    "keyIndicator" : false,
    "managedExternally" : true
  }, {
    "eventType" : "RESOURCE_DOWN",
    "resourceId" : "61766c14-439b-463f-ac03-800dd746fbd0",
    "startTimeUTC" : 946685500000,
    "cancelTimeUTC" : 0,
    "message" : "There is another problem somewhere far far away in the Environment.",
    "severity" : "NONE",
    "key" : null,
    "htType" : null,
    "value" : null,
    "keyIndicator" : false,
    "managedExternally" : true
  }, {
    "eventType" : "SYSTEM_DEGRADATION",
    "resourceId" : "654f7588-fc89-4a36-8585-00c23a0df99a",
    "startTimeUTC" : 946685500000,
    "cancelTimeUTC" : 0,
    "message" : "What is this problem with the system",
    "severity" : "WARNING",
    "key" : null,
    "htType" : null,
    "value" : null,
    "keyIndicator" : false,
    "managedExternally" : true
  }, {
    "eventType" : "CHANGE",
    "resourceId" : "183cd51c-3966-40e4-acf8-7baf572a30c1",
    "startTimeUTC" : 946685500000,
    "cancelTimeUTC" : 0,
    "message" : "A change will do you good",
    "severity" : "NONE",
    "key" : null,
    "htType" : null,
    "value" : null,
    "keyIndicator" : false,
    "managedExternally" : false
  }, {
    "eventType" : "HARD_THRESHOLD",
    "resourceId" : "f2551246-e4e8-4bfb-abbb-6ec17b38ec84",
    "startTimeUTC" : 946685520002,
    "cancelTimeUTC" : 0,
    "message" : "metric is above expected threshold",
    "severity" : "NONE",
    "key" : "cpu|demandmhz",
    "htType" : "ABOVE",
    "value" : 90.0,
    "keyIndicator" : false,
    "managedExternally" : true
  }, {
    "eventType" : "HARD_THRESHOLD",
    "resourceId" : "4ccbc88c-c608-4039-9083-93f60a170ad5",
    "startTimeUTC" : 946685530003,
    "cancelTimeUTC" : 0,
    "message" : "metric is below expected threshold",
    "severity" : "NONE",
    "key" : "cpu|demandmhz",
    "htType" : "BELOW",
    "value" : 20.0,
    "keyIndicator" : true,
    "managedExternally" : true
  }, {
    "eventType" : "HARD_THRESHOLD",
    "resourceId" : "0afc8f09-b96e-4470-8b30-ba2cd848eb48",
    "startTimeUTC" : 946685540004,
    "cancelTimeUTC" : 0,
    "message" : "metric is not equal to expected target 5000",
    "severity" : "NONE",
    "key" : "cpu|demandmhz",
    "htType" : "EQUAL",
    "value" : 12345.0,
    "keyIndicator" : false,
    "managedExternally" : false
  }, {
    "eventType" : "HARD_THRESHOLD",
    "resourceId" : "5dbc0a9f-d57c-49db-a971-c1be050694d3",
    "startTimeUTC" : 946685550005,
    "cancelTimeUTC" : 0,
    "message" : "metric is equal to abnormal value",
    "severity" : "NONE",
    "key" : "cpu|demandmhz",
    "htType" : "NOT_EQUAL",
    "value" : 3.14,
    "keyIndicator" : false,
    "managedExternally" : true
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
adapterKind template xs:string yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

POST /api/maintenanceschedules

Create a maintenance schedule.

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:maintenance-schedule key="daily-ms1" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:schedule>
        <ops:hour>2</ops:hour>
        <ops:minuteOfTheHour>0</ops:minuteOfTheHour>
        <ops:duration>120</ops:duration>
        <ops:scheduleType>DAILY</ops:scheduleType>
        <ops:recurrence>1</ops:recurrence>
        <ops:expireRuns>3</ops:expireRuns>
    </ops:schedule>
</ops:maintenance-schedule>
Sample Request in JSON format
Show
{
  "id" : null,
  "key" : "daily-ms1",
  "schedule" : {
    "hour" : 2,
    "minuteOfTheHour" : 0,
    "duration" : 120,
    "scheduleType" : "DAILY",
    "recurrence" : 1,
    "dayOfTheMonth" : null,
    "daysOfTheMonth" : null,
    "weeksOfTheMonth" : null,
    "daysOfTheWeek" : null,
    "month" : null,
    "months" : null,
    "startDate" : null,
    "expirationDate" : null,
    "expireRuns" : 3
  }
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
<ns3:maintenance-schedule/>

DELETE /api/maintenanceschedules

Delete maintenance schedules with the given identifiers..

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id identifier of the schedule. query xs:uuid yes yes

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

GET /api/maintenanceschedules

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

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:maintenance-schedules xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:maintenance-schedule key="daily-ms1" id="c55123b7-d572-4a20-81fb-4cfee1ee5410">
        <ops:schedule>
            <ops:hour>3</ops:hour>
            <ops:minuteOfTheHour>0</ops:minuteOfTheHour>
            <ops:duration>180</ops:duration>
            <ops:scheduleType>DAILY</ops:scheduleType>
            <ops:recurrence>1</ops:recurrence>
            <ops:expirationDate>01/20/2050</ops:expirationDate>
        </ops:schedule>
    </ops:maintenance-schedule>
    <ops:maintenance-schedule key="monthly-ms1" id="78040a9f-e122-4b5c-ae5d-6cfd702c71f5">
        <ops:schedule>
            <ops:hour>3</ops:hour>
            <ops:minuteOfTheHour>0</ops:minuteOfTheHour>
            <ops:duration>3</ops:duration>
            <ops:scheduleType>MONTHLY</ops:scheduleType>
            <ops:daysOfTheMonth>1 2</ops:daysOfTheMonth>
            <ops:months>1</ops:months>
            <ops:expireRuns>3</ops:expireRuns>
        </ops:schedule>
    </ops:maintenance-schedule>
    <ops:maintenance-schedule key="weekly-ms1" id="63dbab2b-b085-46be-82fa-3d80d677e1ad">
        <ops:schedule>
            <ops:hour>15</ops:hour>
            <ops:minuteOfTheHour>3</ops:minuteOfTheHour>
            <ops:duration>1</ops:duration>
            <ops:scheduleType>WEEKLY</ops:scheduleType>
            <ops:recurrence>5</ops:recurrence>
            <ops:daysOfTheWeek>SATURDAY SUNDAY</ops:daysOfTheWeek>
            <ops:expireRuns>7</ops:expireRuns>
        </ops:schedule>
    </ops:maintenance-schedule>
</ops:maintenance-schedules>
Sample Response in JSON format
Show
{
  "pageInfo" : null,
  "links" : null,
  "schedules" : [ {
    "id" : "d806999f-2105-4c79-8511-e456c5797a4b",
    "key" : "daily-ms1",
    "schedule" : {
      "hour" : 3,
      "minuteOfTheHour" : 0,
      "duration" : 180,
      "scheduleType" : "DAILY",
      "recurrence" : 1,
      "dayOfTheMonth" : null,
      "daysOfTheMonth" : null,
      "weeksOfTheMonth" : null,
      "daysOfTheWeek" : null,
      "month" : null,
      "months" : null,
      "startDate" : null,
      "expirationDate" : "01/20/2050",
      "expireRuns" : null
    }
  }, {
    "id" : "14f21a68-76bd-4732-a17d-c81e751510b3",
    "key" : "monthly-ms1",
    "schedule" : {
      "hour" : 3,
      "minuteOfTheHour" : 0,
      "duration" : 3,
      "scheduleType" : "MONTHLY",
      "recurrence" : null,
      "dayOfTheMonth" : null,
      "daysOfTheMonth" : [ "1", "2" ],
      "weeksOfTheMonth" : null,
      "daysOfTheWeek" : null,
      "month" : null,
      "months" : [ 1 ],
      "startDate" : null,
      "expirationDate" : null,
      "expireRuns" : 3
    }
  }, {
    "id" : "97a6920a-b539-49dd-bba4-3de3bf249f4a",
    "key" : "weekly-ms1",
    "schedule" : {
      "hour" : 15,
      "minuteOfTheHour" : 3,
      "duration" : 1,
      "scheduleType" : "WEEKLY",
      "recurrence" : 5,
      "dayOfTheMonth" : null,
      "daysOfTheMonth" : null,
      "weeksOfTheMonth" : null,
      "daysOfTheWeek" : [ "SATURDAY", "SUNDAY" ],
      "month" : null,
      "months" : null,
      "startDate" : null,
      "expirationDate" : null,
      "expireRuns" : 7
    }
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id List of maintenance schedule identifiers. query xs:uuid no yes
name List of maintenance schedule names. query xs:string no yes
resourceId List of resource identifiers. query xs:uuid no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:maintenance-schedules/>

PUT /api/maintenanceschedules

Update an existing maintenance schedule.

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

POST /api/notifications/email/templates

Creates a new E-Mail template in the system.
Sample Request in XML/JSON (For new Alerts):

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:email-template html="true" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>MyTemplate1</ops:name>
    <ops:template>$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} New alert was generated at: {{AlertGenerateTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}}&lt;br&gt; Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:&lt;br&gt;{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} &lt;a href={{AlertSummaryLink}}&gt;Alert details&lt;/a&gt;&lt;br&gt;</ops:template>
</ops:email-template>
{
  "id" : null,
  "name" : "MyTemplate1",
  "html" : true,
  "template" : "$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} New alert was generated at: {{AlertGenerateTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}}<br> Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:<br>{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} <a href={{AlertSummaryLink}}>Alert details</a><br>"
}

Sample Request in XML/JSON (For updated Alerts):
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:email-template html="true" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>MyTemplate2</ops:name>
    <ops:template>$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} Alert was updated at: {{AlertUpdateTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}} is acting abnormally since {{AlertGenerateTime}}&lt;br&gt; Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:&lt;br&gt;{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} &lt;a href={{AlertSummaryLink}}&gt;Alert details&lt;/a&gt;&lt;br&gt;</ops:template>
</ops:email-template>
{
  "id" : null,
  "name" : "MyTemplate2",
  "html" : true,
  "template" : "$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} Alert was updated at: {{AlertUpdateTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}} is acting abnormally since {{AlertGenerateTime}}<br> Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:<br>{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} <a href={{AlertSummaryLink}}>Alert details</a><br>"
}

Sample Request in XML/JSON (For canceled Alerts):
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:email-template html="true" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>MyTemplate3</ops:name>
    <ops:template>$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} Alert was cancelled at: {{AlertCancelTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}} is acting abnormally since {{AlertGenerateTime}}&lt;br&gt; Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:&lt;br&gt;{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} &lt;a href={{AlertSummaryLink}}&gt;Alert details&lt;/a&gt;&lt;br&gt;</ops:template>
</ops:email-template>
{
  "id" : null,
  "name" : "MyTemplate3",
  "html" : true,
  "template" : "$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} Alert was cancelled at: {{AlertCancelTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}} is acting abnormally since {{AlertGenerateTime}}<br> Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:<br>{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} <a href={{AlertSummaryLink}}>Alert details</a><br>"
}

Sample Response in XML/JSON:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:email-template html="true" id="81a62bc8-b756-4b66-84e4-fc26608b9c5f" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>MyTemplate1</ops:name>
    <ops:template>$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} New alert was generated at: {{AlertGenerateTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}}&lt;br&gt; Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:&lt;br&gt;{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} &lt;a href={{AlertSummaryLink}}&gt;Alert details&lt;/a&gt;&lt;br&gt;</ops:template>
</ops:email-template>
{
  "id" : "0991283b-0a7e-4d3f-b52c-5e122cde7925",
  "name" : "MyTemplate1",
  "html" : true,
  "template" : "$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} New alert was generated at: {{AlertGenerateTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}}<br> Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:<br>{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} <a href={{AlertSummaryLink}}>Alert details</a><br>"
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
<ns3:email-template/>

POST /api/notifications/rules

Creates a new Notification Rule for a Notification Plugin Instance.
The Notification Plugin with which the Rule needs to be associated must be specified as part of the request.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:notification-rule xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>Notification Rule 1</ops:name>
    <ops:pluginId>Some Notification Plugin Instance ID</ops:pluginId>
    <ops:alertControlStates>OPEN ASSIGNED</ops:alertControlStates>
    <ops:alertStatuses>NEW ACTIVE</ops:alertStatuses>
    <ops:criticalities>CRITICAL IMMEDIATE</ops:criticalities>
    <ops:resourceKindFilter>
        <ops:resourceKind>Datastore</ops:resourceKind>
        <ops:adapterKind>VMWARE</ops:adapterKind>
    </ops:resourceKindFilter>
    <ops:alertDefinitionIdFilters>
        <ops:values>VMWARE-Datastore-NotEnoughIOPS</ops:values>
    </ops:alertDefinitionIdFilters>
</ops:notification-rule>
{
  "id" : null,
  "name" : "Notification Rule 1",
  "pluginId" : "Some Notification Plugin Instance ID",
  "alertControlStates" : [ "OPEN", "ASSIGNED" ],
  "alertStatuses" : [ "NEW", "ACTIVE" ],
  "criticalities" : [ "CRITICAL", "IMMEDIATE" ],
  "resourceKindFilter" : {
    "resourceKind" : "Datastore",
    "adapterKind" : "VMWARE"
  },
  "resourceFilter" : null,
  "alertTypeFilters" : [ ],
  "alertDefinitionIdFilters" : {
    "values" : [ "VMWARE-Datastore-NotEnoughIOPS" ]
  },
  "alertImpactFilters" : null,
  "properties" : [ ],
  "collectorUUId" : null,
  "collectorGroupId" : null,
  "links" : null
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:notification-rule id="ccd4c7a7-ebd2-47dc-a7bd-104c492375c7" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>Notification Rule 1</ops:name>
    <ops:pluginId>Some Notification Plugin Instance ID</ops:pluginId>
    <ops:alertControlStates>OPEN ASSIGNED</ops:alertControlStates>
    <ops:alertStatuses>NEW ACTIVE</ops:alertStatuses>
    <ops:criticalities>CRITICAL IMMEDIATE</ops:criticalities>
    <ops:resourceKindFilter>
        <ops:resourceKind>Datastore</ops:resourceKind>
        <ops:adapterKind>VMWARE</ops:adapterKind>
    </ops:resourceKindFilter>
    <ops:alertDefinitionIdFilters>
        <ops:values>VMWARE-Datastore-NotEnoughIOPS</ops:values>
    </ops:alertDefinitionIdFilters>
</ops:notification-rule>
{
  "id" : "4745ebb0-2b60-4fb2-be4b-8e0cf508cb8d",
  "name" : "Notification Rule 1",
  "pluginId" : "Some Notification Plugin Instance ID",
  "alertControlStates" : [ "OPEN", "ASSIGNED" ],
  "alertStatuses" : [ "NEW", "ACTIVE" ],
  "criticalities" : [ "CRITICAL", "IMMEDIATE" ],
  "resourceKindFilter" : {
    "resourceKind" : "Datastore",
    "adapterKind" : "VMWARE"
  },
  "resourceFilter" : null,
  "alertTypeFilters" : [ ],
  "alertDefinitionIdFilters" : {
    "values" : [ "VMWARE-Datastore-NotEnoughIOPS" ]
  },
  "alertImpactFilters" : null,
  "properties" : [ ],
  "collectorUUId" : null,
  "collectorGroupId" : null,
  "links" : null
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201, 422, 500, 404
Descriptions
201 - If the Notification Rule was created successfully in the system
422 - If an invalid request body was specified or if any constraints were violated
500 - If there was any error during the creation of the Notification Rule
404 - If an invalid Alert Definition identifier was specified as part of Alert Definition Filter
Response type
<ns3:notification-rule/>

DELETE /api/notifications/email/templates/{id}

Deletes an E-Mail template from the system.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The identifier of the E-Mail template template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204, 404, 403
Descriptions
204 - if the Email Template with the identifier specified was successfully deleted.
404 - if there is no Email Template with the specified identifier.
403 - if the user does not have the privilege to perform the operation.
Response type
No content returned by this method.

DELETE /api/notifications/rules/{ruleId}

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

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
ruleId Notification Rule Identifier template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

GET /api/notifications/rules

Returns all the Notification Rules defined in the system.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:notification-rules xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:notification-rule id="8ecc63dc-a93b-4f48-82e0-9a6bb4aacd8a">
        <ops:name>Notification Rule 1</ops:name>
        <ops:pluginId>Some Notification Plugin Instance ID</ops:pluginId>
        <ops:alertControlStates>OPEN ASSIGNED</ops:alertControlStates>
        <ops:alertStatuses>NEW ACTIVE</ops:alertStatuses>
        <ops:criticalities>CRITICAL IMMEDIATE</ops:criticalities>
        <ops:resourceKindFilter>
            <ops:resourceKind>Datastore</ops:resourceKind>
            <ops:adapterKind>VMWARE</ops:adapterKind>
        </ops:resourceKindFilter>
        <ops:alertDefinitionIdFilters>
            <ops:values>VMWARE-Datastore-NotEnoughIOPS</ops:values>
        </ops:alertDefinitionIdFilters>
    </ops:notification-rule>
    <ops:notification-rule id="dfe9e38a-c58f-4597-8583-d0c09ccd4f87">
        <ops:name>Notification Rule 2</ops:name>
        <ops:pluginId>Some Other Notification Plugin Instance ID</ops:pluginId>
        <ops:alertControlStates>SUSPENDED SUPPRESSED</ops:alertControlStates>
        <ops:alertStatuses>CANCELED UPDATED</ops:alertStatuses>
        <ops:criticalities>INFORMATION WARNING</ops:criticalities>
        <ops:resourceFilter resourceId="63f122cd-6b84-4d55-8e36-613322833ae5"/>
        <ops:alertImpactFilters>
            <ops:values>HEALTH</ops:values>
            <ops:values>RISK</ops:values>
        </ops:alertImpactFilters>
    </ops:notification-rule>
</ops:notification-rules>
{
  "pageInfo" : null,
  "links" : null,
  "rules" : [ {
    "id" : "f3fd9246-8ca5-47f2-8097-b03906d1f59e",
    "name" : "Notification Rule 1",
    "pluginId" : "Some Notification Plugin Instance ID",
    "alertControlStates" : [ "OPEN", "ASSIGNED" ],
    "alertStatuses" : [ "NEW", "ACTIVE" ],
    "criticalities" : [ "CRITICAL", "IMMEDIATE" ],
    "resourceKindFilter" : {
      "resourceKind" : "Datastore",
      "adapterKind" : "VMWARE"
    },
    "resourceFilter" : null,
    "alertTypeFilters" : [ ],
    "alertDefinitionIdFilters" : {
      "values" : [ "VMWARE-Datastore-NotEnoughIOPS" ]
    },
    "alertImpactFilters" : null,
    "properties" : [ ],
    "collectorUUId" : null,
    "collectorGroupId" : null,
    "links" : null
  }, {
    "id" : "4cc5e778-b753-4498-8568-3d779fb02ac0",
    "name" : "Notification Rule 2",
    "pluginId" : "Some Other Notification Plugin Instance ID",
    "alertControlStates" : [ "SUSPENDED", "SUPPRESSED" ],
    "alertStatuses" : [ "CANCELED", "UPDATED" ],
    "criticalities" : [ "INFORMATION", "WARNING" ],
    "resourceKindFilter" : null,
    "resourceFilter" : {
      "resourceId" : "a55dafcb-3271-4690-a03b-8e4873b32769",
      "matchResourceIdOnly" : null,
      "childrenResourceKindFilters" : [ ],
      "relationship" : null
    },
    "alertTypeFilters" : [ ],
    "alertDefinitionIdFilters" : null,
    "alertImpactFilters" : {
      "values" : [ "HEALTH", "RISK" ]
    },
    "properties" : [ ],
    "collectorUUId" : null,
    "collectorGroupId" : null,
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000

Response http response codes, description about schema of return types

HTTP Response Codes
200, 500
Descriptions
200 - All the Notification Rules defined in the system were returned as part of the response
500 - If there was any error returning all the Notification Rules defined in the system
Response type
<ns3:notification-rules/>

GET /api/notifications/email/templates/{id}/conditions

Gets all Email Template Conditions for a particular Email Template.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The identifier of the E-Mail template template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404
Descriptions
200 - When the API returns successfully all the Conditions for the specified Email Template.
404 - If there is no Email Template with the specified path parameter.
Response type
<ns3:email-template-conditions/>

GET /api/notifications/email/templates/{id}

Look up an E-Mail template by its identifier.
Sample Response in XML/JSON:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:email-template html="true" id="a3bf1aa1-ba2a-4269-bc6f-ac84d6a86b7c" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>MyTemplate1</ops:name>
    <ops:template>$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} New alert was generated at: {{AlertGenerateTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}}&lt;br&gt; Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:&lt;br&gt;{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} &lt;a href={{AlertSummaryLink}}&gt;Alert details&lt;/a&gt;&lt;br&gt;</ops:template>
</ops:email-template>
{
  "id" : "c0cb0d4f-9fb9-442c-a2b3-cf651562eb4d",
  "name" : "MyTemplate1",
  "html" : true,
  "template" : "$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} New alert was generated at: {{AlertGenerateTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}}<br> Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:<br>{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} <a href={{AlertSummaryLink}}>Alert details</a><br>"
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The identifier of the E-Mail template template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404
Descriptions
200 - if there is an Email Template with the specified identifier.
404 - if there is no Email Template with the specified identifier.
Response type
<ns3:email-template/>

GET /api/notifications/rules/{id}

Returns the Notification Rule for the specified identifier.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:notification-rule id="1f16038d-f931-4a8b-9544-5d96d4ec3fca" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>Notification Rule 1</ops:name>
    <ops:pluginId>Some Notification Plugin Instance ID</ops:pluginId>
    <ops:alertControlStates>OPEN ASSIGNED</ops:alertControlStates>
    <ops:alertStatuses>NEW ACTIVE</ops:alertStatuses>
    <ops:criticalities>CRITICAL IMMEDIATE</ops:criticalities>
    <ops:resourceKindFilter>
        <ops:resourceKind>Datastore</ops:resourceKind>
        <ops:adapterKind>VMWARE</ops:adapterKind>
    </ops:resourceKindFilter>
    <ops:alertDefinitionIdFilters>
        <ops:values>VMWARE-Datastore-NotEnoughIOPS</ops:values>
    </ops:alertDefinitionIdFilters>
</ops:notification-rule>
{
  "id" : "85fcf87d-e659-46ea-a619-00c59638484c",
  "name" : "Notification Rule 1",
  "pluginId" : "Some Notification Plugin Instance ID",
  "alertControlStates" : [ "OPEN", "ASSIGNED" ],
  "alertStatuses" : [ "NEW", "ACTIVE" ],
  "criticalities" : [ "CRITICAL", "IMMEDIATE" ],
  "resourceKindFilter" : {
    "resourceKind" : "Datastore",
    "adapterKind" : "VMWARE"
  },
  "resourceFilter" : null,
  "alertTypeFilters" : [ ],
  "alertDefinitionIdFilters" : {
    "values" : [ "VMWARE-Datastore-NotEnoughIOPS" ]
  },
  "alertImpactFilters" : null,
  "properties" : [ ],
  "collectorUUId" : null,
  "collectorGroupId" : null,
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id Identifier of the notification rule. template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404, 500
Descriptions
200 - If the Notification Rule for the specified identifier was returned as part of the response
404 - If there is no Notification Rule for the specified identifier
500 - If there was any error in returning the response
Response type
<ns3:notification-rule/>

GET /api/notifications/email/templates

Query for Email templates based on names and identifiers.

Both name and id values are treated as 'OR' condition.
Sample Response in XML/JSON:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:email-templates xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:email-template html="true" id="61c75b8b-8b6a-4099-8203-4c394ae49002">
        <ops:name>MyTemplate1</ops:name>
        <ops:template>$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} New alert was generated at: {{AlertGenerateTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}}&lt;br&gt; Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:&lt;br&gt;{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} &lt;a href={{AlertSummaryLink}}&gt;Alert details&lt;/a&gt;&lt;br&gt;</ops:template>
    </ops:email-template>
    <ops:email-template html="true" id="849d6aee-e646-4255-98cf-ec7f61f7a089">
        <ops:name>Another-Email-Template</ops:name>
        <ops:template>$$Subject=[vRealize Operations Manager] {{AlertStatus}}  Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} </ops:template>
    </ops:email-template>
</ops:email-templates>
{
  "emailTemplateList" : [ {
    "id" : "367b1508-f5c7-4696-877d-d3d779b38ba8",
    "name" : "MyTemplate1",
    "html" : true,
    "template" : "$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} New alert was generated at: {{AlertGenerateTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}}<br> Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:<br>{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} <a href={{AlertSummaryLink}}>Alert details</a><br>"
  }, {
    "id" : "b88d5a7c-dcbf-44ff-9883-a56d4db0ee0c",
    "name" : "Another-Email-Template",
    "html" : true,
    "template" : "$$Subject=[vRealize Operations Manager] {{AlertStatus}}  Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} "
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
name Name of the e-mail template (case insensitive), wild cards are not supported. If not specified all e-mail templates are included in the response. query xs:string no yes
id List of identifiers. If only ids are specified, e-mail templates with matching identifiers are returned. query xs:uuid no yes

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:email-templates/>

POST /api/notifications/email/templates/{id}/conditions

Sets the E-Mail template condition on an E-Mail template.
This allows user to select different templates based on the alert that was triggered.
The various Alert Types and associated Sub-Types available in the system can be queried via the API GET /api/alerts/types

Sample Request in XML/JSON:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:email-template-condition alertSubType="15" alertType="7" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:alertStatus>ACTIVE</ops:alertStatus>
    <ops:emailAddress>[email protected]</ops:emailAddress>
</ops:email-template-condition>
{
  "alertType" : 7,
  "alertSubType" : 15,
  "alertStatus" : "ACTIVE",
  "emailAddress" : "[email protected]"
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The identifier of the E-Mail template template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201, 404
Descriptions
201 - If the Condition was created in the system and associated with the Email Template.
404 - If there is no Email Template with the specified path parameter.
Response type
<ns3:email-template-condition/>

DELETE /api/notifications/email/templates/{id}/conditions

Clears all conditions associated with the E-Mail template with the given identifier.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The identifier of the E-Mail template template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204, 404
Descriptions
204 - If all the Conditions for the specified Template were deleted successfully.
404 - If there is no Email Template with the specified path parameter.
Response type
No content returned by this method.

PUT /api/notifications/email/templates

Updates an E-Mail template in the system.
Sample Request in XML/JSON (For updated Alerts):

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:email-template html="true" id="0854b0c2-a77e-469a-86db-f5cd5fb3bda3" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>MyTemplate1</ops:name>
    <ops:template>$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} New alert was generated at: {{AlertGenerateTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}}&lt;br&gt; Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:&lt;br&gt;{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} &lt;a href={{AlertSummaryLink}}&gt;Alert details&lt;/a&gt;&lt;br&gt;</ops:template>
</ops:email-template>
{
  "id" : "823ae205-1b32-442b-9247-6f234e51b218",
  "name" : "MyTemplate1",
  "html" : true,
  "template" : "$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} New alert was generated at: {{AlertGenerateTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}}<br> Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:<br>{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} <a href={{AlertSummaryLink}}>Alert details</a><br>"
}

Sample Response in XML/JSON:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:email-template html="true" id="6e745e07-bfeb-4d8d-b8ab-99df371cfc00" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>MyTemplate1</ops:name>
    <ops:template>$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} New alert was generated at: {{AlertGenerateTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}}&lt;br&gt; Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:&lt;br&gt;{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} &lt;a href={{AlertSummaryLink}}&gt;Alert details&lt;/a&gt;&lt;br&gt;</ops:template>
</ops:email-template>
{
  "id" : "0ded644f-ba55-4e28-84ae-5e845cacb520",
  "name" : "MyTemplate1",
  "html" : true,
  "template" : "$$Subject=[vRealize Operations Manager] {{AlertStatus}} Type:{{AlertType}}, Sub-Type:{{AlertSubType}}, State:{{AlertCriticality}}, Object Type:{{AffectedResourceKind}}, Name:{{AffectedResourceName}} New alert was generated at: {{AlertGenerateTime}} Info: {{AffectedResourceName}} {{AffectedResourceKind}}<br> Alert Definition Name: {{AlertDefinitionName}} Alert Definition Description: {{AlertDefinitionDesc}} Object Name : {{AffectedResourceName}} Object Type : {{AffectedResourceKind}} Alert Impact: {{AlertImpact}} Alert State : {{AlertCriticality}} Alert Type : {{AlertType}} Alert Sub-Type : {{AlertSubType}} Object Health State: {{ResourceHealthState}} Object Risk State: {{ResourceRiskState}} Object Efficiency State: {{ResourceEfficiencyState}} Symptoms:<br>{{Anomalies}} Recommendations: {{AlertRecommendation}} Notification Rule Name: {{FilterRuleName}} Notification Rule Description: {{FilterRuleDesc}} Alert ID : {{AlertId}} VCOps Server - {{vcopsServerName}} <a href={{AlertSummaryLink}}>Alert details</a><br>"
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:email-template/>

PUT /api/notifications/rules

Updates a specific Notification Rule for a Notification Plugin Instance.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:notification-rule id="f8886ca7-6268-46fe-801b-f9f0d0c13f3e" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>Notification Rule 1</ops:name>
    <ops:pluginId>Some Notification Plugin Instance ID</ops:pluginId>
    <ops:alertControlStates>OPEN ASSIGNED</ops:alertControlStates>
    <ops:alertStatuses>NEW ACTIVE</ops:alertStatuses>
    <ops:criticalities>CRITICAL IMMEDIATE</ops:criticalities>
    <ops:resourceKindFilter>
        <ops:resourceKind>Datastore</ops:resourceKind>
        <ops:adapterKind>VMWARE</ops:adapterKind>
    </ops:resourceKindFilter>
    <ops:alertDefinitionIdFilters>
        <ops:values>VMWARE-Datastore-NotEnoughIOPS</ops:values>
    </ops:alertDefinitionIdFilters>
</ops:notification-rule>
{
  "id" : "2d424d9b-8f2e-482b-bc02-72e6d9ea4d29",
  "name" : "Notification Rule 1",
  "pluginId" : "Some Notification Plugin Instance ID",
  "alertControlStates" : [ "OPEN", "ASSIGNED" ],
  "alertStatuses" : [ "NEW", "ACTIVE" ],
  "criticalities" : [ "CRITICAL", "IMMEDIATE" ],
  "resourceKindFilter" : {
    "resourceKind" : "Datastore",
    "adapterKind" : "VMWARE"
  },
  "resourceFilter" : null,
  "alertTypeFilters" : [ ],
  "alertDefinitionIdFilters" : {
    "values" : [ "VMWARE-Datastore-NotEnoughIOPS" ]
  },
  "alertImpactFilters" : null,
  "properties" : [ ],
  "collectorUUId" : null,
  "collectorGroupId" : null,
  "links" : null
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:notification-rule id="9c87a9ab-ff39-4164-9da8-fbbc9785367f" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>Notification Rule 1</ops:name>
    <ops:pluginId>Some Notification Plugin Instance ID</ops:pluginId>
    <ops:alertControlStates>OPEN ASSIGNED</ops:alertControlStates>
    <ops:alertStatuses>NEW ACTIVE</ops:alertStatuses>
    <ops:criticalities>CRITICAL IMMEDIATE</ops:criticalities>
    <ops:resourceKindFilter>
        <ops:resourceKind>Datastore</ops:resourceKind>
        <ops:adapterKind>VMWARE</ops:adapterKind>
    </ops:resourceKindFilter>
    <ops:alertDefinitionIdFilters>
        <ops:values>VMWARE-Datastore-NotEnoughIOPS</ops:values>
    </ops:alertDefinitionIdFilters>
</ops:notification-rule>
{
  "id" : "1c397cce-d563-4dff-8ff2-3b50ac160116",
  "name" : "Notification Rule 1",
  "pluginId" : "Some Notification Plugin Instance ID",
  "alertControlStates" : [ "OPEN", "ASSIGNED" ],
  "alertStatuses" : [ "NEW", "ACTIVE" ],
  "criticalities" : [ "CRITICAL", "IMMEDIATE" ],
  "resourceKindFilter" : {
    "resourceKind" : "Datastore",
    "adapterKind" : "VMWARE"
  },
  "resourceFilter" : null,
  "alertTypeFilters" : [ ],
  "alertDefinitionIdFilters" : {
    "values" : [ "VMWARE-Datastore-NotEnoughIOPS" ]
  },
  "alertImpactFilters" : null,
  "properties" : [ ],
  "collectorUUId" : null,
  "collectorGroupId" : null,
  "links" : null
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200, 422, 500
Descriptions
200 - If the Notification Rule was updated successfully in the system
422 - If an invalid request body was specified or if any constraints were violated
500 - If there was any error during the update of the Notification Rule
Response type
<ns3:notification-rule/>

POST /api/recommendations

Create the recommendation. The recommendation identifier must be unique for the system.
Examples in XML and JSON format:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:recommendation xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>dd44d0b1-93a4-41d4-8c31-24e0c9ae28a0</ops:id>
    <ops:description>Restart the Virtual Machine</ops:description>
    <ops:action>
        <ops:actionAdapterKindId>VcoRemediation</ops:actionAdapterKindId>
        <ops:targetAdapterKindId>VMWARE</ops:targetAdapterKindId>
        <ops:targetResourceKindId>VirtualMachine</ops:targetResourceKindId>
        <ops:targetMethod>reset</ops:targetMethod>
    </ops:action>
</ops:recommendation>
{
  "id" : "5bf5cd13-fc43-43e3-b653-bb4839812cb8",
  "description" : "Restart the Virtual Machine",
  "action" : {
    "actionAdapterKindId" : "VcoRemediation",
    "targetAdapterKindId" : "VMWARE",
    "targetResourceKindId" : "VirtualMachine",
    "targetMethod" : "reset"
  }
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
<ns3:recommendation/>

DELETE /api/recommendations/{id}

Delete a recommendation. If a recommendation with the identifier does not exist no error is returned.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
force if true, delete recommendation and if it is referenced in problem definition, update corresponding problem definition to remove the reference. If false, delete recommendation only if it is not referenced by any problem definition. query xs:boolean no no false
id The identifier of the recommendation template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

GET /api/recommendations/{id}

Get the recommendation specified by the given identifier

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The identifier of the recommendation template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:recommendation/>

GET /api/recommendations

Get recommendations

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id Get Recommendations with the matching id, both system defined and user defined query xs:string no yes
targetAdapterKind Get Recommendations that have an associated recommended action on and the action is applicable to the resource of the specified adapter kind. query xs:string no no
targetResourceKind Get Recommendations that have an associated recommended action on and the action is applicable to the resource of the specified resource kind. query xs:string no no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:recommendations/>

PUT /api/recommendations

Update an existing recommendation
Examples in XML and JSON format:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:recommendation xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>567297f4-029c-4cc9-ae43-4163cc409e1a</ops:id>
    <ops:description>Restart the Virtual Machine</ops:description>
    <ops:action>
        <ops:actionAdapterKindId>VcoRemediation</ops:actionAdapterKindId>
        <ops:targetAdapterKindId>VMWARE</ops:targetAdapterKindId>
        <ops:targetResourceKindId>VirtualMachine</ops:targetResourceKindId>
        <ops:targetMethod>reset</ops:targetMethod>
    </ops:action>
</ops:recommendation>
{
  "id" : "ccfd15de-a5b0-4f69-b107-75e949922f60",
  "description" : "Restart the Virtual Machine",
  "action" : {
    "actionAdapterKindId" : "VcoRemediation",
    "targetAdapterKindId" : "VMWARE",
    "targetResourceKindId" : "VirtualMachine",
    "targetMethod" : "reset"
  }
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:recommendation/>

POST /api/reportdefinitions/{id}/schedules

Creates a Report Schedule to generate a Report for the specified Report Definition and Resource(s).
All the schedules created using this API will be configured to use GMT time zone.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:report-schedule reportDefinitionId="8070738a-106a-4b27-8c83-6891cc5a40a5" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceId>f87bfe8e-88be-43e1-bc64-eabfb5769f41</ops:resourceId>
    <ops:traversalSpec adapterInstanceAssociation="false">
        <ops:name>Traversal spec name</ops:name>
        <ops:rootAdapterKindKey>VMWARE</ops:rootAdapterKindKey>
        <ops:rootResourceKindKey>VM</ops:rootResourceKindKey>
    </ops:traversalSpec>
    <ops:startDate>4/30/15</ops:startDate>
    <ops:reportScheduleType>WEEKLY</ops:reportScheduleType>
    <ops:daysOfTheWeek>SUNDAY MONDAY</ops:daysOfTheWeek>
    <ops:startHour>1</ops:startHour>
    <ops:recurrence>2</ops:recurrence>
</ops:report-schedule>
{
  "id" : null,
  "reportDefinitionId" : "8f8d6d84-9441-42a7-99d9-d1cba0550108",
  "resourceId" : [ "a6cfcaf9-bb43-4854-b3cc-1fbfdbbcac80" ],
  "traversalSpec" : {
    "name" : "Traversal spec name",
    "description" : null,
    "rootAdapterKindKey" : "VMWARE",
    "rootResourceKindKey" : "VM",
    "adapterInstanceAssociation" : false
  },
  "startDate" : "4/30/15",
  "weekOfMonth" : null,
  "reportScheduleType" : "WEEKLY",
  "daysOfTheWeek" : [ "SUNDAY", "MONDAY" ],
  "startHour" : 1,
  "recurrence" : 2,
  "dayOfTheMonth" : null,
  "emailAddresses" : null,
  "relativePath" : null
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:report-schedule reportDefinitionId="5ffe8b26-3007-437e-9afd-4a09093b8468" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceId>a4d76864-98ee-4bf8-abd2-da25cf393b36</ops:resourceId>
    <ops:startDate>01/01/2015</ops:startDate>
    <ops:reportScheduleType>MONTHLY</ops:reportScheduleType>
    <ops:recurrence>1</ops:recurrence>
    <ops:dayOfTheMonth>1</ops:dayOfTheMonth>
    <ops:emailAddresses>[email protected]</ops:emailAddresses>
</ops:report-schedule>
{
  "id" : null,
  "reportDefinitionId" : "0e5251c0-dbe1-4f8a-853c-e3c4925b2157",
  "resourceId" : [ "891ca9a4-0144-406a-919f-b5e0393d1bcf" ],
  "traversalSpec" : null,
  "startDate" : "01/01/2015",
  "weekOfMonth" : null,
  "reportScheduleType" : "MONTHLY",
  "daysOfTheWeek" : null,
  "startHour" : null,
  "recurrence" : 1,
  "dayOfTheMonth" : 1,
  "emailAddresses" : [ "[email protected]" ],
  "relativePath" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:report-schedule/>

DELETE /api/reportdefinitions/{id}/schedules/{scheduleId}

Deletes Report Schedule associated with the specific Report Definition and for the specified Schedule identifier.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
scheduleId Report Schedule identifier template xs:uuid yes no
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204, 404
Descriptions
404 - If no Report Definition is found with the specified identifier.
404 - If no Schedule is found with the specified identifier.
204 - If the Report Schedule was successfully deleted from the system.
Response type
No content returned by this method.

GET /api/reportdefinitions/{id}

Gets a Report Definition for the specified identifier.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:report-definition active="true" id="9294c925-2070-4f47-abe6-5a32fd12e81f" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:description>Stressed VMs Report</ops:description>
    <ops:lastRunTime>2018-04-06T10:31:47.701-07:00</ops:lastRunTime>
    <ops:owner>admin</ops:owner>
</ops:report-definition>
{
  "id" : "b221eff9-803e-4190-bb3d-02ecd7193242",
  "name" : null,
  "description" : "Stressed VMs Report",
  "subject" : [ ],
  "traversal-specs" : null,
  "creationTime" : null,
  "lastRunTime" : 1523035907711,
  "active" : true,
  "owner" : "admin",
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404
Descriptions
404 - If there is no Report Definition in the system for the specified identifier.
200 - If a Report Definition is returned successfully as part of the response.
Response type
<ns3:report-definition/>

GET /api/reportdefinitions

Returns the Report Definitions based on the query specification specified.
Sample Request:

Show
{
  "name" : [ "Stressed Hosts Report" ],
  "subject" : [ "VMWARE" ],
  "owner" : [ "[email protected]" ]
}
Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:report-definitions xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:report-definition active="true" id="6f2d3caf-47b8-4393-b63f-d4bb457e06cc">
        <ops:description>Stressed VMs Report</ops:description>
        <ops:lastRunTime>2018-04-06T10:31:47.728-07:00</ops:lastRunTime>
        <ops:owner>admin</ops:owner>
    </ops:report-definition>
</ops:report-definitions>
{
  "pageInfo" : null,
  "links" : null,
  "reportDefinitions" : [ {
    "id" : "b5a5e7f3-152c-4239-a169-dff4f168382b",
    "name" : null,
    "description" : "Stressed VMs Report",
    "subject" : [ ],
    "traversal-specs" : null,
    "creationTime" : null,
    "lastRunTime" : 1523035907738,
    "active" : true,
    "owner" : "admin",
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
name Names of the Report Definitions query xs:string no yes
owner Owners of the Report Definitions query xs:string no yes
subject Subjects of the Report Definitions query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:report-definitions/>

GET /api/reportdefinitions/{id}/schedules/{scheduleId}

Returns a specific Report Schedule for the specified Report Definition and Schedule identifier.
The date and time values configured within the Report Schedule are converted to GMT time zone.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:report-schedule reportDefinitionId="f216eb20-9626-4d36-9714-331e90ecf616" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceId>575fe6f1-5803-416b-87a6-ff3c3c63984b</ops:resourceId>
    <ops:startDate>01/01/2015</ops:startDate>
    <ops:reportScheduleType>MONTHLY</ops:reportScheduleType>
    <ops:recurrence>1</ops:recurrence>
    <ops:dayOfTheMonth>1</ops:dayOfTheMonth>
    <ops:emailAddresses>[email protected]</ops:emailAddresses>
</ops:report-schedule>
{
  "id" : null,
  "reportDefinitionId" : "ec7bd5fb-4581-40c1-929c-77d91e0758d2",
  "resourceId" : [ "c82097db-6854-4126-b188-20ca0907f215" ],
  "traversalSpec" : null,
  "startDate" : "01/01/2015",
  "weekOfMonth" : null,
  "reportScheduleType" : "MONTHLY",
  "daysOfTheWeek" : null,
  "startHour" : null,
  "recurrence" : 1,
  "dayOfTheMonth" : 1,
  "emailAddresses" : [ "[email protected]" ],
  "relativePath" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
scheduleId Report Schedule identifier template xs:uuid yes no
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404
Descriptions
404 - If no Report Definition is found with the specified identifier.
404 - If no Schedule is found with the specified identifier.
200 - If the corresponding Report Schedule is returned in the response.
Response type
<ns3:report-schedule/>

GET /api/reportdefinitions/{id}/schedules

Returns all the Report Schedules associated with a Report Definition.
The date and time values configured within the Report Schedule are converted to GMT time zone.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:report-schedules xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:report-schedule reportDefinitionId="97974e2d-ca97-4f0a-9ac4-9c4f99bdb2d4">
        <ops:resourceId>0dafab0f-1ec3-4442-aedd-031d89bac411</ops:resourceId>
        <ops:startDate>01/01/2015</ops:startDate>
        <ops:reportScheduleType>MONTHLY</ops:reportScheduleType>
        <ops:recurrence>1</ops:recurrence>
        <ops:dayOfTheMonth>1</ops:dayOfTheMonth>
        <ops:emailAddresses>[email protected]</ops:emailAddresses>
    </ops:report-schedule>
</ops:report-schedules>
{
  "reportSchedules" : [ {
    "id" : null,
    "reportDefinitionId" : "7608c080-bb5c-4604-bf19-ec9d286d5bb5",
    "resourceId" : [ "20c74c77-39b6-4898-a723-265febbe6470" ],
    "traversalSpec" : null,
    "startDate" : "01/01/2015",
    "weekOfMonth" : null,
    "reportScheduleType" : "MONTHLY",
    "daysOfTheWeek" : null,
    "startHour" : null,
    "recurrence" : 1,
    "dayOfTheMonth" : 1,
    "emailAddresses" : [ "[email protected]" ],
    "relativePath" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:report-schedules/>

PUT /api/reportdefinitions/{id}/schedules

Updates Report Schedule associated with the specific Report Definition and for the specified Schedule identifier.
The update of a schedule is a "Replace" operation.
If a schedule with the specified schedule id is present in the system it will be replaced else the API returns a 404 error.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:report-schedule reportDefinitionId="92c10a97-c963-440f-97c3-bc684f9556fb" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceId>b5613627-1bc6-44be-ab75-0f797132cc69</ops:resourceId>
    <ops:traversalSpec adapterInstanceAssociation="false">
        <ops:name>Traversal spec name</ops:name>
        <ops:rootAdapterKindKey>VMWARE</ops:rootAdapterKindKey>
        <ops:rootResourceKindKey>VM</ops:rootResourceKindKey>
    </ops:traversalSpec>
    <ops:startDate>4/30/15</ops:startDate>
    <ops:reportScheduleType>WEEKLY</ops:reportScheduleType>
    <ops:daysOfTheWeek>SUNDAY MONDAY</ops:daysOfTheWeek>
    <ops:startHour>1</ops:startHour>
    <ops:recurrence>2</ops:recurrence>
</ops:report-schedule>
{
  "id" : null,
  "reportDefinitionId" : "c7648772-c724-445a-add4-5285ec57df29",
  "resourceId" : [ "c4afa0d2-81d6-481c-aac9-7e4419a9c5e5" ],
  "traversalSpec" : {
    "name" : "Traversal spec name",
    "description" : null,
    "rootAdapterKindKey" : "VMWARE",
    "rootResourceKindKey" : "VM",
    "adapterInstanceAssociation" : false
  },
  "startDate" : "4/30/15",
  "weekOfMonth" : null,
  "reportScheduleType" : "WEEKLY",
  "daysOfTheWeek" : [ "SUNDAY", "MONDAY" ],
  "startHour" : 1,
  "recurrence" : 2,
  "dayOfTheMonth" : null,
  "emailAddresses" : null,
  "relativePath" : null
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:report-schedule reportDefinitionId="00490ea5-4664-49aa-9af6-bbd8bf9ba583" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceId>ab1429b3-8ed7-47e0-bb73-b2381511bf99</ops:resourceId>
    <ops:startDate>01/01/2015</ops:startDate>
    <ops:reportScheduleType>MONTHLY</ops:reportScheduleType>
    <ops:recurrence>1</ops:recurrence>
    <ops:dayOfTheMonth>1</ops:dayOfTheMonth>
    <ops:emailAddresses>[email protected]</ops:emailAddresses>
</ops:report-schedule>
{
  "id" : null,
  "reportDefinitionId" : "86751ec0-bd94-44ae-9df4-b775c0e6d2d2",
  "resourceId" : [ "1939c658-feb6-4d81-8788-77e5dbab4d42" ],
  "traversalSpec" : null,
  "startDate" : "01/01/2015",
  "weekOfMonth" : null,
  "reportScheduleType" : "MONTHLY",
  "daysOfTheWeek" : null,
  "startHour" : null,
  "recurrence" : 1,
  "dayOfTheMonth" : 1,
  "emailAddresses" : [ "[email protected]" ],
  "relativePath" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404
Descriptions
404 - If no Report Definition is found with the specified identifier.
404 - If no Schedule is found with the specified identifier.
200 - The updated Report Schedule object.
Response type
<ns3:report-schedule/>

POST /api/reports

Generate (create) a Report using the specified Report Definition and for the specified Resource.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:report xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceId>2289d88e-e1cf-4b52-8787-e11881380108</ops:resourceId>
    <ops:reportDefinitionId>31c0df3b-6a85-45b2-ba8a-818c6cf27f34</ops:reportDefinitionId>
    <ops:traversalSpec adapterInstanceAssociation="false">
        <ops:name>Traversal spec name</ops:name>
        <ops:rootAdapterKindKey>VMWARE</ops:rootAdapterKindKey>
        <ops:rootResourceKindKey>VM</ops:rootResourceKindKey>
    </ops:traversalSpec>
    <ops:subject></ops:subject>
</ops:report>
{
  "id" : null,
  "name" : null,
  "description" : null,
  "resourceId" : "600383c1-becb-480e-9449-70edaa8bf8d9",
  "reportDefinitionId" : "09d9970d-2c09-4b97-b6cc-ae53c810cd70",
  "traversalSpec" : {
    "name" : "Traversal spec name",
    "description" : null,
    "rootAdapterKindKey" : "VMWARE",
    "rootResourceKindKey" : "VM",
    "adapterInstanceAssociation" : false
  },
  "subject" : [ ],
  "owner" : null,
  "completionTime" : null,
  "status" : null,
  "links" : null
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:report xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:description>Cluster Capacity Risk Forecast Report</ops:description>
    <ops:subject></ops:subject>
    <ops:owner>admin</ops:owner>
    <ops:completionTime>1 hour ago</ops:completionTime>
    <ops:status>Completed</ops:status>
</ops:report>
{
  "id" : null,
  "name" : null,
  "description" : "Cluster Capacity Risk Forecast Report",
  "resourceId" : null,
  "reportDefinitionId" : null,
  "traversalSpec" : null,
  "subject" : [ ],
  "owner" : "admin",
  "completionTime" : "1 hour ago",
  "status" : "Completed",
  "links" : null
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:report/>

GET /api/reports/{id}/download

Download the Report given its identifier.
The supported formats for Reports are PDF, CSV. If the format is not specified the downloaded report will be in PDF format.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
format query xs:string no no
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:byte/>

GET /api/reports/{id}

Gets the detail of a Report given its identifier.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:report xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:description>Cluster Capacity Risk Forecast Report</ops:description>
    <ops:subject></ops:subject>
    <ops:owner>admin</ops:owner>
    <ops:completionTime>1 hour ago</ops:completionTime>
    <ops:status>Completed</ops:status>
</ops:report>
{
  "id" : null,
  "name" : null,
  "description" : "Cluster Capacity Risk Forecast Report",
  "resourceId" : null,
  "reportDefinitionId" : null,
  "traversalSpec" : null,
  "subject" : [ ],
  "owner" : "admin",
  "completionTime" : "1 hour ago",
  "status" : "Completed",
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:report/>

GET /api/reports

Gets the Reports based on the Report Query Spec provided.
If the query spec is not provided, all Reports present in the system are returned.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:reports xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:report>
        <ops:description>Cluster Capacity Risk Forecast Report</ops:description>
        <ops:subject></ops:subject>
        <ops:owner>admin</ops:owner>
        <ops:status>Completed</ops:status>
    </ops:report>
</ops:reports>
{
  "pageInfo" : null,
  "links" : null,
  "reports" : [ {
    "id" : null,
    "name" : null,
    "description" : "Cluster Capacity Risk Forecast Report",
    "resourceId" : null,
    "reportDefinitionId" : null,
    "traversalSpec" : null,
    "subject" : [ ],
    "owner" : "admin",
    "completionTime" : null,
    "status" : "Completed",
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
name Reports name with which the filtering can be done. query xs:string no yes
resourceId Resources on which the reports are generated query xs:uuid no yes
status Status of the report query xs:string no yes
subject Subjects with which the filtering can be done. query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:reports/>

POST /api/resources/{id}/properties

Adds Properties to a Resource.
In this case, the adapter instance used for pushing data will default to SuiteAPI.
It is recommended (though not required) to use this API when the resource was created using the API POST /api/resources/{id}/adapters/{adapterInstanceId}. Otherwise an additional adapter instance might be created.

Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:property-contents xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:property-content statKey="system|availability">
        <ops:timestamps>1119844280663</ops:timestamps>
        <ops:timestamps>1119844280693</ops:timestamps>
        <ops:timestamps>1119844280713</ops:timestamps>
        <ops:values>UP</ops:values>
        <ops:values>UP</ops:values>
        <ops:values>DOWN</ops:values>
    </ops:property-content>
    <ops:property-content statKey="config|num|processes">
        <ops:timestamps>1119844280663</ops:timestamps>
        <ops:timestamps>1119844280693</ops:timestamps>
        <ops:timestamps>1119844280713</ops:timestamps>
        <ops:timestamps>1119844280718</ops:timestamps>
        <ops:data>93.0</ops:data>
        <ops:data>95.0</ops:data>
        <ops:data>97.0</ops:data>
        <ops:data>99.0</ops:data>
    </ops:property-content>
</ops:property-contents>
{
  "property-content" : [ {
    "statKey" : "system|availability",
    "timestamps" : [ 1119844280663, 1119844280693, 1119844280713 ],
    "data" : null,
    "values" : [ "UP", "UP", "DOWN" ]
  }, {
    "statKey" : "config|num|processes",
    "timestamps" : [ 1119844280663, 1119844280693, 1119844280713, 1119844280718 ],
    "data" : [ 93.0, 95.0, 97.0, 99.0 ],
    "values" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

POST /api/resources/{id}/properties/adapterkinds/{adapterKind}

Adds Properties to a Resource along with associating an adapter instance of the specified adapter kind as the source of data.
If the adapter kind specified is not present in the system, it will be created dynamically.
However if the adapter kind specified already exists, then it must be of OPENAPI adapter kind type.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:property-contents xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:property-content statKey="system|availability">
        <ops:timestamps>1119844280663</ops:timestamps>
        <ops:timestamps>1119844280693</ops:timestamps>
        <ops:timestamps>1119844280713</ops:timestamps>
        <ops:values>UP</ops:values>
        <ops:values>UP</ops:values>
        <ops:values>DOWN</ops:values>
    </ops:property-content>
    <ops:property-content statKey="config|num|processes">
        <ops:timestamps>1119844280663</ops:timestamps>
        <ops:timestamps>1119844280693</ops:timestamps>
        <ops:timestamps>1119844280713</ops:timestamps>
        <ops:timestamps>1119844280718</ops:timestamps>
        <ops:data>93.0</ops:data>
        <ops:data>95.0</ops:data>
        <ops:data>97.0</ops:data>
        <ops:data>99.0</ops:data>
    </ops:property-content>
</ops:property-contents>
{
  "property-content" : [ {
    "statKey" : "system|availability",
    "timestamps" : [ 1119844280663, 1119844280693, 1119844280713 ],
    "data" : null,
    "values" : [ "UP", "UP", "DOWN" ]
  }, {
    "statKey" : "config|num|processes",
    "timestamps" : [ 1119844280663, 1119844280693, 1119844280713, 1119844280718 ],
    "data" : [ 93.0, 95.0, 97.0, 99.0 ],
    "values" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
adapterKind template xs:string yes no
id template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

POST /api/resources/{id}/relationships/{relationshipType}

Add relationships of given type to the resource with specified resourceId.

  • If all of the Resources that are part of the relatedIds list are invalid/non-existent then the API returns a 404 error.
  • If at least a few of the Resources that are part of relatedIds list are valid resources then the operation is performed.
  • If there are few Resources that are part of relatedIds list that will result in a cyclical relationship, then those resources will be skipped.

NOTE: Adding relationship is not synchronous. As a result, the add operation may not happen immediately. It is recommended to query the relationships of the specific Resource back to ensure that the operation was indeed successful.


Sample Request:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:uuid-values xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:uuids>92b6322e-2f80-4981-85b5-cd1d0087ebf6 352e717b-04f1-4a6c-95df-d6e8f62fcc93</ops:uuids>
</ops:uuid-values>
{
  "uuids" : [ "eb57b838-95ad-4af2-958c-3ff79e52da5a", "51eacd85-a3d5-44b5-a999-d8bbf34fe931" ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
relationshipType The type of relationship of the Resources; Uses the RelationshipType.representation value. Allowed values are: PARENT, CHILD, ALL. template xs:string yes no
id template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

POST /api/resources/{id}/stats

Adds Stats to a Resource.
In this case, the adapter instance used for pushing data will default to vRealizeOpsMgrAPI.
It is recommended (though not required) to use this API when the resource was created using the API POST /api/resources/{id}/adapters/{adapterInstanceId}. Otherwise an additional adapter instance might be created.

Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:stat-contents xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:stat-content statKey="cpu|demandGhz">
        <ops:timestamps>1119844280663</ops:timestamps>
        <ops:timestamps>1119844280693</ops:timestamps>
        <ops:timestamps>1119844280713</ops:timestamps>
        <ops:data>0.2</ops:data>
        <ops:data>0.3</ops:data>
        <ops:data>0.4</ops:data>
    </ops:stat-content>
    <ops:stat-content statKey="mem|overload">
        <ops:timestamps>1119844280663</ops:timestamps>
        <ops:timestamps>1119844280693</ops:timestamps>
        <ops:timestamps>1119844280713</ops:timestamps>
        <ops:timestamps>1119844280718</ops:timestamps>
        <ops:data>93.0</ops:data>
        <ops:data>95.0</ops:data>
        <ops:data>97.0</ops:data>
        <ops:data>99.0</ops:data>
    </ops:stat-content>
</ops:stat-contents>
{
  "stat-content" : [ {
    "statKey" : "cpu|demandGhz",
    "timestamps" : [ 1119844280663, 1119844280693, 1119844280713 ],
    "data" : [ 0.2, 0.3, 0.4 ],
    "values" : null
  }, {
    "statKey" : "mem|overload",
    "timestamps" : [ 1119844280663, 1119844280693, 1119844280713, 1119844280718 ],
    "data" : [ 93.0, 95.0, 97.0, 99.0 ],
    "values" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
disableAnalyticsProcessing Whether the current data set goes through Analytics processing (Threshold checking, Alert generation) or not.
Defaults to false. But when set to true will result in no evaluation of Alerts but the data gets stored.		 query xs:boolean no no false
id template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

POST /api/resources/stats

Adds Stats to a Collection of Resources.
In this case, the adapter instance used for pushing data will default to vRealizeOpsMgrAPI.
It is recommended (though not required) to use this API when the resources were created using the API POST /api/resources/{id}/adapters/{adapterInstanceId}. Otherwise an additional adapter instance might be created.

Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resources-stat-contents xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resource-stat-content id="e075edf4-95db-4108-96f3-6cdf34c6ecdc">
        <ops:stat-contents>
            <ops:stat-content statKey="cpu|demandGhz">
                <ops:timestamps>1119844280663</ops:timestamps>
                <ops:timestamps>1119844280693</ops:timestamps>
                <ops:timestamps>1119844280713</ops:timestamps>
                <ops:data>0.2</ops:data>
                <ops:data>0.3</ops:data>
                <ops:data>0.4</ops:data>
            </ops:stat-content>
            <ops:stat-content statKey="mem|overload">
                <ops:timestamps>1119844280663</ops:timestamps>
                <ops:timestamps>1119844280693</ops:timestamps>
                <ops:timestamps>1119844280713</ops:timestamps>
                <ops:timestamps>1119844280718</ops:timestamps>
                <ops:data>93.0</ops:data>
                <ops:data>95.0</ops:data>
                <ops:data>97.0</ops:data>
                <ops:data>99.0</ops:data>
            </ops:stat-content>
        </ops:stat-contents>
    </ops:resource-stat-content>
    <ops:resource-stat-content id="bab1101c-8a5b-44e8-8e16-b0904bb507af">
        <ops:stat-contents>
            <ops:stat-content statKey="cpu|demandGhz">
                <ops:timestamps>1119844280663</ops:timestamps>
                <ops:timestamps>1119844280693</ops:timestamps>
                <ops:timestamps>1119844280713</ops:timestamps>
                <ops:data>0.2</ops:data>
                <ops:data>0.3</ops:data>
                <ops:data>0.4</ops:data>
            </ops:stat-content>
            <ops:stat-content statKey="mem|overload">
                <ops:timestamps>1119844280663</ops:timestamps>
                <ops:timestamps>1119844280693</ops:timestamps>
                <ops:timestamps>1119844280713</ops:timestamps>
                <ops:timestamps>1119844280718</ops:timestamps>
                <ops:data>93.0</ops:data>
                <ops:data>95.0</ops:data>
                <ops:data>97.0</ops:data>
                <ops:data>99.0</ops:data>
            </ops:stat-content>
        </ops:stat-contents>
    </ops:resource-stat-content>
</ops:resources-stat-contents>
{
  "resource-stat-content" : [ {
    "id" : "25fe229e-abed-4b61-b6c2-59413cc86db2",
    "resourceKey" : null,
    "stat-content" : [ {
      "statKey" : "cpu|demandGhz",
      "timestamps" : [ 1119844280663, 1119844280693, 1119844280713 ],
      "data" : [ 0.2, 0.3, 0.4 ],
      "values" : null
    }, {
      "statKey" : "mem|overload",
      "timestamps" : [ 1119844280663, 1119844280693, 1119844280713, 1119844280718 ],
      "data" : [ 93.0, 95.0, 97.0, 99.0 ],
      "values" : null
    } ]
  }, {
    "id" : "8bce5a11-b54b-4bed-b032-ee0478923d53",
    "resourceKey" : null,
    "stat-content" : [ {
      "statKey" : "cpu|demandGhz",
      "timestamps" : [ 1119844280663, 1119844280693, 1119844280713 ],
      "data" : [ 0.2, 0.3, 0.4 ],
      "values" : null
    }, {
      "statKey" : "mem|overload",
      "timestamps" : [ 1119844280663, 1119844280693, 1119844280713, 1119844280718 ],
      "data" : [ 93.0, 95.0, 97.0, 99.0 ],
      "values" : null
    } ]
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
disableAnalyticsProcessing Whether the current data set goes through Analytics processing (Threshold checking, Alert generation) or not.
Defaults to false. But when set to true will result in no evaluation of Alerts but the data gets stored.		 query xs:boolean no no false

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

POST /api/resources/stats/adapterkinds/{adapterKind}

Adds Stats to a Collection of Resources along with associating an adapter instance of the specified adapter kind as the source of data.
If the adapter kind specified is not present in the system, it will be created dynamically.
However if the adapter kind specified already exists, then it must be of OPENAPI adapter kind type.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resources-stat-contents xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resource-stat-content id="e92b4951-6885-43f1-b5f6-6c977cf4e65c">
        <ops:stat-contents>
            <ops:stat-content statKey="cpu|demandGhz">
                <ops:timestamps>1119844280663</ops:timestamps>
                <ops:timestamps>1119844280693</ops:timestamps>
                <ops:timestamps>1119844280713</ops:timestamps>
                <ops:data>0.2</ops:data>
                <ops:data>0.3</ops:data>
                <ops:data>0.4</ops:data>
            </ops:stat-content>
            <ops:stat-content statKey="mem|overload">
                <ops:timestamps>1119844280663</ops:timestamps>
                <ops:timestamps>1119844280693</ops:timestamps>
                <ops:timestamps>1119844280713</ops:timestamps>
                <ops:timestamps>1119844280718</ops:timestamps>
                <ops:data>93.0</ops:data>
                <ops:data>95.0</ops:data>
                <ops:data>97.0</ops:data>
                <ops:data>99.0</ops:data>
            </ops:stat-content>
        </ops:stat-contents>
    </ops:resource-stat-content>
    <ops:resource-stat-content id="d2fdc587-c9e8-4e14-a70b-135d3d26fad3">
        <ops:stat-contents>
            <ops:stat-content statKey="cpu|demandGhz">
                <ops:timestamps>1119844280663</ops:timestamps>
                <ops:timestamps>1119844280693</ops:timestamps>
                <ops:timestamps>1119844280713</ops:timestamps>
                <ops:data>0.2</ops:data>
                <ops:data>0.3</ops:data>
                <ops:data>0.4</ops:data>
            </ops:stat-content>
            <ops:stat-content statKey="mem|overload">
                <ops:timestamps>1119844280663</ops:timestamps>
                <ops:timestamps>1119844280693</ops:timestamps>
                <ops:timestamps>1119844280713</ops:timestamps>
                <ops:timestamps>1119844280718</ops:timestamps>
                <ops:data>93.0</ops:data>
                <ops:data>95.0</ops:data>
                <ops:data>97.0</ops:data>
                <ops:data>99.0</ops:data>
            </ops:stat-content>
        </ops:stat-contents>
    </ops:resource-stat-content>
</ops:resources-stat-contents>
{
  "resource-stat-content" : [ {
    "id" : "9bf2da01-d9e7-4657-8dce-05400ec34305",
    "resourceKey" : null,
    "stat-content" : [ {
      "statKey" : "cpu|demandGhz",
      "timestamps" : [ 1119844280663, 1119844280693, 1119844280713 ],
      "data" : [ 0.2, 0.3, 0.4 ],
      "values" : null
    }, {
      "statKey" : "mem|overload",
      "timestamps" : [ 1119844280663, 1119844280693, 1119844280713, 1119844280718 ],
      "data" : [ 93.0, 95.0, 97.0, 99.0 ],
      "values" : null
    } ]
  }, {
    "id" : "31857911-6858-4b82-8c22-a518f8fdbab7",
    "resourceKey" : null,
    "stat-content" : [ {
      "statKey" : "cpu|demandGhz",
      "timestamps" : [ 1119844280663, 1119844280693, 1119844280713 ],
      "data" : [ 0.2, 0.3, 0.4 ],
      "values" : null
    }, {
      "statKey" : "mem|overload",
      "timestamps" : [ 1119844280663, 1119844280693, 1119844280713, 1119844280718 ],
      "data" : [ 93.0, 95.0, 97.0, 99.0 ],
      "values" : null
    } ]
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
disableAnalyticsProcessing Whether the current data set goes through Analytics processing (Threshold checking, Alert generation) or not.
Defaults to false. But when set to true will result in no evaluation of Alerts but the data gets stored.		 query xs:boolean no no false
adapterKind template xs:string yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

POST /api/resources/{id}/stats/adapterkinds/{adapterKind}

Adds Stats to a Resource along with associating an adapter instance of the specified adapter kind as the source of data.
If the adapter kind specified is not present in the system, it will be created dynamically.
However if the adapter kind specified already exists, then it must be of OPENAPI adapter kind type.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:stat-contents xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:stat-content statKey="cpu|demandGhz">
        <ops:timestamps>1119844280663</ops:timestamps>
        <ops:timestamps>1119844280693</ops:timestamps>
        <ops:timestamps>1119844280713</ops:timestamps>
        <ops:data>0.2</ops:data>
        <ops:data>0.3</ops:data>
        <ops:data>0.4</ops:data>
    </ops:stat-content>
    <ops:stat-content statKey="mem|overload">
        <ops:timestamps>1119844280663</ops:timestamps>
        <ops:timestamps>1119844280693</ops:timestamps>
        <ops:timestamps>1119844280713</ops:timestamps>
        <ops:timestamps>1119844280718</ops:timestamps>
        <ops:data>93.0</ops:data>
        <ops:data>95.0</ops:data>
        <ops:data>97.0</ops:data>
        <ops:data>99.0</ops:data>
    </ops:stat-content>
</ops:stat-contents>
{
  "stat-content" : [ {
    "statKey" : "cpu|demandGhz",
    "timestamps" : [ 1119844280663, 1119844280693, 1119844280713 ],
    "data" : [ 0.2, 0.3, 0.4 ],
    "values" : null
  }, {
    "statKey" : "mem|overload",
    "timestamps" : [ 1119844280663, 1119844280693, 1119844280713, 1119844280718 ],
    "data" : [ 93.0, 95.0, 97.0, 99.0 ],
    "values" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
disableAnalyticsProcessing Whether the current data set goes through Analytics processing (Threshold checking, Alert generation) or not.
Defaults to false. But when set to true will result in no evaluation of Alerts but the data gets stored.		 query xs:boolean no no false
adapterKind template xs:string yes no
id template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

POST /api/resources/adapters/{adapterInstanceId}

Creates a new Resource in the system associated with an existing adapter instance.
The API will create the missing Adapter Kind and Resource Kind contained within the ResourceKey of the Resource if they do not exist.
The API will return an error if the adapter instance specified does not exist.
Additional implementation notes:

  • When creating a Resource, if the Resource Identifiers that are unique and required are not specified, the API would return an error with HTTP status code of 500 and an error message indicating the set of missing Resource Identifiers.
  • When creating a Resource, if the Resource Identifiers that are unique but not required are not specified, the Resource is created where the uniquely identifying Resource Identifiers that were not specified will have their value as an empty string.
Sample Request:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resource xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:description>Description of this virtual machine</ops:description>
    <ops:resourceKey>
        <ops:name>VM1</ops:name>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:resourceKindKey>VirtualMachine</ops:resourceKindKey>
        <ops:resourceIdentifiers>
            <ops:resourceIdentifier>
                <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityObjectID"/>
                <ops:value>vm-123</ops:value>
            </ops:resourceIdentifier>
            <ops:resourceIdentifier>
                <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityVCID"/>
                <ops:value>CBAD174A-622E-4650-805A-064F824FFA76</ops:value>
            </ops:resourceIdentifier>
            <ops:resourceIdentifier>
                <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityName"/>
                <ops:value>VM1</ops:value>
            </ops:resourceIdentifier>
        </ops:resourceIdentifiers>
    </ops:resourceKey>
    <ops:credentialInstanceId>51f8f60d-4a39-4839-9924-698d022e2e10</ops:credentialInstanceId>
    <ops:resourceStatusStates/>
    <ops:dtEnabled>true</ops:dtEnabled>
    <ops:monitoringInterval>5</ops:monitoringInterval>
    <ops:badges/>
    <ops:relatedResources/>
</ops:resource>
{
  "description" : "Description of this virtual machine",
  "creationTime" : null,
  "resourceKey" : {
    "name" : "VM1",
    "adapterKindKey" : "VMWARE",
    "resourceKindKey" : "VirtualMachine",
    "resourceIdentifier" : [ {
      "identifierType" : {
        "name" : "VMEntityObjectID",
        "dataType" : "STRING",
        "isPartOfUniqueness" : true,
        "extension" : null,
        "links" : null
      },
      "value" : "vm-123",
      "links" : null
    }, {
      "identifierType" : {
        "name" : "VMEntityVCID",
        "dataType" : "STRING",
        "isPartOfUniqueness" : true,
        "extension" : null,
        "links" : null
      },
      "value" : "CBAD174A-622E-4650-805A-064F824FFA76",
      "links" : null
    }, {
      "identifierType" : {
        "name" : "VMEntityName",
        "dataType" : "STRING",
        "isPartOfUniqueness" : true,
        "extension" : null,
        "links" : null
      },
      "value" : "VM1",
      "links" : null
    } ],
    "links" : null,
    "extension" : null
  },
  "credentialInstanceId" : "51f8f60d-4a39-4839-9924-698d022e2e10",
  "geoLocation" : null,
  "resourceStatusState" : [ ],
  "resourceHealth" : null,
  "resourceHealthValue" : null,
  "dtEnabled" : true,
  "monitoringInterval" : 5,
  "badge" : [ ],
  "relatedResources" : [ ],
  "extension" : null,
  "links" : null,
  "identifier" : null
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resource identifier="a8aa47e1-b624-499b-b1f1-8e68236b383d" creationTime="1523035909248" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceKey>
        <ops:name>VM1</ops:name>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:resourceKindKey>VirtualMachine</ops:resourceKindKey>
        <ops:resourceIdentifiers>
            <ops:resourceIdentifier>
                <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityObjectID"/>
                <ops:value>vm-123</ops:value>
            </ops:resourceIdentifier>
            <ops:resourceIdentifier>
                <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityVCID"/>
                <ops:value>CBAD174A-622E-4650-805A-064F824FFA76</ops:value>
            </ops:resourceIdentifier>
            <ops:resourceIdentifier>
                <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityName"/>
                <ops:value>VM1</ops:value>
            </ops:resourceIdentifier>
        </ops:resourceIdentifiers>
    </ops:resourceKey>
    <ops:credentialInstanceId>51f8f60d-4a39-4839-9924-698d022e2e10</ops:credentialInstanceId>
    <ops:resourceStatusStates/>
    <ops:dtEnabled>true</ops:dtEnabled>
    <ops:badges/>
    <ops:relatedResources/>
</ops:resource>
{
  "description" : null,
  "creationTime" : 1523035909268,
  "resourceKey" : {
    "name" : "VM1",
    "adapterKindKey" : "VMWARE",
    "resourceKindKey" : "VirtualMachine",
    "resourceIdentifier" : [ {
      "identifierType" : {
        "name" : "VMEntityObjectID",
        "dataType" : "STRING",
        "isPartOfUniqueness" : true,
        "extension" : null,
        "links" : null
      },
      "value" : "vm-123",
      "links" : null
    }, {
      "identifierType" : {
        "name" : "VMEntityVCID",
        "dataType" : "STRING",
        "isPartOfUniqueness" : true,
        "extension" : null,
        "links" : null
      },
      "value" : "CBAD174A-622E-4650-805A-064F824FFA76",
      "links" : null
    }, {
      "identifierType" : {
        "name" : "VMEntityName",
        "dataType" : "STRING",
        "isPartOfUniqueness" : true,
        "extension" : null,
        "links" : null
      },
      "value" : "VM1",
      "links" : null
    } ],
    "links" : null,
    "extension" : null
  },
  "credentialInstanceId" : "51f8f60d-4a39-4839-9924-698d022e2e10",
  "geoLocation" : null,
  "resourceStatusState" : [ ],
  "resourceHealth" : null,
  "resourceHealthValue" : null,
  "dtEnabled" : true,
  "monitoringInterval" : null,
  "badge" : [ ],
  "relatedResources" : [ ],
  "extension" : null,
  "links" : null,
  "identifier" : "9cd060ac-bcd2-4917-bd15-dc9cbac8ab94"
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
adapterInstanceId template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201, 500, 404
Descriptions
500 - If the ResourceKey of the Resource is missing the uniquely identifying and required Resource Identifiers.
404 - If there is no Adapter Instance in the system corresponding to the Path Parameter that was specified.
Response type
<ns3:resource/>

POST /api/resources/adapterkinds/{adapterKindKey}

Creates a new Resource in the system associated with the specified adapter kind.
This adapter kind (referred to as 'Push' adapter kind) will be created if it does not exist in the system and an instance of it will be associated with the Resource being created. This adapter kind if it already exists must of OPENAPI adapter kind type.
The API will also create the missing Adapter Kind and Resource Kind contained within the ResourceKey of the Resource if they do not exist.
Additional implementation notes:

  • When creating a Resource, if the Resource Identifiers that are unique and required are not specified, the API would return an error with HTTP status code of 500 and an error message indicating the set of missing Resource Identifiers.
  • When creating a Resource, if the Resource Identifiers that are unique but not required are not specified, the Resource is created where the uniquely identifying Resource Identifiers that were not specified will have their value as an empty string.
Sample Request:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resource xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:description>Description of this virtual machine</ops:description>
    <ops:resourceKey>
        <ops:name>VM1</ops:name>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:resourceKindKey>VirtualMachine</ops:resourceKindKey>
        <ops:resourceIdentifiers>
            <ops:resourceIdentifier>
                <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityObjectID"/>
                <ops:value>vm-123</ops:value>
            </ops:resourceIdentifier>
            <ops:resourceIdentifier>
                <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityVCID"/>
                <ops:value>CBAD174A-622E-4650-805A-064F824FFA76</ops:value>
            </ops:resourceIdentifier>
            <ops:resourceIdentifier>
                <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityName"/>
                <ops:value>VM1</ops:value>
            </ops:resourceIdentifier>
        </ops:resourceIdentifiers>
    </ops:resourceKey>
    <ops:credentialInstanceId>51f8f60d-4a39-4839-9924-698d022e2e10</ops:credentialInstanceId>
    <ops:resourceStatusStates/>
    <ops:dtEnabled>true</ops:dtEnabled>
    <ops:monitoringInterval>5</ops:monitoringInterval>
    <ops:badges/>
    <ops:relatedResources/>
</ops:resource>
{
  "description" : "Description of this virtual machine",
  "creationTime" : null,
  "resourceKey" : {
    "name" : "VM1",
    "adapterKindKey" : "VMWARE",
    "resourceKindKey" : "VirtualMachine",
    "resourceIdentifier" : [ {
      "identifierType" : {
        "name" : "VMEntityObjectID",
        "dataType" : "STRING",
        "isPartOfUniqueness" : true,
        "extension" : null,
        "links" : null
      },
      "value" : "vm-123",
      "links" : null
    }, {
      "identifierType" : {
        "name" : "VMEntityVCID",
        "dataType" : "STRING",
        "isPartOfUniqueness" : true,
        "extension" : null,
        "links" : null
      },
      "value" : "CBAD174A-622E-4650-805A-064F824FFA76",
      "links" : null
    }, {
      "identifierType" : {
        "name" : "VMEntityName",
        "dataType" : "STRING",
        "isPartOfUniqueness" : true,
        "extension" : null,
        "links" : null
      },
      "value" : "VM1",
      "links" : null
    } ],
    "links" : null,
    "extension" : null
  },
  "credentialInstanceId" : "51f8f60d-4a39-4839-9924-698d022e2e10",
  "geoLocation" : null,
  "resourceStatusState" : [ ],
  "resourceHealth" : null,
  "resourceHealthValue" : null,
  "dtEnabled" : true,
  "monitoringInterval" : 5,
  "badge" : [ ],
  "relatedResources" : [ ],
  "extension" : null,
  "links" : null,
  "identifier" : null
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resource identifier="9e6d80e8-9b69-4789-9cce-874c5fbe1edc" creationTime="1523035909525" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceKey>
        <ops:name>VM1</ops:name>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:resourceKindKey>VirtualMachine</ops:resourceKindKey>
        <ops:resourceIdentifiers>
            <ops:resourceIdentifier>
                <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityObjectID"/>
                <ops:value>vm-123</ops:value>
            </ops:resourceIdentifier>
            <ops:resourceIdentifier>
                <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityVCID"/>
                <ops:value>CBAD174A-622E-4650-805A-064F824FFA76</ops:value>
            </ops:resourceIdentifier>
            <ops:resourceIdentifier>
                <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityName"/>
                <ops:value>VM1</ops:value>
            </ops:resourceIdentifier>
        </ops:resourceIdentifiers>
    </ops:resourceKey>
    <ops:credentialInstanceId>51f8f60d-4a39-4839-9924-698d022e2e10</ops:credentialInstanceId>
    <ops:resourceStatusStates/>
    <ops:dtEnabled>true</ops:dtEnabled>
    <ops:badges/>
    <ops:relatedResources/>
</ops:resource>
{
  "description" : null,
  "creationTime" : 1523035909546,
  "resourceKey" : {
    "name" : "VM1",
    "adapterKindKey" : "VMWARE",
    "resourceKindKey" : "VirtualMachine",
    "resourceIdentifier" : [ {
      "identifierType" : {
        "name" : "VMEntityObjectID",
        "dataType" : "STRING",
        "isPartOfUniqueness" : true,
        "extension" : null,
        "links" : null
      },
      "value" : "vm-123",
      "links" : null
    }, {
      "identifierType" : {
        "name" : "VMEntityVCID",
        "dataType" : "STRING",
        "isPartOfUniqueness" : true,
        "extension" : null,
        "links" : null
      },
      "value" : "CBAD174A-622E-4650-805A-064F824FFA76",
      "links" : null
    }, {
      "identifierType" : {
        "name" : "VMEntityName",
        "dataType" : "STRING",
        "isPartOfUniqueness" : true,
        "extension" : null,
        "links" : null
      },
      "value" : "VM1",
      "links" : null
    } ],
    "links" : null,
    "extension" : null
  },
  "credentialInstanceId" : "51f8f60d-4a39-4839-9924-698d022e2e10",
  "geoLocation" : null,
  "resourceStatusState" : [ ],
  "resourceHealth" : null,
  "resourceHealthValue" : null,
  "dtEnabled" : true,
  "monitoringInterval" : null,
  "badge" : [ ],
  "relatedResources" : [ ],
  "extension" : null,
  "links" : null,
  "identifier" : "f7cbaa7c-f40a-49d6-a1d4-73f550198e53"
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
adapterKindKey template xs:string yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201, 500
Descriptions
500 - If the ResourceKey of the Resource is missing the uniquely identifying and required Resource Identifiers.
500 - If the 'Push' adapter kind specified already exists in the system and doesn't correspond to an
Response type
<ns3:resource/>

DELETE /api/resources/{id}/relationships/{relationshipType}/{relatedId}

Deletes (removes) a Resource as RelationshipType of a specific Resource.

If either of the Resources that are part of the path parameters are invalid/non-existent then the API returns a 404 error.

NOTE: Removing a relationship is not synchronous. As a result, the delete operation may not happen immediately. It is recommended to query the relationships of the specific Resource back to ensure that the operation was indeed successful.


Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
relatedId The UUID of the resource to remove from relationship template xs:uuid yes no
relationshipType The type of relationship of the Resources; Uses the RelationshipType.representation value. Allowed values are: PARENT, CHILD, ALL. template xs:string yes no
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

DELETE /api/resources/{id}

Deletes a Resource with the given identifier.
If the Resource being deleted is invalid/non-existent, then the API returns a 404 error.
NOTE: Deletion of a Resource is not synchronous. As a result, the delete operation may not happen immediately. It is recommended to query back the system with the resource identifier and ensure that the system returns a 404 error.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

DELETE /api/resources/bulk

Deletes multiple Resources.
NOTE: Deletion of Resources is not synchronous. As a result, the delete operation may not happen immediately. Furthermore, there is no way to track the status of the deletion operation. It is recommended to query back the system with the resource identifiers and ensure that the system returns a 404 error.

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
204, 500
Descriptions
204 - If there is no error in starting the deletion of Resource(s).
500 - If there is any error in starting the deletion of Resource(s).
Response type
No content returned by this method.

GET /api/resources/{id}/stats/dt

Get Stats and Dynamic Threshold values for one or more StatKeys and for a Collection of Resources.
The API returns 24 hours of Stats and DT data by default for the specified Resource.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
resourceId Collection of Resource identifiers for which Stats and DT values need to be retrieved query xs:uuid yes yes
statKey Collection of StatKeys for which Stats and DT values need to be retrieved query xs:string yes yes
begin The beginning date as a long value of the range of stats to return
Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC		 query xs:long no no
end The ending date as a long value of the range of stats to return
long value is number of milliseconds since January 1, 1970 00:00:00 UTC		 query xs:long no no
showSmooth indicates whether stats should be smoothened or not. default value is true query xs:boolean no no
smoothFactor the smooth precision, default value is 2.0 query xs:double no no
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:stats-of-resources/>

GET /api/resources/{id}/stats/latest

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


Examples in XML and JSON format:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:stats-of-resources xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:stats-of-resource>
        <ops:resourceId>c1527207-9a18-4e89-8423-dd56dcb193d0</ops:resourceId>
        <ops:stat-list>
            <ops:stat>
                <ops:timestamps>1523035909888 1523035919888</ops:timestamps>
                <ops:statKey>
                    <ops:key>stat|key1</ops:key>
                </ops:statKey>
                <ops:rollUpType>NONE</ops:rollUpType>
                <ops:intervalUnit>
                    <ops:quantifier>5</ops:quantifier>
                    <ops:intervalType>MINUTES</ops:intervalType>
                </ops:intervalUnit>
                <ops:data>1.0 2.0</ops:data>
                <ops:dtTimestamps>1523035909888 1523035919888 1523035929888</ops:dtTimestamps>
                <ops:minThresholdData>0.5 1.0</ops:minThresholdData>
                <ops:maxThresholdData>1.5 3.0</ops:maxThresholdData>
                <ops:smoothValues>1.5 1.5</ops:smoothValues>
            </ops:stat>
        </ops:stat-list>
    </ops:stats-of-resource>
</ops:stats-of-resources>
{
  "values" : [ {
    "resourceId" : "f9f0bf09-f71e-49cd-8573-212bb7d0fc66",
    "stat-list" : {
      "stat" : [ {
        "timestamps" : [ 1523035909900, 1523035919900 ],
        "statKey" : {
          "key" : "stat|key1"
        },
        "rollUpType" : "NONE",
        "intervalUnit" : {
          "quantifier" : 5,
          "intervalType" : "MINUTES"
        },
        "data" : [ 1.0, 2.0 ],
        "values" : null,
        "dtTimestamps" : [ 1523035909900, 1523035919900, 1523035929900 ],
        "minThresholdData" : [ 0.5, 1.0 ],
        "maxThresholdData" : [ 1.5, 3.0 ],
        "smoothValues" : [ 1.5, 1.5 ],
        "links" : null
      } ]
    }
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
currentOnly Indicates whether to report only "current" stat values, i.e. skip the stat-s that haven't published any value during recent collection cycles. query xs:boolean no no
maxSamples The maximum number of samples to return when querying latest stats.
Defaults to 1 so that when processing the query if it is omitted the response would contain a single sample		 query xs:int no no
metrics Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats) query xs:boolean no no
resourceId Array of Resource ids to fetch the latest stats for query xs:uuid no yes
statKey Array of stat keys to return the latest stats for query xs:string no yes
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:stats-of-resources/>

GET /api/resources/stats/latest

Gets Latest stats of one or more Resources using the query spec that is specified.
Takes the form:

api/resources/stats/latest?resourceId=UUID1&resourceId=UUID2 OR
api/resources/stats/latest?resourceId=UUID2&statKey=cpu|usagemhz&statKey=cpu|demandmhz

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:stats-of-resources xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:stats-of-resource>
        <ops:resourceId>81176d7a-949d-46a4-baa1-a37b1d3ac6f1</ops:resourceId>
        <ops:stat-list>
            <ops:stat>
                <ops:timestamps>1523035909437 1523035919437</ops:timestamps>
                <ops:statKey>
                    <ops:key>stat|key1</ops:key>
                </ops:statKey>
                <ops:rollUpType>NONE</ops:rollUpType>
                <ops:intervalUnit>
                    <ops:quantifier>5</ops:quantifier>
                    <ops:intervalType>MINUTES</ops:intervalType>
                </ops:intervalUnit>
                <ops:data>1.0 2.0</ops:data>
                <ops:dtTimestamps>1523035909437 1523035919437 1523035929437</ops:dtTimestamps>
                <ops:minThresholdData>0.5 1.0</ops:minThresholdData>
                <ops:maxThresholdData>1.5 3.0</ops:maxThresholdData>
                <ops:smoothValues>1.5 1.5</ops:smoothValues>
            </ops:stat>
        </ops:stat-list>
    </ops:stats-of-resource>
</ops:stats-of-resources>
{
  "values" : [ {
    "resourceId" : "3e3e67ca-fe88-40f8-a28f-c123aad68332",
    "stat-list" : {
      "stat" : [ {
        "timestamps" : [ 1523035909452, 1523035919452 ],
        "statKey" : {
          "key" : "stat|key1"
        },
        "rollUpType" : "NONE",
        "intervalUnit" : {
          "quantifier" : 5,
          "intervalType" : "MINUTES"
        },
        "data" : [ 1.0, 2.0 ],
        "values" : null,
        "dtTimestamps" : [ 1523035909452, 1523035919452, 1523035929452 ],
        "minThresholdData" : [ 0.5, 1.0 ],
        "maxThresholdData" : [ 1.5, 3.0 ],
        "smoothValues" : [ 1.5, 1.5 ],
        "links" : null
      } ]
    }
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
currentOnly Indicates whether to report only "current" stat values, i.e. skip the stat-s that haven't published any value during recent collection cycles. query xs:boolean no no
maxSamples The maximum number of samples to return when querying latest stats.
Defaults to 1 so that when processing the query if it is omitted the response would contain a single sample		 query xs:int no no
metrics Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats) query xs:boolean no no
resourceId Array of Resource ids to fetch the latest stats for query xs:uuid no yes
statKey Array of stat keys to return the latest stats for query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:stats-of-resources/>

GET /api/resources/stats/latest

Gets Latest Stats data (most recent data points) of several Resources in CSV format.
This API is equivalent to other latest stats query APIs except that the response of the API is a CSV file which the client gets to download locally.
The API client makes the same GET /api/resources/stats/latest call but instead of setting the Accept header to "application/xml" or "application/json", the header value needs to be text/csv.

Takes the form:

HTTP 'Accept' header set to 'text/csv' (i.e. "Accept" = "text/csv")
/api/resources/stats/latest?resourceId=UUID1 OR
/api/resources/stats/latest?resourceId=UUID2&statKey=cpu|usageMhz&begin=&end=

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
currentOnly Indicates whether to report only "current" stat values, i.e. skip the stat-s that haven't published any value during recent collection cycles. query xs:boolean no no
maxSamples The maximum number of samples to return when querying latest stats.
Defaults to 1 so that when processing the query if it is omitted the response would contain a single sample		 query xs:int no no
metrics Indicates whether specified statKey-s of query should be forcibly treated as metrics (does not include instanced stats) query xs:boolean no no
resourceId Array of Resource ids to fetch the latest stats for query xs:uuid no yes
statKey Array of stat keys to return the latest stats for query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:stats-of-resources/>

POST /api/resources/query

Gets a listing of resources based on the query spec specified.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resource-query xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>vRealize Operations Manager Node-vRealize Cluster Node</ops:name>
    <ops:adapterKind>VMWARE</ops:adapterKind>
    <ops:resourceKind>ResourcePool</ops:resourceKind>
    <ops:collectorName>local_collector</ops:collectorName>
    <ops:collectorId>1</ops:collectorId>
    <ops:maintenanceScheduleId>4e2f8252-16c0-4fdf-b5b5-3dbdcf56daf5</ops:maintenanceScheduleId>
    <ops:adapterInstanceId>1eaac271-893b-47d3-a35b-9e977b00a2eb</ops:adapterInstanceId>
    <ops:resourceState>STARTED</ops:resourceState>
    <ops:resourceStatus>DATA_RECEIVING</ops:resourceStatus>
    <ops:credentialId>8984fd9f-56ae-420a-8a35-7370f7b7bfd4</ops:credentialId>
    <ops:resourceId>0e262338-15f0-4afb-84b7-a911f99bc137</ops:resourceId>
    <ops:statKeyInclusive>true</ops:statKeyInclusive>
    <ops:propertyConditions conjunctionOperator="OR">
        <ops:conditions>
            <ops:condition operator="EQ" key="property_name">
                <ops:stringValue>property_value</ops:stringValue>
            </ops:condition>
        </ops:conditions>
    </ops:propertyConditions>
    <ops:statConditions conjunctionOperator="OR">
        <ops:conditions>
            <ops:condition operator="LT_EQ" key="stat|key1">
                <ops:doubleValue>1.0</ops:doubleValue>
            </ops:condition>
        </ops:conditions>
    </ops:statConditions>
</ops:resource-query>
{
  "name" : [ "vRealize Operations Manager Node-vRealize Cluster Node" ],
  "regex" : null,
  "adapterKind" : [ "VMWARE" ],
  "resourceKind" : [ "ResourcePool" ],
  "collectorName" : [ "local_collector" ],
  "collectorId" : [ 1 ],
  "maintenanceScheduleId" : [ "82a4ca50-8dbb-4cff-bc6f-e27d5ccb4f8a" ],
  "adapterInstanceId" : [ "cfb5370d-0406-4faa-8cec-e87e2131f5fb" ],
  "recentlyAdded" : null,
  "resourceState" : [ "STARTED" ],
  "resourceStatus" : [ "DATA_RECEIVING" ],
  "resourceHealth" : null,
  "parentId" : null,
  "credentialId" : [ "ab6ade8d-78a5-49c2-ad43-0b8a5494db2a" ],
  "resourceId" : [ "1db9946c-28e8-49c5-bd88-7d69ce86e5d9" ],
  "propertyName" : null,
  "propertyValue" : null,
  "statKey" : null,
  "statKeyLowerBound" : null,
  "statKeyUpperBound" : null,
  "statKeyInclusive" : true,
  "propertyConditions" : {
    "conjunctionOperator" : "OR",
    "condition" : [ {
      "key" : "property_name",
      "operator" : "EQ",
      "stringValue" : "property_value",
      "doubleValue" : null
    } ]
  },
  "statConditions" : {
    "conjunctionOperator" : "OR",
    "condition" : [ {
      "key" : "stat|key1",
      "operator" : "LT_EQ",
      "stringValue" : null,
      "doubleValue" : 1.0
    } ]
  },
  "includeRelated" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:resources/>

GET /api/resources/{id}/relationships/{relationshipType}

Gets the related resources of a particular Relationship Type for a Resource.
The URL path variable 'relationshipType' uses the RelationshipType.representation value.
Few sample URLs are shown below.

  • /api/resources/{resourceId}/relationships/children
  • /api/resources/{resourceId}/relationships/parents

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resource-relation xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:relationshipType>CHILD</ops:relationshipType>
    <ops:resource identifier="e7aa4e9b-2cb4-4e2e-9c11-05185633ca2f" creationTime="1523035909759">
        <ops:resourceKey>
            <ops:name>VM1</ops:name>
            <ops:resourceIdentifiers/>
        </ops:resourceKey>
        <ops:credentialInstanceId>51f8f60d-4a39-4839-9924-698d022e2e10</ops:credentialInstanceId>
        <ops:resourceStatusStates/>
        <ops:dtEnabled>true</ops:dtEnabled>
        <ops:badges/>
        <ops:relatedResources/>
    </ops:resource>
    <ops:resource identifier="b2e3874b-f8a4-444b-85c1-0247869e3641" creationTime="1523035909765">
        <ops:resourceKey>
            <ops:name>VM2</ops:name>
            <ops:resourceIdentifiers/>
        </ops:resourceKey>
        <ops:credentialInstanceId>b1f8f60d-4a39-9348-9924-068d022e2b00</ops:credentialInstanceId>
        <ops:resourceStatusStates/>
        <ops:dtEnabled>true</ops:dtEnabled>
        <ops:badges/>
        <ops:relatedResources/>
    </ops:resource>
</ops:resource-relation>
{
  "pageInfo" : null,
  "links" : null,
  "relationshipType" : "CHILD",
  "resourceList" : [ {
    "description" : null,
    "creationTime" : 1523035909785,
    "resourceKey" : {
      "name" : "VM1",
      "adapterKindKey" : null,
      "resourceKindKey" : null,
      "resourceIdentifier" : [ ],
      "links" : null,
      "extension" : null
    },
    "credentialInstanceId" : "51f8f60d-4a39-4839-9924-698d022e2e10",
    "geoLocation" : null,
    "resourceStatusState" : [ ],
    "resourceHealth" : null,
    "resourceHealthValue" : null,
    "dtEnabled" : true,
    "monitoringInterval" : null,
    "badge" : [ ],
    "relatedResources" : [ ],
    "extension" : null,
    "links" : null,
    "identifier" : "b61d3b5d-0c84-4be2-988b-ce36981b5920"
  }, {
    "description" : null,
    "creationTime" : 1523035909785,
    "resourceKey" : {
      "name" : "VM2",
      "adapterKindKey" : null,
      "resourceKindKey" : null,
      "resourceIdentifier" : [ ],
      "links" : null,
      "extension" : null
    },
    "credentialInstanceId" : "b1f8f60d-4a39-9348-9924-068d022e2b00",
    "geoLocation" : null,
    "resourceStatusState" : [ ],
    "resourceHealth" : null,
    "resourceHealthValue" : null,
    "dtEnabled" : true,
    "monitoringInterval" : null,
    "badge" : [ ],
    "relatedResources" : [ ],
    "extension" : null,
    "links" : null,
    "identifier" : "36c3925c-07c6-475e-9cb7-fc78c3d9d707"
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
relationshipType The type of relationship of the Resources; Uses the RelationshipType.representation value. Allowed values are: PARENT, CHILD, ALL. template xs:string yes no
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:resource-relation/>

GET /api/resources/{id}/relationships

Gets ALL the related resources of a particular Relationship Type for a Resource.
If the optional query parameter 'relationshipType' is specified, relations of that particular Relationship Type are returned.
Few sample URLs are shown below.

  • /api/resources/{resourceId}?relationshipType=CHILD
  • /api/resources/{resourceId}?relationshipType=PARENT

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resource-relation xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:relationshipType>ALL</ops:relationshipType>
    <ops:resource identifier="9f078bfd-d33d-4c15-819a-22ffb6458f4f" creationTime="10202319">
        <ops:description>Some Virtual Machine</ops:description>
        <ops:resourceKey>
            <ops:name>Cloud-VM</ops:name>
            <ops:resourceIdentifiers/>
        </ops:resourceKey>
        <ops:resourceStatusStates/>
        <ops:dtEnabled>true</ops:dtEnabled>
        <ops:badges/>
        <ops:relatedResources/>
    </ops:resource>
    <ops:resource identifier="7790647d-cd93-4dea-9c48-140788d2c486" creationTime="10202330">
        <ops:description>Some NFS</ops:description>
        <ops:resourceKey>
            <ops:name>NFS-Datastore</ops:name>
            <ops:resourceIdentifiers/>
        </ops:resourceKey>
        <ops:resourceStatusStates/>
        <ops:dtEnabled>true</ops:dtEnabled>
        <ops:badges/>
        <ops:relatedResources/>
    </ops:resource>
</ops:resource-relation>
{
  "pageInfo" : null,
  "links" : null,
  "relationshipType" : "ALL",
  "resourceList" : [ {
    "description" : "Some Virtual Machine",
    "creationTime" : 10202319,
    "resourceKey" : {
      "name" : "Cloud-VM",
      "adapterKindKey" : null,
      "resourceKindKey" : null,
      "resourceIdentifier" : [ ],
      "links" : null,
      "extension" : null
    },
    "credentialInstanceId" : null,
    "geoLocation" : null,
    "resourceStatusState" : [ ],
    "resourceHealth" : null,
    "resourceHealthValue" : null,
    "dtEnabled" : true,
    "monitoringInterval" : null,
    "badge" : [ ],
    "relatedResources" : [ ],
    "extension" : null,
    "links" : null,
    "identifier" : "7aa3ce1c-6407-43e3-9fe5-b5e1cb05502b"
  }, {
    "description" : "Some NFS",
    "creationTime" : 10202330,
    "resourceKey" : {
      "name" : "NFS-Datastore",
      "adapterKindKey" : null,
      "resourceKindKey" : null,
      "resourceIdentifier" : [ ],
      "links" : null,
      "extension" : null
    },
    "credentialInstanceId" : null,
    "geoLocation" : null,
    "resourceStatusState" : [ ],
    "resourceHealth" : null,
    "resourceHealthValue" : null,
    "dtEnabled" : true,
    "monitoringInterval" : null,
    "badge" : [ ],
    "relatedResources" : [ ],
    "extension" : null,
    "links" : null,
    "identifier" : "f82148d0-7960-40ef-a734-b01ad062349f"
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
relationshipType The type of relationship of the objects; Uses the RelationshipType.representation value.
Allowed values are: PARENT, CHILD, ALL.		 query <ns3:relationship-type> no no
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:resource-relation/>

GET /api/resources/{id}

Gets the Resource for the specified identifier.

Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resource identifier="3b198aef-03c1-4ec8-a78e-99b7b99e3751" creationTime="1523035909973" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceKey>
        <ops:name>VM1</ops:name>
        <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
        <ops:resourceKindKey>VirtualMachine</ops:resourceKindKey>
        <ops:resourceIdentifiers>
            <ops:resourceIdentifier>
                <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityObjectID"/>
                <ops:value>vm-123</ops:value>
            </ops:resourceIdentifier>
            <ops:resourceIdentifier>
                <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityVCID"/>
                <ops:value>CBAD174A-622E-4650-805A-064F824FFA76</ops:value>
            </ops:resourceIdentifier>
            <ops:resourceIdentifier>
                <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityName"/>
                <ops:value>VM1</ops:value>
            </ops:resourceIdentifier>
        </ops:resourceIdentifiers>
    </ops:resourceKey>
    <ops:credentialInstanceId>51f8f60d-4a39-4839-9924-698d022e2e10</ops:credentialInstanceId>
    <ops:resourceStatusStates/>
    <ops:dtEnabled>true</ops:dtEnabled>
    <ops:badges/>
    <ops:relatedResources/>
</ops:resource>
{
  "description" : null,
  "creationTime" : 1523035909992,
  "resourceKey" : {
    "name" : "VM1",
    "adapterKindKey" : "VMWARE",
    "resourceKindKey" : "VirtualMachine",
    "resourceIdentifier" : [ {
      "identifierType" : {
        "name" : "VMEntityObjectID",
        "dataType" : "STRING",
        "isPartOfUniqueness" : true,
        "extension" : null,
        "links" : null
      },
      "value" : "vm-123",
      "links" : null
    }, {
      "identifierType" : {
        "name" : "VMEntityVCID",
        "dataType" : "STRING",
        "isPartOfUniqueness" : true,
        "extension" : null,
        "links" : null
      },
      "value" : "CBAD174A-622E-4650-805A-064F824FFA76",
      "links" : null
    }, {
      "identifierType" : {
        "name" : "VMEntityName",
        "dataType" : "STRING",
        "isPartOfUniqueness" : true,
        "extension" : null,
        "links" : null
      },
      "value" : "VM1",
      "links" : null
    } ],
    "links" : null,
    "extension" : null
  },
  "credentialInstanceId" : "51f8f60d-4a39-4839-9924-698d022e2e10",
  "geoLocation" : null,
  "resourceStatusState" : [ ],
  "resourceHealth" : null,
  "resourceHealthValue" : null,
  "dtEnabled" : true,
  "monitoringInterval" : null,
  "badge" : [ ],
  "relatedResources" : [ ],
  "extension" : null,
  "links" : null,
  "identifier" : "2d730a90-ebe6-4e06-b765-3459b9e18493"
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:resource/>

GET /api/resources/{id}/properties

Get all the properties for the specified Resource.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resource-property resourceId="2fbf6721-33c0-4dc9-b857-c0c139cccdca" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:property name="Key1">Value1</ops:property>
</ops:resource-property>
{
  "resourceId" : "fe5f80a6-2145-476a-8de2-60e79e437bb3",
  "property" : [ {
    "name" : "Key1",
    "value" : "Value1"
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:resource-property/>

GET /api/resources/properties

Gets all the Properties and their current (latest) values for the specified Resources.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resource-properties xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resource-property resourceId="0a93dce7-76fb-4235-881f-3a3b9dac51cb">
        <ops:property name="Key1">Value1</ops:property>
    </ops:resource-property>
    <ops:resource-property resourceId="a932c62f-6be0-4fad-acdf-9f0b69601e95">
        <ops:property name="Key1">Value1</ops:property>
    </ops:resource-property>
</ops:resource-properties>
{
  "resourcePropertiesList" : [ {
    "resourceId" : "95d9fc2a-3dfe-4ff7-8a01-a0d1d030925b",
    "property" : [ {
      "name" : "Key1",
      "value" : "Value1"
    } ]
  }, {
    "resourceId" : "27570958-523c-45b6-ab9a-1bf5a0b0d0af",
    "property" : [ {
      "name" : "Key1",
      "value" : "Value1"
    } ]
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
resourceId The Collection of Resource Identifiers query xs:uuid yes yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:resource-properties/>

GET /api/resources

Gets a listing of resources based on the query spec specified.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
name Array of resource names to query for. NOTE: Currently, only single element supported query xs:string no yes
regex Array of resource names in java regex format. NOTE: regex and name are mutually exclusive. If both are specified, name is given preference. query xs:string no yes
adapterKind Array of Adapter Kind keys query xs:string no yes
resourceKind Array of Resource Kind keys query xs:string no yes
collectorName Array of Collector names query xs:string no yes
collectorId Array of Collector Identifiers query xs:int no yes
maintenanceScheduleId Array of that identify Maintenance Schedules.
Since vROps 6.1.0 release onwards, we don't support search and look up of Resources using Maintenance Schedules' identifiers.
 query xs:uuid no yes
adapterInstanceId Array of that identify Adapter Instances query xs:uuid no yes
recentlyAdded Return resources created after the specified value. Value is the number of seconds since Midnight January 1, 1970 GMT. query xs:long no no
resourceState Array of query <ns3:resource-state> no yes
resourceStatus Array of query <ns3:resource-data-collection-status> no yes
resourceHealth Array of query <ns3:resource-health> no yes
parentId Array of UUID of object that are the parent resource in a parent child relationship. query xs:uuid no yes
credentialId Array of that identify Credentials query xs:uuid no yes
resourceId Resource identifiers. query xs:uuid no yes
propertyName Name of property. Query only supports filtering for a single property. query xs:string no no
propertyValue Value of property named by . Omitting the will check for existence of the on the resource. NOTE: Use 'propertyConditions' to specify lookup of Resource using multiple properties. query xs:string no no
statKey Name of resource StatKey to validate value is within a range.
Use with , and to create comparison conditions NOTE: Use 'statConditions' to specify lookup of Resource using multiple stat keys.		 query xs:string no no
statKeyLowerBound StatKey value matching range lower bound query xs:double no no
statKeyUpperBound StatKey value matching range upper bound query xs:double no no
statKeyInclusive Filtering by statKey values is inclusive or exclusive of boundary values. Defaults to true query xs:boolean no no
includeRelated None null value specifies to include related resource ids of given relationship type in resource result. Uses the RelationshipType.representation value.
Allowed values are: PARENT, CHILD.		 query <ns3:relationship-type> no no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:resources/>

POST /api/resources/bulk/relationships

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

Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resource-relationships-query relationshipType="DESCENDANT" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceIds>2dd7f80f-676d-405f-8ce6-ea75f65f30a1 17ca3f82-4da0-4b5a-bd13-141e30bc157c</ops:resourceIds>
    <ops:resourceQuery>
        <ops:name>vRealize Operations Manager Node-vRealize Cluster Node</ops:name>
        <ops:adapterKind>VMWARE</ops:adapterKind>
        <ops:resourceKind>ResourcePool</ops:resourceKind>
        <ops:collectorName>local_collector</ops:collectorName>
        <ops:collectorId>1</ops:collectorId>
        <ops:maintenanceScheduleId>ab240eff-e40d-475e-a1cd-8c205b9fa979</ops:maintenanceScheduleId>
        <ops:adapterInstanceId>7bb16b17-bb83-4aa9-aab4-aa23dbb98416</ops:adapterInstanceId>
        <ops:resourceState>STARTED</ops:resourceState>
        <ops:resourceStatus>DATA_RECEIVING</ops:resourceStatus>
        <ops:credentialId>909eb056-99ea-44fb-8087-506e119783bc</ops:credentialId>
        <ops:resourceId>bcc9ee44-6deb-4a9c-ae43-a350f50ba59f</ops:resourceId>
        <ops:statKeyInclusive>true</ops:statKeyInclusive>
        <ops:propertyConditions conjunctionOperator="OR">
            <ops:conditions>
                <ops:condition operator="EQ" key="property_name">
                    <ops:stringValue>property_value</ops:stringValue>
                </ops:condition>
            </ops:conditions>
        </ops:propertyConditions>
        <ops:statConditions conjunctionOperator="OR">
            <ops:conditions>
                <ops:condition operator="LT_EQ" key="stat|key1">
                    <ops:doubleValue>1.0</ops:doubleValue>
                </ops:condition>
            </ops:conditions>
        </ops:statConditions>
    </ops:resourceQuery>
    <ops:hierarchyDepth>5</ops:hierarchyDepth>
</ops:resource-relationships-query>
{
  "relationshipType" : "DESCENDANT",
  "resourceIds" : [ "52aa02da-83a7-4ec8-bb2e-2f499c857847", "5c7fc364-e34a-4fda-9818-a59fd3aae0d9" ],
  "resourceQuery" : {
    "name" : [ "vRealize Operations Manager Node-vRealize Cluster Node" ],
    "regex" : null,
    "adapterKind" : [ "VMWARE" ],
    "resourceKind" : [ "ResourcePool" ],
    "collectorName" : [ "local_collector" ],
    "collectorId" : [ 1 ],
    "maintenanceScheduleId" : [ "07bba914-b7db-422a-ad0f-0eac485a6cfb" ],
    "adapterInstanceId" : [ "015225b0-bb07-401e-8ab4-a1f6b898956b" ],
    "recentlyAdded" : null,
    "resourceState" : [ "STARTED" ],
    "resourceStatus" : [ "DATA_RECEIVING" ],
    "resourceHealth" : null,
    "parentId" : null,
    "credentialId" : [ "81b17980-0e9b-416e-8c21-9f2b71733c7b" ],
    "resourceId" : [ "f34cae71-ce49-4c2e-b015-de5d6534d656" ],
    "propertyName" : null,
    "propertyValue" : null,
    "statKey" : null,
    "statKeyLowerBound" : null,
    "statKeyUpperBound" : null,
    "statKeyInclusive" : true,
    "propertyConditions" : {
      "conjunctionOperator" : "OR",
      "condition" : [ {
        "key" : "property_name",
        "operator" : "EQ",
        "stringValue" : "property_value",
        "doubleValue" : null
      } ]
    },
    "statConditions" : {
      "conjunctionOperator" : "OR",
      "condition" : [ {
        "key" : "stat|key1",
        "operator" : "LT_EQ",
        "stringValue" : null,
        "doubleValue" : 1.0
      } ]
    },
    "includeRelated" : null
  },
  "hierarchyDepth" : 5
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resources-relation relationshipType="DESCENDANT" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourcesRelations>
        <ops:resourceRelations>
            <ops:resource identifier="6af68647-3d6a-479f-a169-fffe5206ba7e" creationTime="1523035909668">
                <ops:resourceKey>
                    <ops:name>VM1</ops:name>
                    <ops:adapterKindKey>VMWARE</ops:adapterKindKey>
                    <ops:resourceKindKey>VirtualMachine</ops:resourceKindKey>
                    <ops:resourceIdentifiers>
                        <ops:resourceIdentifier>
                            <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityObjectID"/>
                            <ops:value>vm-123</ops:value>
                        </ops:resourceIdentifier>
                        <ops:resourceIdentifier>
                            <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityVCID"/>
                            <ops:value>CBAD174A-622E-4650-805A-064F824FFA76</ops:value>
                        </ops:resourceIdentifier>
                        <ops:resourceIdentifier>
                            <ops:identifierType isPartOfUniqueness="true" dataType="STRING" name="VMEntityName"/>
                            <ops:value>VM1</ops:value>
                        </ops:resourceIdentifier>
                    </ops:resourceIdentifiers>
                </ops:resourceKey>
                <ops:credentialInstanceId>51f8f60d-4a39-4839-9924-698d022e2e10</ops:credentialInstanceId>
                <ops:resourceStatusStates/>
                <ops:dtEnabled>true</ops:dtEnabled>
                <ops:badges/>
                <ops:relatedResources/>
            </ops:resource>
            <ops:relatedResources>ee40e5d2-3ad1-4942-a0c5-0be3b7fb2edf 90ab701b-faed-4c8f-b56f-3132f9263fe0</ops:relatedResources>
        </ops:resourceRelations>
    </ops:resourcesRelations>
</ops:resources-relation>
{
  "pageInfo" : null,
  "relationshipType" : "DESCENDANT",
  "resourceRelations" : [ {
    "resource" : {
      "description" : null,
      "creationTime" : 1523035909688,
      "resourceKey" : {
        "name" : "VM1",
        "adapterKindKey" : "VMWARE",
        "resourceKindKey" : "VirtualMachine",
        "resourceIdentifier" : [ {
          "identifierType" : {
            "name" : "VMEntityObjectID",
            "dataType" : "STRING",
            "isPartOfUniqueness" : true,
            "extension" : null,
            "links" : null
          },
          "value" : "vm-123",
          "links" : null
        }, {
          "identifierType" : {
            "name" : "VMEntityVCID",
            "dataType" : "STRING",
            "isPartOfUniqueness" : true,
            "extension" : null,
            "links" : null
          },
          "value" : "CBAD174A-622E-4650-805A-064F824FFA76",
          "links" : null
        }, {
          "identifierType" : {
            "name" : "VMEntityName",
            "dataType" : "STRING",
            "isPartOfUniqueness" : true,
            "extension" : null,
            "links" : null
          },
          "value" : "VM1",
          "links" : null
        } ],
        "links" : null,
        "extension" : null
      },
      "credentialInstanceId" : "51f8f60d-4a39-4839-9924-698d022e2e10",
      "geoLocation" : null,
      "resourceStatusState" : [ ],
      "resourceHealth" : null,
      "resourceHealthValue" : null,
      "dtEnabled" : true,
      "monitoringInterval" : null,
      "badge" : [ ],
      "relatedResources" : [ ],
      "extension" : null,
      "links" : null,
      "identifier" : "1ea33976-5836-4331-a24a-f7e2b05866c0"
    },
    "relatedResources" : [ "889beb66-3cd6-42b1-b6bb-122a9f14e2cf", "fbb0c298-bd54-4bb2-b51d-48ec551ccd99" ],
    "extension" : null,
    "links" : null
  } ],
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404, 500
Descriptions
200 - If API successfully returns the requested Resources
404 - If could find none of the resources from ResourceRelationshipsQuery.resourceIds
500 - If there is an error during the query
Response type
<ns3:resources-relation/>

GET /api/resources/{id}/statkeys

Get all the stat keys for the specified Resource.

The returned data will be in either a XML or JSON format.
Examples of output in XML and JSON format:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:stat-keys xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:stat-key>
        <ops:key>cpu|demand</ops:key>
    </ops:stat-key>
    <ops:stat-key>
        <ops:key>cpu|usage</ops:key>
    </ops:stat-key>
</ops:stat-keys>
{
  "stat-key" : [ {
    "key" : "cpu|demand"
  }, {
    "key" : "cpu|usage"
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:stat-keys/>

GET /api/resources/statkeys

Gets all the available Stat Keys and their details for the specified set of Resources.
Sample URI:

/api/resources/statkeys?resourceId=UUID1&resourceId=UUID2

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:stat-keys xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:stat-key>
        <ops:key>cpu|demand</ops:key>
    </ops:stat-key>
    <ops:stat-key>
        <ops:key>cpu|usage</ops:key>
    </ops:stat-key>
</ops:stat-keys>
{
  "stat-key" : [ {
    "key" : "cpu|demand"
  }, {
    "key" : "cpu|usage"
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
resourceId The identifiers of the Resources to retrieve a list of available for query xs:uuid yes no
searchstring an optional wildcard search string that allows user to refine the list of returned Stat Key details by key name. Usage is similar to a LIKE "%searchstring%" query xs:string no no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:stat-keys/>

POST /api/resources/stats/dt/query

Get Stats and Dynamic Threshold values for one or more StatKeys and for a Collection of Resources.
The API returns 24 hours of Stats and DT data by default for the specified Resources.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:dt-stat-query xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceIds>1c71d5ce-dc8e-4397-a29b-64595c7fab57 ff3223d0-43e7-47df-ac40-254563475002</ops:resourceIds>
    <ops:statKeys>stat|key1; stat|key2 stat|key3; stat|key4</ops:statKeys>
    <ops:begin>1523035909280</ops:begin>
    <ops:end>1523035909281</ops:end>
    <ops:showSmooth>true</ops:showSmooth>
    <ops:smoothFactor>2.0</ops:smoothFactor>
</ops:dt-stat-query>
{
  "resourceIds" : [ "11d58ee1-00b8-4e95-9c7f-e3f2d0c19842", "df9218b9-15a8-4b2c-b379-8fffb5fffe95" ],
  "statKeys" : [ "stat|key1; stat|key2", "stat|key3; stat|key4" ],
  "begin" : 1523035909295,
  "end" : 1523035909295,
  "showSmooth" : true,
  "smoothFactor" : 2.0
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:stats-of-resources/>

POST /api/resources/stats/dt/query

Gets Stats (time-series) data and Dynamic Threshold values for one or more StatKeys and for a Collection of Resources in CSV format.
This API is equivalent to other Stats and DT query APIs except that the response of the API is a CSV file which the client gets to download locally.
The API client makes the same POST /api/resources/stats/dt/query call but instead of setting the 'Accept' header to "application/xml" or "application/json", the header value needs to be text/csv.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:dt-stat-query xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceIds>d91647f3-05d1-4da6-8aab-e742e836d199 8f792c3c-198d-4621-919a-503a8324113f</ops:resourceIds>
    <ops:statKeys>stat|key1; stat|key2 stat|key3; stat|key4</ops:statKeys>
    <ops:begin>1523035909296</ops:begin>
    <ops:end>1523035909296</ops:end>
    <ops:showSmooth>true</ops:showSmooth>
    <ops:smoothFactor>2.0</ops:smoothFactor>
</ops:dt-stat-query>
{
  "resourceIds" : [ "be8bf87a-bb2a-4173-90e8-ef24042c90f1", "d7c6cc17-b947-47ab-aa09-2e2b4f730bc1" ],
  "statKeys" : [ "stat|key1; stat|key2", "stat|key3; stat|key4" ],
  "begin" : 1523035909309,
  "end" : 1523035909309,
  "showSmooth" : true,
  "smoothFactor" : 2.0
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:stats-of-resources/>

POST /api/resources/{id}/stats/query

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

Sample Request in XML and JSON formats:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:stat-query xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceId>30f9ef10-7a06-4da3-938b-7ceb6a3f7c39 e11a431a-0267-491a-acf9-f6868032ba85</ops:resourceId>
    <ops:statKey>stat|key1; stat|key2 stat|key3; stat|key4</ops:statKey>
    <ops:begin>1523035909847</ops:begin>
    <ops:end>1523035909847</ops:end>
    <ops:rollUpType>SUM</ops:rollUpType>
    <ops:intervalType>DAYS</ops:intervalType>
    <ops:intervalQuantifier>-1</ops:intervalQuantifier>
    <ops:dt>false</ops:dt>
    <ops:latestMaxSamples>10</ops:latestMaxSamples>
    <ops:metrics>false</ops:metrics>
    <ops:currentOnly>false</ops:currentOnly>
</ops:stat-query>
{
  "resourceId" : [ "54879cb7-6066-4de9-b6ac-b058ca46e36a", "e4cd3b99-017c-48ff-abc5-b9e8e402ec07" ],
  "statKey" : [ "stat|key1; stat|key2", "stat|key3; stat|key4" ],
  "begin" : 1523035909860,
  "end" : 1523035909860,
  "rollUpType" : "SUM",
  "intervalType" : "DAYS",
  "intervalQuantifier" : -1,
  "dt" : false,
  "latestMaxSamples" : 10,
  "metrics" : false,
  "currentOnly" : false
}

Sample Response in XML and JSON formats:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:stats-of-resources xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:stats-of-resource>
        <ops:resourceId>9915b83e-445e-41c2-be59-36d1f8bcbd21</ops:resourceId>
        <ops:stat-list>
            <ops:stat>
                <ops:timestamps>1523035909860 1523035919860</ops:timestamps>
                <ops:statKey>
                    <ops:key>stat|key1</ops:key>
                </ops:statKey>
                <ops:rollUpType>NONE</ops:rollUpType>
                <ops:intervalUnit>
                    <ops:quantifier>5</ops:quantifier>
                    <ops:intervalType>MINUTES</ops:intervalType>
                </ops:intervalUnit>
                <ops:data>1.0 2.0</ops:data>
                <ops:dtTimestamps>1523035909860 1523035919860 1523035929860</ops:dtTimestamps>
                <ops:minThresholdData>0.5 1.0</ops:minThresholdData>
                <ops:maxThresholdData>1.5 3.0</ops:maxThresholdData>
                <ops:smoothValues>1.5 1.5</ops:smoothValues>
            </ops:stat>
        </ops:stat-list>
    </ops:stats-of-resource>
</ops:stats-of-resources>
{
  "values" : [ {
    "resourceId" : "90a7ed2f-6fab-4cdb-8106-81fcd4a7ad4c",
    "stat-list" : {
      "stat" : [ {
        "timestamps" : [ 1523035909873, 1523035919873 ],
        "statKey" : {
          "key" : "stat|key1"
        },
        "rollUpType" : "NONE",
        "intervalUnit" : {
          "quantifier" : 5,
          "intervalType" : "MINUTES"
        },
        "data" : [ 1.0, 2.0 ],
        "values" : null,
        "dtTimestamps" : [ 1523035909873, 1523035919873, 1523035929873 ],
        "minThresholdData" : [ 0.5, 1.0 ],
        "maxThresholdData" : [ 1.5, 3.0 ],
        "smoothValues" : [ 1.5, 1.5 ],
        "links" : null
      } ]
    }
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:stats-of-resources/>

POST /api/resources/stats/query

Gets stats for one or more Resources using the specific query spec.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:stat-query xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceId>5e2eda38-f5d3-4042-97b4-6de513165d23 5c803b4b-3c8c-4db2-9fd8-d421f32f9cf5</ops:resourceId>
    <ops:statKey>stat|key1; stat|key2 stat|key3; stat|key4</ops:statKey>
    <ops:begin>1523035909344</ops:begin>
    <ops:end>1523035909344</ops:end>
    <ops:rollUpType>SUM</ops:rollUpType>
    <ops:intervalType>DAYS</ops:intervalType>
    <ops:intervalQuantifier>-1</ops:intervalQuantifier>
    <ops:dt>false</ops:dt>
    <ops:latestMaxSamples>10</ops:latestMaxSamples>
    <ops:metrics>false</ops:metrics>
    <ops:currentOnly>false</ops:currentOnly>
</ops:stat-query>
{
  "resourceId" : [ "362911a9-926b-4fdd-bc6f-9d78011a0f2d", "a174a6e6-4dd8-4160-bad5-6f016c1a8c21" ],
  "statKey" : [ "stat|key1; stat|key2", "stat|key3; stat|key4" ],
  "begin" : 1523035909362,
  "end" : 1523035909362,
  "rollUpType" : "SUM",
  "intervalType" : "DAYS",
  "intervalQuantifier" : -1,
  "dt" : false,
  "latestMaxSamples" : 10,
  "metrics" : false,
  "currentOnly" : false
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:stats-of-resources xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:stats-of-resource>
        <ops:resourceId>8ea54890-1567-46e6-b591-f76cf5185964</ops:resourceId>
        <ops:stat-list>
            <ops:stat>
                <ops:timestamps>1523035909367 1523035919367</ops:timestamps>
                <ops:statKey>
                    <ops:key>stat|key1</ops:key>
                </ops:statKey>
                <ops:rollUpType>NONE</ops:rollUpType>
                <ops:intervalUnit>
                    <ops:quantifier>5</ops:quantifier>
                    <ops:intervalType>MINUTES</ops:intervalType>
                </ops:intervalUnit>
                <ops:data>1.0 2.0</ops:data>
                <ops:dtTimestamps>1523035909367 1523035919367 1523035929367</ops:dtTimestamps>
                <ops:minThresholdData>0.5 1.0</ops:minThresholdData>
                <ops:maxThresholdData>1.5 3.0</ops:maxThresholdData>
                <ops:smoothValues>1.5 1.5</ops:smoothValues>
            </ops:stat>
        </ops:stat-list>
    </ops:stats-of-resource>
</ops:stats-of-resources>
{
  "values" : [ {
    "resourceId" : "34bcbb6d-6f88-4b7d-8cbc-f62a3bf95fae",
    "stat-list" : {
      "stat" : [ {
        "timestamps" : [ 1523035909402, 1523035919402 ],
        "statKey" : {
          "key" : "stat|key1"
        },
        "rollUpType" : "NONE",
        "intervalUnit" : {
          "quantifier" : 5,
          "intervalType" : "MINUTES"
        },
        "data" : [ 1.0, 2.0 ],
        "values" : null,
        "dtTimestamps" : [ 1523035909402, 1523035919402, 1523035929402 ],
        "minThresholdData" : [ 0.5, 1.0 ],
        "maxThresholdData" : [ 1.5, 3.0 ],
        "smoothValues" : [ 1.5, 1.5 ],
        "links" : null
      } ]
    }
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:stats-of-resources/>

GET /api/resources/{id}/stats

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

The request should have the following query parameters

Examples in XML and JSON format:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:stats-of-resources xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:stats-of-resource>
        <ops:resourceId>d0e9bde2-120a-466e-8853-714847dcca71</ops:resourceId>
        <ops:stat-list>
            <ops:stat>
                <ops:timestamps>1523035909901 1523035919901</ops:timestamps>
                <ops:statKey>
                    <ops:key>stat|key1</ops:key>
                </ops:statKey>
                <ops:rollUpType>NONE</ops:rollUpType>
                <ops:intervalUnit>
                    <ops:quantifier>5</ops:quantifier>
                    <ops:intervalType>MINUTES</ops:intervalType>
                </ops:intervalUnit>
                <ops:data>1.0 2.0</ops:data>
                <ops:dtTimestamps>1523035909901 1523035919901 1523035929901</ops:dtTimestamps>
                <ops:minThresholdData>0.5 1.0</ops:minThresholdData>
                <ops:maxThresholdData>1.5 3.0</ops:maxThresholdData>
                <ops:smoothValues>1.5 1.5</ops:smoothValues>
            </ops:stat>
        </ops:stat-list>
    </ops:stats-of-resource>
</ops:stats-of-resources>
{
  "values" : [ {
    "resourceId" : "b37a5b4a-ef30-4429-8e4c-4cdcdc79e175",
    "stat-list" : {
      "stat" : [ {
        "timestamps" : [ 1523035909914, 1523035919914 ],
        "statKey" : {
          "key" : "stat|key1"
        },
        "rollUpType" : "NONE",
        "intervalUnit" : {
          "quantifier" : 5,
          "intervalType" : "MINUTES"
        },
        "data" : [ 1.0, 2.0 ],
        "values" : null,
        "dtTimestamps" : [ 1523035909914, 1523035919914, 1523035929914 ],
        "minThresholdData" : [ 0.5, 1.0 ],
        "maxThresholdData" : [ 1.5, 3.0 ],
        "smoothValues" : [ 1.5, 1.5 ],
        "links" : null
      } ]
    }
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
begin The beginning date as a long value of the range of stats to return
Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC		 query xs:long no no
currentOnly query xs:boolean no no
dt Indicates that the requested stats are based on some dynamic threshold. Defaults to false which indicates that stats are not based on dynamic threshold. query xs:boolean no no
end The ending date as a long value of the range of stats to return
Long value is number of milliseconds since January 1, 1970 00:00:00 UTC		 query xs:long no no
intervalQuantifier Number for the interval type query xs:int no no
intervalType Interval type requested by the user (e.g: Days, Weeks, Months etc.) query <ns3:intervalType> no no
latestMaxSamples the maximum number of samples to return when querying latest. When processing the get latest stats query if it is omitted a value of 1 is assumed.
A query for the latest samples is not compatible with specifying the RollUpType value.		 query xs:int no no
metrics Indicates whether specified statKey-s of query should be forcibly treated as metrics query xs:boolean no no
resourceId Array of Resource ids to fetch the stats for query xs:uuid no yes
rollUpType Rollup Type requested by the user (e.g.: AVG, MIN, MAX etc.) query <ns3:rollUpType> no no
statKey Array of stat keys to return the stats for query xs:string no yes
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:stats-of-resources/>

GET /api/resources/stats

Gets stats for one or more Resources using the specific query spec.
This is a GET endpoint and the query parameters control the data that is retrieved.
If the number of Resources for which one needs to query data is large, it is recommended to use the POST /api/stats/query endpoint to avoid the URL length limitations.
Takes the form:

api/resources/stats?resourceId=UUID1 OR
api/resources/stats?resourceId=UUID2&statKey=cpu|usagemhz&rollUpType=&begin=&end=

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
begin The beginning date as a long value of the range of stats to return
Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC		 query xs:long no no
currentOnly query xs:boolean no no
dt Indicates that the requested stats are based on some dynamic threshold. Defaults to false which indicates that stats are not based on dynamic threshold. query xs:boolean no no
end The ending date as a long value of the range of stats to return
Long value is number of milliseconds since January 1, 1970 00:00:00 UTC		 query xs:long no no
intervalQuantifier Number for the interval type query xs:int no no
intervalType Interval type requested by the user (e.g: Days, Weeks, Months etc.) query <ns3:intervalType> no no
latestMaxSamples the maximum number of samples to return when querying latest. When processing the get latest stats query if it is omitted a value of 1 is assumed.
A query for the latest samples is not compatible with specifying the RollUpType value.		 query xs:int no no
metrics Indicates whether specified statKey-s of query should be forcibly treated as metrics query xs:boolean no no
resourceId Array of Resource ids to fetch the stats for query xs:uuid no yes
rollUpType Rollup Type requested by the user (e.g.: AVG, MIN, MAX etc.) query <ns3:rollUpType> no no
statKey Array of stat keys to return the stats for query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:stats-of-resources/>

GET /api/resources/stats

Gets Stats (time-series) data of several Resources in CSV format.
This API is equivalent to other stats query APIs except that the response of the API is a CSV file which the client gets to download locally.
The API client makes the same GET /api/resources/stats call but instead of setting the Accept header to "application/xml" or "application/json", the header value needs to be text/csv.

Takes the form:

HTTP 'Accept' header set to 'text/csv' (i.e. "Accept" = "text/csv")
/api/resources/stats?resourceId=UUID1 OR
/api/resources/stats?resourceId=UUID2&statKey=cpu|usagemhz&rollUpType=AVG&begin=&end=

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
begin The beginning date as a long value of the range of stats to return
Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC		 query xs:long no no
currentOnly query xs:boolean no no
dt Indicates that the requested stats are based on some dynamic threshold. Defaults to false which indicates that stats are not based on dynamic threshold. query xs:boolean no no
end The ending date as a long value of the range of stats to return
Long value is number of milliseconds since January 1, 1970 00:00:00 UTC		 query xs:long no no
intervalQuantifier Number for the interval type query xs:int no no
intervalType Interval type requested by the user (e.g: Days, Weeks, Months etc.) query <ns3:intervalType> no no
latestMaxSamples the maximum number of samples to return when querying latest. When processing the get latest stats query if it is omitted a value of 1 is assumed.
A query for the latest samples is not compatible with specifying the RollUpType value.		 query xs:int no no
metrics Indicates whether specified statKey-s of query should be forcibly treated as metrics query xs:boolean no no
resourceId Array of Resource ids to fetch the stats for query xs:uuid no yes
rollUpType Rollup Type requested by the user (e.g.: AVG, MIN, MAX etc.) query <ns3:rollUpType> no no
statKey Array of stat keys to return the stats for query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:stats-of-resources/>

GET /api/resources/{id}/stats/topn

Get the TopN stats for a given Resource and given a set of attributes.
Examples in XML and JSON format:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resourceStatGroupList xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:groupBy>RESOURCE</ops:groupBy>
    <ops:sortOrder>ASCENDING</ops:sortOrder>
    <ops:resourceStatGroups>
        <ops:resourceStatGroup>
            <ops:groupKey>47b21dd6-5f84-466c-96a1-fab3c60d5a0e</ops:groupKey>
            <ops:resourceStats/>
        </ops:resourceStatGroup>
        <ops:resourceStatGroup>
            <ops:groupKey>12bb4a1e-e46d-4355-b64c-b643a9e5b744</ops:groupKey>
            <ops:resourceStats/>
        </ops:resourceStatGroup>
    </ops:resourceStatGroups>
</ops:resourceStatGroupList>
{
  "groupBy" : "RESOURCE",
  "sortOrder" : "ASCENDING",
  "resourceStatGroup" : [ {
    "groupKey" : "604016d1-6728-462a-ac78-be6161900fa2",
    "resourceStat" : [ ],
    "links" : null
  }, {
    "groupKey" : "6b394d25-a4ad-4b17-ac55-c6c34887793d",
    "resourceStat" : [ ],
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
begin The beginning date as a long value of the range of stats to return
Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC		 query xs:long no no
currentOnly query xs:boolean no no
dt Indicates that the requested stats are based on some dynamic threshold. Defaults to false which indicates that stats are not based on dynamic threshold. query xs:boolean no no
end The ending date as a long value of the range of stats to return
Long value is number of milliseconds since January 1, 1970 00:00:00 UTC		 query xs:long no no
groupBy query <ns3:groupBy> no no
intervalQuantifier Number for the interval type query xs:int no no
intervalType Interval type requested by the user (e.g: Days, Weeks, Months etc.) query <ns3:intervalType> no no
latestMaxSamples the maximum number of samples to return when querying latest. When processing the get latest stats query if it is omitted a value of 1 is assumed.
A query for the latest samples is not compatible with specifying the RollUpType value.		 query xs:int no no
metrics Indicates whether specified statKey-s of query should be forcibly treated as metrics query xs:boolean no no
resourceId Array of Resource ids to fetch the stats for query xs:uuid no yes
rollUpType Rollup Type requested by the user (e.g.: AVG, MIN, MAX etc.) query <ns3:rollUpType> no no
sortOrder query <ns3:sort-order> no no
statKey Array of stat keys to return the stats for query xs:string no yes
topN query xs:int no no
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:resourceStatGroupList/>

GET /api/resources/stats/topn

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

Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resourceStatGroupList xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:groupBy>RESOURCE</ops:groupBy>
    <ops:sortOrder>ASCENDING</ops:sortOrder>
    <ops:resourceStatGroups>
        <ops:resourceStatGroup>
            <ops:groupKey>f0544bcf-4144-4b53-aae3-9db3ecf77ff5</ops:groupKey>
            <ops:resourceStats/>
        </ops:resourceStatGroup>
        <ops:resourceStatGroup>
            <ops:groupKey>15fdd76e-bfef-4e01-bac7-9d584dfa7cb3</ops:groupKey>
            <ops:resourceStats/>
        </ops:resourceStatGroup>
    </ops:resourceStatGroups>
</ops:resourceStatGroupList>
{
  "groupBy" : "RESOURCE",
  "sortOrder" : "ASCENDING",
  "resourceStatGroup" : [ {
    "groupKey" : "1650861f-0417-4faf-beb6-200eea650125",
    "resourceStat" : [ ],
    "links" : null
  }, {
    "groupKey" : "b8003dbd-8627-4ef8-b6ef-3c22d3759b35",
    "resourceStat" : [ ],
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
begin The beginning date as a long value of the range of stats to return
Value measures the number of milliseconds since January 1, 1970 00:00:00 UTC		 query xs:long no no
currentOnly query xs:boolean no no
dt Indicates that the requested stats are based on some dynamic threshold. Defaults to false which indicates that stats are not based on dynamic threshold. query xs:boolean no no
end The ending date as a long value of the range of stats to return
Long value is number of milliseconds since January 1, 1970 00:00:00 UTC		 query xs:long no no
groupBy query <ns3:groupBy> no no
intervalQuantifier Number for the interval type query xs:int no no
intervalType Interval type requested by the user (e.g: Days, Weeks, Months etc.) query <ns3:intervalType> no no
latestMaxSamples the maximum number of samples to return when querying latest. When processing the get latest stats query if it is omitted a value of 1 is assumed.
A query for the latest samples is not compatible with specifying the RollUpType value.		 query xs:int no no
metrics Indicates whether specified statKey-s of query should be forcibly treated as metrics query xs:boolean no no
resourceId Array of Resource ids to fetch the stats for query xs:uuid no yes
rollUpType Rollup Type requested by the user (e.g.: AVG, MIN, MAX etc.) query <ns3:rollUpType> no no
sortOrder query <ns3:sort-order> no no
statKey Array of stat keys to return the stats for query xs:string no yes
topN query xs:int no no

Response http response codes, description about schema of return types

HTTP Response Codes
Response type
<ns3:resourceStatGroupList/>

PUT /api/resources/{id}/maintained

Put the specific Resource in Maintenance.
The Resource can end up in two maintenance states - MAINTAINED OR MAINTAINED_MANUAL - depending upon the inputs specified.

  • If duration/end time is specified, the resource will be placed in MAINTAINED state and after the duration/end time expires, the resource state is automatically set to the state it was in before entering the maintenance window.
  • If duration/end time is not specified, the resource will be placed in MAINTAINED_MANUAL state. Callers have to execute DELETE /suite-api/api/resources/{id}/maintained API to set the Resource back to whatever state it was in.
  • If both duration and end time are specified, end time takes preference over duration.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
duration Duration for which this resource will be in maintenance (In Minutes) query xs:int no no
end query xs:long no no
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

PUT /api/resources/maintained

Puts all the specified Resource in Maintenance.
The Resources can end up in two maintenance states - MAINTAINED OR MAINTAINED_MANUAL - depending upon the inputs specified.

  • If duration/end time is specified, the Resources will be placed in MAINTAINED state and after the duration/end time expires, the state of the Resources would be automatically set to the state they were in before entering the maintenance window.
  • If duration/end time is not specified, the Resources will be placed in MAINTAINED_MANUAL state. Callers have to execute DELETE /suite-api/api/resources/maintained?id=ID1&id=ID2 API to set the Resources back to whatever state they were in.
  • If both duration and end time are specified, end time takes preference over duration.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id Resource identifier query xs:uuid yes yes
duration Duration for which this resource will be in maintenance (In Minutes) query xs:int no no
end query xs:long no no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

POST /api/resources/properties/latest/query

Gets current (latest) values of requested properties for the specified resources.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:properties-query xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceIds>91c8ba06-681f-46b7-af00-91b4513ca8a6 43560350-1e70-46a4-88ee-52b510efe958</ops:resourceIds>
    <ops:propertyKeys>prop|key1 prop|key2</ops:propertyKeys>
</ops:properties-query>
{
  "resourceIds" : [ "bb9635f6-3fcc-4fa4-9361-518dd08428bf", "1eef15ff-a6a9-452a-aea7-1ba065decaac" ],
  "propertyKeys" : [ "prop|key1", "prop|key2" ]
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:resources-property-contents xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resource-property-contents>
        <ops:resourceId>21eb224e-9839-4b43-b379-6d1018b393da</ops:resourceId>
        <ops:property-contents>
            <ops:property-content statKey="system|availability">
                <ops:timestamps>1119844280663</ops:timestamps>
                <ops:timestamps>1119844280693</ops:timestamps>
                <ops:timestamps>1119844280713</ops:timestamps>
                <ops:values>UP</ops:values>
                <ops:values>UP</ops:values>
                <ops:values>DOWN</ops:values>
            </ops:property-content>
            <ops:property-content statKey="config|num|processes">
                <ops:timestamps>1119844280663</ops:timestamps>
                <ops:timestamps>1119844280693</ops:timestamps>
                <ops:timestamps>1119844280713</ops:timestamps>
                <ops:timestamps>1119844280718</ops:timestamps>
                <ops:data>93.0</ops:data>
                <ops:data>95.0</ops:data>
                <ops:data>97.0</ops:data>
                <ops:data>99.0</ops:data>
            </ops:property-content>
        </ops:property-contents>
    </ops:resource-property-contents>
    <ops:resource-property-contents>
        <ops:resourceId>ca944b8c-731d-4618-a5f6-874459f893bb</ops:resourceId>
        <ops:property-contents>
            <ops:property-content statKey="system|availability">
                <ops:timestamps>1119844280663</ops:timestamps>
                <ops:timestamps>1119844280693</ops:timestamps>
                <ops:timestamps>1119844280713</ops:timestamps>
                <ops:values>UP</ops:values>
                <ops:values>UP</ops:values>
                <ops:values>DOWN</ops:values>
            </ops:property-content>
            <ops:property-content statKey="config|num|processes">
                <ops:timestamps>1119844280663</ops:timestamps>
                <ops:timestamps>1119844280693</ops:timestamps>
                <ops:timestamps>1119844280713</ops:timestamps>
                <ops:timestamps>1119844280718</ops:timestamps>
                <ops:data>93.0</ops:data>
                <ops:data>95.0</ops:data>
                <ops:data>97.0</ops:data>
                <ops:data>99.0</ops:data>
            </ops:property-content>
        </ops:property-contents>
    </ops:resource-property-contents>
</ops:resources-property-contents>
{
  "values" : [ {
    "resourceId" : "63d698c5-511b-4a5b-b737-ef1a7aaa5690",
    "property-contents" : {
      "property-content" : [ {
        "statKey" : "system|availability",
        "timestamps" : [ 1119844280663, 1119844280693, 1119844280713 ],
        "data" : null,
        "values" : [ "UP", "UP", "DOWN" ]
      }, {
        "statKey" : "config|num|processes",
        "timestamps" : [ 1119844280663, 1119844280693, 1119844280713, 1119844280718 ],
        "data" : [ 93.0, 95.0, 97.0, 99.0 ],
        "values" : null
      } ]
    }
  }, {
    "resourceId" : "f42fa643-95b8-4d18-9cc1-f14c3beb64b2",
    "property-contents" : {
      "property-content" : [ {
        "statKey" : "system|availability",
        "timestamps" : [ 1119844280663, 1119844280693, 1119844280713 ],
        "data" : null,
        "values" : [ "UP", "UP", "DOWN" ]
      }, {
        "statKey" : "config|num|processes",
        "timestamps" : [ 1119844280663, 1119844280693, 1119844280713, 1119844280718 ],
        "data" : [ 93.0, 95.0, 97.0, 99.0 ],
        "values" : null
      } ]
    }
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:resources-property-contents/>

POST /api/resources/stats/latest/query

Retrieves the last "maxSamples" stats values for specified one or more Resources.
Sample Request:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:latest-stat-query xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:resourceId>ab493bcb-eda5-458d-8b6e-59ad47580164 271d01f4-f15a-4b86-bbd1-82d1d0dc736e</ops:resourceId>
    <ops:statKey>stat|key1 stat|key2</ops:statKey>
    <ops:metrics>false</ops:metrics>
    <ops:currentOnly>false</ops:currentOnly>
    <ops:maxSamples>1</ops:maxSamples>
</ops:latest-stat-query>
{
  "resourceId" : [ "73a05ad3-7802-4e4e-b2e9-0e046b65590c", "fbde5905-34e1-41c3-a8d0-0f93a8b0e9ce" ],
  "statKey" : [ "stat|key1", "stat|key2" ],
  "metrics" : false,
  "currentOnly" : false,
  "maxSamples" : 1
}

Sample Response:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:stats-of-resources xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:stats-of-resource>
        <ops:resourceId>d9163cd2-d0f2-4309-975f-fb01bd3beab9</ops:resourceId>
        <ops:stat-list>
            <ops:stat>
                <ops:timestamps>1523035909422 1523035919422</ops:timestamps>
                <ops:statKey>
                    <ops:key>stat|key1</ops:key>
                </ops:statKey>
                <ops:rollUpType>NONE</ops:rollUpType>
                <ops:intervalUnit>
                    <ops:quantifier>5</ops:quantifier>
                    <ops:intervalType>MINUTES</ops:intervalType>
                </ops:intervalUnit>
                <ops:data>1.0 2.0</ops:data>
                <ops:dtTimestamps>1523035909422 1523035919422 1523035929422</ops:dtTimestamps>
                <ops:minThresholdData>0.5 1.0</ops:minThresholdData>
                <ops:maxThresholdData>1.5 3.0</ops:maxThresholdData>
                <ops:smoothValues>1.5 1.5</ops:smoothValues>
            </ops:stat>
        </ops:stat-list>
    </ops:stats-of-resource>
</ops:stats-of-resources>
{
  "values" : [ {
    "resourceId" : "52008ddc-96a2-4d56-afe1-d0a86042edfa",
    "stat-list" : {
      "stat" : [ {
        "timestamps" : [ 1523035909435, 1523035919435 ],
        "statKey" : {
          "key" : "stat|key1"
        },
        "rollUpType" : "NONE",
        "intervalUnit" : {
          "quantifier" : 5,
          "intervalType" : "MINUTES"
        },
        "data" : [ 1.0, 2.0 ],
        "values" : null,
        "dtTimestamps" : [ 1523035909435, 1523035919435, 1523035929435 ],
        "minThresholdData" : [ 0.5, 1.0 ],
        "maxThresholdData" : [ 1.5, 3.0 ],
        "smoothValues" : [ 1.5, 1.5 ],
        "links" : null
      } ]
    }
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404, 500
Descriptions
404 - If could find none of the resources from LatestStatQuery.resourceId.
500 - If there is an error during the query.
200 - If API successfully returns the requested stats.
Response type
<ns3:stats-of-resources/>

PUT /api/resources/{id}/relationships/{relationshipType}

Set (Replace) Resources as RelationshipType of a specific Resource.
This API exposes replace semantics. Therefore, all the existing relationships of the specified relationshipType will be removed and replaced with the resources specified as part of the request body.

  • If all of the Resources that are part of the relatedIds list are invalid/non-existent then the API returns a 404 error.
  • If at least a few of the Resources that are part of relatedIds list are valid resources then the operation is performed.
  • If there are few Resources that are part of relatedIds list that will result in a cyclical relationship, then the operation is aborted.


NOTE: Setting relationship is not synchronous. As a result, the set operation may not happen immediately. It is recommended to query the relationships of the specific Resource back to ensure that the operation was indeed successful.


Sample Request:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:uuid-values xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:uuids>ee5892db-4fc5-41cc-8917-a11e008aa2e2 7a50752f-f41f-43e2-91d6-4c548646872d</ops:uuids>
</ops:uuid-values>
{
  "uuids" : [ "d28738a6-2ee0-4cbf-9e5a-6bc2bf836c02", "a5e28314-04c6-4da4-9ade-a3e65886e894" ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
relationshipType The type of relationship of the Resources; Uses the RelationshipType.representation value. Allowed values are: PARENT, CHILD, ALL. template xs:string yes no
id template xs:uuid yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

PUT /api/resources/{id}/monitoringstate/start

Inform one or more or all Adapters to start monitoring this Resource.
The optional query parameter adapterId determines which of the Adapters need to be informed to start monitoring the Resource. If this is not specified, then all of the Adapters will start monitoring the Resource.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
adapterId Collection of adapter instance identifiers that should start monitoring this Resource query xs:uuid no yes
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

PUT /api/resources/monitoringstate/start

Inform one or more or all Adapters to start monitoring a Collection of Resources.
The query parameter id is for specifying the set of Resources that should be monitored.
The optional query parameter adapterId determines which of the Adapters need to be informed to start monitoring the Resources. If this is not specified, then all of the Adapters will start monitoring the specified Resources.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The Resource identifiers that no longer need to be monitoried query xs:uuid yes yes
adapterId Collection of adapter instance identifiers that should start monitoring the Resources query xs:uuid no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

PUT /api/resources/{id}/monitoringstate/stop

Inform one or more or all Adapters to stop monitoring this Resource.
The optional query parameter adapterId determines which of the Adapters need to be informed to stop monitoring the Resource. If this is not specified, then all of the Adapters will stop monitoring the Resource.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
adapterId Collection of adapter instance identifiers that should stop monitoring this Resource query xs:uuid no yes
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

PUT /api/resources/monitoringstate/stop

Inform one or more or all Adapters to stop monitoring a Collection of Resources.
The query parameter id is for specifying the set of Resources that should no longer be monitored.
The optional query parameter adapterId determines which of the Adapters need to be informed to stop monitoring the Resources. If this is not specified, then all of the Adapters will stop monitoring the specified Resources.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The Resource identifiers that no longer need to be monitoried query xs:uuid yes yes
adapterId Collection of adapter instance identifiers that should stop monitoring the Resources query xs:uuid no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

DELETE /api/resources/{id}/maintained

Bring the Resource out of Maintenance manually.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

DELETE /api/resources/maintained

Bring the specified set of Resources out of Maintenance manually.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id A collection of Resource identifiers query xs:uuid yes yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

PUT /api/resources/{id}/geolocation

Updates the geographical location of the Resource.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
latitude latitude of the location. query xs:double yes no
longitude longitude of the location query xs:double yes no
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
No content returned by this method.

PUT /api/resources

Updates a Resource in the system.
Implementation Notes:

  • When updating a Resource, if the Resource Identifiers that are unique and required are not specified, the API would return an error with HTTP status code of 500 and an error message indicating the set of missing Resource Identifiers.
  • When updating a Resource, if the Resource Identifiers that are unique but not required are not specified, the Resource is updated where the uniquely identifying Resource Identifiers that were not specified will have their value as an empty string.

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404, 500
Descriptions
404 - If there is no Resource in the system corresponding to the identifier in the Request Body.
500 - If the ResourceKey of the Resource is missing the uniquely identifying and required Resource Identifiers.
Response type
<ns3:resource/>

POST /api/solutions/{solutionId}/licenses

Add a license key for a solution.. Only licenseKey needs to be populated in the request object. Other fields will be set as a part of response.

Sample Request in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:solution-licenses xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:solution-license licenseKey="R502G-N0Z0J-N8U88-0QPRK-AADER"/>
</ops:solution-licenses>
Sample Response in XML format
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:solution-licenses xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:solution-license licenseKey="R502G-N0Z0J-N8U88-0QPRK-AADER" id="928da069-b5db-4312-b073-34869763ef6e">
        <ops:expirationDate>1523035909114</ops:expirationDate>
        <ops:capacity> 100 Virtual Machines</ops:capacity>
        <ops:usage> 120 Virtual Machines</ops:usage>
    </ops:solution-license>
</ops:solution-licenses>
Sample Request in JSON format
Show
{
  "solutionLicenses" : [ {
    "id" : null,
    "licenseKey" : "R502G-N0Z0J-N8U88-0QPRK-AADER",
    "expirationDate" : null,
    "capacity" : null,
    "usage" : null,
    "edition" : null,
    "links" : null
  } ]
}
Sample Response in JSON format
Show
{
  "solutionLicenses" : [ {
    "id" : "928da069-b5db-4312-b073-34869763ef6e",
    "licenseKey" : "R502G-N0Z0J-N8U88-0QPRK-AADER",
    "expirationDate" : 1523035909117,
    "capacity" : " 100 Virtual Machines",
    "usage" : " 120 Virtual Machines",
    "edition" : null,
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
solutionId template xs:string yes no

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
<ns3:solution-licenses/>

DELETE /api/solutions/{solutionId}/licenses/{licenseId}

deletes the licenseId for the solutionid from the system..

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
licenseId the Id of the license template xs:string yes no
solutionId template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

GET /api/solutions/{solutionId}/adapterkinds

get adapterkinds details for the solutionId. get data about the adapterKinds for the solutionId

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
solutionId template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:adapter-kinds/>

GET /api/solutions/{solutionId}/licenses

Get all the licenses that are currently available for a solution..

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:solution-licenses xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:solution-license licenseKey="R502G-N0Z0J-N8U88-0QPRK-AADER" id="928da069-b5db-4312-b073-34869763ef6e">
        <ops:expirationDate>1523035909109</ops:expirationDate>
        <ops:capacity> 100 Virtual Machines</ops:capacity>
        <ops:usage> 120 Virtual Machines</ops:usage>
    </ops:solution-license>
</ops:solution-licenses>
Sample Response in JSON format
Show
{
  "solutionLicenses" : [ {
    "id" : "928da069-b5db-4312-b073-34869763ef6e",
    "licenseKey" : "R502G-N0Z0J-N8U88-0QPRK-AADER",
    "expirationDate" : 1523035909111,
    "capacity" : " 100 Virtual Machines",
    "usage" : " 120 Virtual Machines",
    "edition" : null,
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
solutionId template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:solution-licenses/>

GET /api/solutions/{solutionId}

get solution data for the solutionId. get solution data for the solutionId. Data includes name, version , vendor and adapterKinds of the solution

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:solution id="VMware vSphere" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>VMware vSphere</ops:name>
    <ops:version>6.0.22</ops:version>
    <ops:description>DESCRIPTION</ops:description>
    <ops:vendor>VENDOR</ops:vendor>
    <ops:adapterKindKeys>VMWARE PythonRemediationAdapter</ops:adapterKindKeys>
</ops:solution>
Sample Response in JSON format
Show
{
  "id" : "VMware vSphere",
  "name" : "VMware vSphere",
  "version" : "6.0.22",
  "description" : "DESCRIPTION",
  "vendor" : "VENDOR",
  "adapterKindKeys" : [ "VMWARE", "PythonRemediationAdapter" ],
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
solutionId template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:solution/>

GET /api/solutions

get all solutions registered with the product. get data about all the solutions associated with vRealize Operations instance. Data includes name, version , vendor and adapterKinds of the solution

Sample Response in XML format

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:solution id="VMware vSphere" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>VMware vSphere</ops:name>
    <ops:version>6.0.22</ops:version>
    <ops:description>DESCRIPTION</ops:description>
    <ops:vendor>VENDOR</ops:vendor>
    <ops:adapterKindKeys>VMWARE PythonRemediationAdapter</ops:adapterKindKeys>
</ops:solution>
Sample Response in JSON format
Show
{
  "id" : "VMware vSphere",
  "name" : "VMware vSphere",
  "version" : "6.0.22",
  "description" : "DESCRIPTION",
  "vendor" : "VENDOR",
  "adapterKindKeys" : [ "VMWARE", "PythonRemediationAdapter" ],
  "links" : null
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:solutions/>

POST /api/supermetrics

Creates a SuperMetric with the given name, formula and description.
Sample Request in XML and JSON formats:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:supermetric xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>Example SuperMetric for DataCenter</ops:name>
    <ops:formula>sumN($This:cpu|demandmhz,2)</ops:formula>
    <ops:description>Sum the CPU usage in MHZ on the assigned resource and its children</ops:description>
</ops:supermetric>
{
  "id" : null,
  "name" : "Example SuperMetric for DataCenter",
  "formula" : "sumN($This:cpu|demandmhz,2)",
  "description" : "Sum the CPU usage in MHZ on the assigned resource and its children"
}
Sample Response in XML and JSON formats:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:supermetric xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>a439a856-14ca-4c24-ab73-0cf88efc036c</ops:id>
    <ops:name>Example SuperMetric for DataCenter</ops:name>
    <ops:formula>sumN($This:cpu|demandmhz,2)</ops:formula>
    <ops:description>Sum the CPU usage in MHZ on the assigned resource and its children</ops:description>
</ops:supermetric>
{
  "id" : "fd20ad22-43a4-4930-93de-e57af3cb7248",
  "name" : "Example SuperMetric for DataCenter",
  "formula" : "sumN($This:cpu|demandmhz,2)",
  "description" : "Sum the CPU usage in MHZ on the assigned resource and its children"
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
<ns3:supermetric/>

DELETE /api/supermetrics/{id}

Deletes a SuperMetric.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id Identifier of the SuperMetric template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

GET /api/supermetrics/{id}

Get a SuperMetric with the given id.
Sample Response in XML and JSON formats:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:supermetric xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>85dc4bd2-369d-48d7-a090-c66eb54e6e10</ops:id>
    <ops:name>Example SuperMetric for DataCenter</ops:name>
    <ops:formula>sumN($This:cpu|demandmhz,2)</ops:formula>
    <ops:description>Sum the CPU usage in MHZ on the assigned resource and its children</ops:description>
</ops:supermetric>
{
  "id" : "0efdb64a-5575-4538-a136-eb7ae65c40ec",
  "name" : "Example SuperMetric for DataCenter",
  "formula" : "sumN($This:cpu|demandmhz,2)",
  "description" : "Sum the CPU usage in MHZ on the assigned resource and its children"
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id Identifier of the SuperMetric template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:supermetric/>

GET /api/supermetrics

Gets a collection of SuperMetrics based on search parameters.
Sample Response in XML and JSON formats:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:supermetrics xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:supermetric>
        <ops:id>5d739f4b-118a-42f1-845b-db0f72215dd5</ops:id>
        <ops:name>Example SuperMetric for DataCenter</ops:name>
        <ops:formula>sumN($This:cpu|demandmhz,2)</ops:formula>
        <ops:description>Sum the CPU usage in MHZ on the assigned resource and its children</ops:description>
    </ops:supermetric>
    <ops:supermetric>
        <ops:id>c5978f9c-4762-42a2-a321-6e7dff37a331</ops:id>
        <ops:name>Example SuperMetric for DataCenter</ops:name>
        <ops:formula>sumN($This:cpu|demandmhz,2)</ops:formula>
        <ops:description>Sum the CPU usage in MHZ on the assigned resource and its children</ops:description>
    </ops:supermetric>
</ops:supermetrics>
{
  "pageInfo" : null,
  "links" : null,
  "superMetrics" : [ {
    "id" : "8e14a87a-b0b6-44a9-aa60-1006cda63533",
    "name" : "Example SuperMetric for DataCenter",
    "formula" : "sumN($This:cpu|demandmhz,2)",
    "description" : "Sum the CPU usage in MHZ on the assigned resource and its children"
  }, {
    "id" : "e89dc83e-52ec-4f2d-bf9b-50f284abe0e6",
    "name" : "Example SuperMetric for DataCenter",
    "formula" : "sumN($This:cpu|demandmhz,2)",
    "description" : "Sum the CPU usage in MHZ on the assigned resource and its children"
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
id SuperMetrics based on identifiers query xs:uuid no yes
name SuperMetrics based on names query xs:string no yes

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:supermetrics/>

PUT /api/supermetrics

Update a SuperMetric with the given name, formula and description.
Sample Request in XML and JSON formats:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:supermetric xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>19848296-54a4-422b-8bc8-eeb61cf322b2</ops:id>
    <ops:name>Example SuperMetric for DataCenter</ops:name>
    <ops:formula>sumN($This:cpu|demandmhz,2)</ops:formula>
    <ops:description>Sum the CPU usage in MHZ on the assigned resource and its children</ops:description>
</ops:supermetric>
{
  "id" : "01b774d1-b881-42b0-a294-eddd1a2c33e4",
  "name" : "Example SuperMetric for DataCenter",
  "formula" : "sumN($This:cpu|demandmhz,2)",
  "description" : "Sum the CPU usage in MHZ on the assigned resource and its children"
}
Sample Response in XML and JSON formats:
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:supermetric xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:id>db3dd3b6-99ae-473e-9cfe-c0d751e919fe</ops:id>
    <ops:name>Example SuperMetric for DataCenter</ops:name>
    <ops:formula>sumN($This:cpu|demandmhz,2)</ops:formula>
    <ops:description>Sum the CPU usage in MHZ on the assigned resource and its children</ops:description>
</ops:supermetric>
{
  "id" : "64291af9-1d45-4c2a-960a-e733c625ab9f",
  "name" : "Example SuperMetric for DataCenter",
  "formula" : "sumN($This:cpu|demandmhz,2)",
  "description" : "Sum the CPU usage in MHZ on the assigned resource and its children"
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:supermetric/>

POST /api/symptomdefinitions

Create the Symptom Definition. The symptom definition identifier must be null and will be generated by the system.
A symptom definition contains a symptom state, there may only be one symptom state per symptom definition.

Examples in XML and JSON format:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:symptom-definition cancelCycles="0" waitCycles="0" resourceKindKey="VirtualMachine" adapterKindKey="VMWARE" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>CPU Too High - only one state now allowed per symptom definition</ops:name>
    <ops:state severity="CRITICAL">
        <ops:condition xsi:type="ops:htCondition">
            <ops:key>cpu|demandmhz</ops:key>
            <ops:operator>GT_EQ</ops:operator>
            <ops:value>95</ops:value>
            <ops:valueType>NUMERIC</ops:valueType>
            <ops:instanced>false</ops:instanced>
            <ops:thresholdType>STATIC</ops:thresholdType>
        </ops:condition>
    </ops:state>
</ops:symptom-definition>
{
  "id" : null,
  "name" : "CPU Too High - only one state now allowed per symptom definition",
  "adapterKindKey" : "VMWARE",
  "resourceKindKey" : "VirtualMachine",
  "waitCycles" : 0,
  "cancelCycles" : 0,
  "state" : {
    "severity" : "CRITICAL",
    "condition" : {
      "type" : "CONDITION_HT",
      "key" : "cpu|demandmhz",
      "operator" : "GT_EQ",
      "value" : "95",
      "valueType" : "NUMERIC",
      "instanced" : false,
      "settingValue" : null,
      "targetKey" : null,
      "thresholdType" : "STATIC"
    }
  }
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
201
Response type
<ns3:symptom-definition/>

DELETE /api/symptomdefinitions/{id}

Deletes a Symptom Definition.

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The identifier of the Symptom Definition to delete template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
204
Response type
No content returned by this method.

GET /api/symptomdefinitions/{id}

Get Symptom Definition specified by id

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id The identifier of the Symptom Definition to delete template xs:string yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:symptom-definition/>

GET /api/symptomdefinitions

Get Symptom Definitions

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
adapterKind The adapter kind identifier of the symptom definitions to search for query xs:string no no
id The identifier(s) of the symptom definitions to search for. Exact match. query xs:string no yes
name The substring of the symptom definition's name to search for. Case-insensitive. query xs:string no no
resourceKind The resource kind identifier of the symptom definitions to search for query xs:string no no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:symptom-definitions/>

PUT /api/symptomdefinitions

Update an existing Symptom Definition
Examples in XML and JSON format:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:symptom-definition cancelCycles="0" waitCycles="0" resourceKindKey="VirtualMachine" adapterKindKey="VMWARE" id="SymptomDefinition-1" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:name>CPU Too High - only one state now allowed per symptom definition</ops:name>
    <ops:state severity="CRITICAL">
        <ops:condition xsi:type="ops:htCondition">
            <ops:key>cpu|demandmhz</ops:key>
            <ops:operator>GT_EQ</ops:operator>
            <ops:value>95</ops:value>
            <ops:valueType>NUMERIC</ops:valueType>
            <ops:instanced>false</ops:instanced>
            <ops:thresholdType>STATIC</ops:thresholdType>
        </ops:condition>
    </ops:state>
</ops:symptom-definition>
{
  "id" : "SymptomDefinition-1",
  "name" : "CPU Too High - only one state now allowed per symptom definition",
  "adapterKindKey" : "VMWARE",
  "resourceKindKey" : "VirtualMachine",
  "waitCycles" : 0,
  "cancelCycles" : 0,
  "state" : {
    "severity" : "CRITICAL",
    "condition" : {
      "type" : "CONDITION_HT",
      "key" : "cpu|demandmhz",
      "operator" : "GT_EQ",
      "value" : "95",
      "valueType" : "NUMERIC",
      "instanced" : false,
      "settingValue" : null,
      "targetKey" : null,
      "thresholdType" : "STATIC"
    }
  }
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:symptom-definition/>

GET /api/symptoms

Look up all Symptoms in the system.
Optionally these Symptoms can be looked up for a specific set of Resources and/or can include Symptoms that are no longer active.
The list of Symptoms returned is a collection that supports pagination.
A sample response of the API is shown below

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:symptoms xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:symptom kpi="false" id="31eeaeec-82d5-4037-a59b-efed2e7c8e3a">
        <ops:resourceId>50000000-0000-0000-0000-000000000005</ops:resourceId>
        <ops:startTimeUTC>1523032310334</ops:startTimeUTC>
        <ops:updateTimeUTC>1523032310334</ops:updateTimeUTC>
        <ops:cancelTimeUTC>0</ops:cancelTimeUTC>
        <ops:symptomCriticality>INFORMATION</ops:symptomCriticality>
        <ops:symptomDefinitionId>SymptomDefinition-1</ops:symptomDefinitionId>
        <ops:message>symptom message</ops:message>
    </ops:symptom>
    <ops:symptom kpi="false" id="18589dea-9999-1234-abba-f1ee73004dac">
        <ops:resourceId>50000000-0000-0000-0000-000000000005</ops:resourceId>
        <ops:startTimeUTC>1523032310334</ops:startTimeUTC>
        <ops:updateTimeUTC>1523032310334</ops:updateTimeUTC>
        <ops:cancelTimeUTC>0</ops:cancelTimeUTC>
        <ops:symptomCriticality>INFORMATION</ops:symptomCriticality>
        <ops:symptomDefinitionId>SymptomDefinition-1</ops:symptomDefinitionId>
        <ops:message>symptom message</ops:message>
    </ops:symptom>
</ops:symptoms>
{
  "pageInfo" : null,
  "links" : null,
  "symptom" : [ {
    "id" : "31eeaeec-82d5-4037-a59b-efed2e7c8e3a",
    "resourceId" : "50000000-0000-0000-0000-000000000005",
    "startTimeUTC" : 1523032310341,
    "updateTimeUTC" : 1523032310341,
    "cancelTimeUTC" : 0,
    "kpi" : false,
    "symptomCriticality" : "INFORMATION",
    "symptomDefinitionId" : "SymptomDefinition-1",
    "message" : "symptom message",
    "extension" : null,
    "links" : null
  }, {
    "id" : "18589dea-9999-1234-abba-f1ee73004dac",
    "resourceId" : "50000000-0000-0000-0000-000000000005",
    "startTimeUTC" : 1523032310341,
    "updateTimeUTC" : 1523032310341,
    "cancelTimeUTC" : 0,
    "kpi" : false,
    "symptomCriticality" : "INFORMATION",
    "symptomDefinitionId" : "SymptomDefinition-1",
    "message" : "symptom message",
    "extension" : null,
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000
resourceId Array of resource identifiers for which Symptoms need to be looked up query xs:uuid no yes
activeOnly Boolean that determines if the results should include inactive Symptoms query xs:boolean no no true

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:symptoms/>

POST /api/symptoms/query

Look up a set of Symptoms using a query object.
The list of Symptoms returned is a collection that supports pagination.
A sample request body of the API is shown below:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:symptom-query compositeOperator="AND" xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:symptomId></ops:symptomId>
    <ops:resource-query>
        <ops:resourceId>5748438c-41d5-4397-a59b-efe973674653</ops:resourceId>
        <ops:statKeyInclusive>true</ops:statKeyInclusive>
    </ops:resource-query>
    <ops:includeChildrenResources>false</ops:includeChildrenResources>
    <ops:activeOnly>true</ops:activeOnly>
    <ops:alarmType></ops:alarmType>
    <ops:alarmCriticality>CRITICAL IMMEDIATE WARNING INFORMATION</ops:alarmCriticality>
    <ops:symptomDefinitionId></ops:symptomDefinitionId>
    <ops:statKey></ops:statKey>
</ops:symptom-query>
{
  "compositeOperator" : "AND",
  "symptomId" : [ ],
  "resource-query" : {
    "name" : null,
    "regex" : null,
    "adapterKind" : null,
    "resourceKind" : null,
    "collectorName" : null,
    "collectorId" : null,
    "maintenanceScheduleId" : null,
    "adapterInstanceId" : null,
    "recentlyAdded" : null,
    "resourceState" : null,
    "resourceStatus" : null,
    "resourceHealth" : null,
    "parentId" : null,
    "credentialId" : null,
    "resourceId" : [ "5748438c-41d5-4397-a59b-efe973674653" ],
    "propertyName" : null,
    "propertyValue" : null,
    "statKey" : null,
    "statKeyLowerBound" : null,
    "statKeyUpperBound" : null,
    "statKeyInclusive" : true,
    "propertyConditions" : null,
    "statConditions" : null,
    "includeRelated" : null
  },
  "includeChildrenResources" : false,
  "activeOnly" : true,
  "alarmType" : [ ],
  "alarmCriticality" : [ "CRITICAL", "IMMEDIATE", "WARNING", "INFORMATION" ],
  "startTimeRange" : null,
  "cancelTimeRange" : null,
  "symptomDefinitionId" : [ ],
  "statKey" : [ ]
}
A sample response of the API is shown below
Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:symptoms xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:symptom kpi="false" id="31eeaeec-82d5-4037-a59b-efed2e7c8e3a">
        <ops:resourceId>50000000-0000-0000-0000-000000000005</ops:resourceId>
        <ops:startTimeUTC>1523032310321</ops:startTimeUTC>
        <ops:updateTimeUTC>1523032310324</ops:updateTimeUTC>
        <ops:cancelTimeUTC>0</ops:cancelTimeUTC>
        <ops:symptomCriticality>INFORMATION</ops:symptomCriticality>
        <ops:symptomDefinitionId>SymptomDefinition-1</ops:symptomDefinitionId>
        <ops:message>symptom message</ops:message>
    </ops:symptom>
    <ops:symptom kpi="false" id="18589dea-9999-1234-abba-f1ee73004dac">
        <ops:resourceId>50000000-0000-0000-0000-000000000005</ops:resourceId>
        <ops:startTimeUTC>1523032310325</ops:startTimeUTC>
        <ops:updateTimeUTC>1523032310325</ops:updateTimeUTC>
        <ops:cancelTimeUTC>0</ops:cancelTimeUTC>
        <ops:symptomCriticality>INFORMATION</ops:symptomCriticality>
        <ops:symptomDefinitionId>SymptomDefinition-1</ops:symptomDefinitionId>
        <ops:message>symptom message</ops:message>
    </ops:symptom>
</ops:symptoms>
{
  "pageInfo" : null,
  "links" : null,
  "symptom" : [ {
    "id" : "31eeaeec-82d5-4037-a59b-efed2e7c8e3a",
    "resourceId" : "50000000-0000-0000-0000-000000000005",
    "startTimeUTC" : 1523032310333,
    "updateTimeUTC" : 1523032310333,
    "cancelTimeUTC" : 0,
    "kpi" : false,
    "symptomCriticality" : "INFORMATION",
    "symptomDefinitionId" : "SymptomDefinition-1",
    "message" : "symptom message",
    "extension" : null,
    "links" : null
  }, {
    "id" : "18589dea-9999-1234-abba-f1ee73004dac",
    "resourceId" : "50000000-0000-0000-0000-000000000005",
    "startTimeUTC" : 1523032310333,
    "updateTimeUTC" : 1523032310333,
    "cancelTimeUTC" : 0,
    "kpi" : false,
    "symptomCriticality" : "INFORMATION",
    "symptomDefinitionId" : "SymptomDefinition-1",
    "message" : "symptom message",
    "extension" : null,
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
page Page number from which data needs to be displayed (0-based) query xs:int no no 0
pageSize Expected number of entries per page query xs:int no no 1000

Request body content

 The following data representation(s) are supported input types. Click each item to learn more.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:symptoms/>

GET /api/tasks

Look up a list of task objects.
In general, to get the status of any long running operations, the operation must have been initiated through the vRealize Operations Manager REST API.
This API endpoint returns the details of the long running tasks that were submitted via the API only. Furthermore, the list of tasks that this API returns includes tasks for long running operations such as Adapter Installation, Describe etc. This API does not return the tasks created when any Remediation Actions are executed in the system either via the UI or via the API.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:task-statuses xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:task-status>
        <ops:taskId>574a82b7-8cfe-4408-9e6b-ebe329a0022a</ops:taskId>
        <ops:statusMessage>Distributed Task Execution for ADAPTER_INSTALL</ops:statusMessage>
        <ops:taskState>RUNNING</ops:taskState>
        <ops:createdTime>0</ops:createdTime>
        <ops:lastUpdateTime>1523035908802</ops:lastUpdateTime>
        <ops:errorMessages/>
    </ops:task-status>
</ops:task-statuses>
{
  "taskStatusList" : [ {
    "taskId" : "94bd337e-b69e-4352-91a5-0ce15625ffea",
    "description" : null,
    "statusMessage" : "Distributed Task Execution for ADAPTER_INSTALL",
    "taskState" : "RUNNING",
    "createdTime" : 0,
    "lastUpdateTime" : 1523035908806,
    "errorMessage" : [ ],
    "links" : null
  } ]
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
taskId query xs:collection no no
taskState query xs:collection no no

Response http response codes, description about schema of return types

HTTP Response Codes
200
Descriptions
200 - If the API returns successfully the list of Tasks
Response type
<ns3:task-statuses/>

GET /api/tasks/{id}

Look up a task with the given identifier.
In general, to get the status of any long running operations, the operation must have been initiated through the vRealize Operations Manager REST API.
This API returns the status of a specific task that was initiated via the REST API with the exception of tasks that get created when any Remediation Action is performed via the /api/actions endpoint.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:task-status xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:taskId>a8f23525-d2b4-41a7-b0e6-4ccf6b385e1f</ops:taskId>
    <ops:statusMessage>Distributed Task Execution for ADAPTER_INSTALL</ops:statusMessage>
    <ops:taskState>RUNNING</ops:taskState>
    <ops:createdTime>0</ops:createdTime>
    <ops:lastUpdateTime>1523035908792</ops:lastUpdateTime>
    <ops:errorMessages/>
</ops:task-status>
{
  "taskId" : "d117accd-f84d-46f3-bcea-ea4e79f34f0e",
  "description" : null,
  "statusMessage" : "Distributed Task Execution for ADAPTER_INSTALL",
  "taskState" : "RUNNING",
  "createdTime" : 0,
  "lastUpdateTime" : 1523035908795,
  "errorMessage" : [ ],
  "links" : null
}

Request description about parameters and structure of input data

   The following are request parameters supported by this method
name description style type required repeating default
id template xs:uuid yes no

Response http response codes, description about schema of return types

HTTP Response Codes
200, 404
Descriptions
200 - If there is a Task with the specified identifier
404 - If there is no Task with the specified identifer
Response type
<ns3:task-status/>

GET /api/versions/current/endpoints

Enumerates the API end points supported by the Service.

Request description about parameters and structure of input data

This method does not take any request parameters.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:endpoints/>

GET /api/versions/current

Gets the current version of the Service.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:version xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:releaseName>VMware vRealize Operations Manager 6.7.0</ops:releaseName>
    <ops:major>1</ops:major>
    <ops:minor>8</ops:minor>
    <ops:minorMinor>0</ops:minorMinor>
    <ops:releasedDate>2018-03-31T00:00:00.370-07:00</ops:releasedDate>
    <ops:humanlyReadableReleaseDate>Saturday, March 31, 2018 12:00:00 AM PDT</ops:humanlyReadableReleaseDate>
    <ops:description xsi:nil="true"/>
</ops:version>
{
  "releaseName" : "VMware vRealize Operations Manager 6.7.0",
  "major" : 1,
  "minor" : 8,
  "minorMinor" : 0,
  "buildNumber" : null,
  "releasedDate" : 1522479600370,
  "humanlyReadableReleaseDate" : "Saturday, March 31, 2018 12:00:00 AM PDT",
  "description" : null
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:version/>

GET /api/versions

Enumerates all Supported Versions by the Service.
Sample Response:

Show
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ops:versions xmlns:ops="http://webservice.vmware.com/vRealizeOpsMgr/1.0/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ops:version>
        <ops:releaseName>VMware vRealize Operations Manager 6.7.0</ops:releaseName>
        <ops:major>1</ops:major>
        <ops:minor>8</ops:minor>
        <ops:minorMinor>0</ops:minorMinor>
        <ops:releasedDate>2018-03-31T00:00:00.370-07:00</ops:releasedDate>
        <ops:humanlyReadableReleaseDate>Saturday, March 31, 2018 12:00:00 AM PDT</ops:humanlyReadableReleaseDate>
        <ops:description xsi:nil="true"/>
    </ops:version>
    <ops:version>
        <ops:releaseName>VMware vRealize Operations Manager 6.6.0</ops:releaseName>
        <ops:major>1</ops:major>
        <ops:minor>7</ops:minor>
        <ops:minorMinor>0</ops:minorMinor>
        <ops:releasedDate>2017-06-30T00:00:00.370-07:00</ops:releasedDate>
        <ops:humanlyReadableReleaseDate>Friday, June 30, 2017 12:00:00 AM PDT</ops:humanlyReadableReleaseDate>
        <ops:description xsi:nil="true"/>
    </ops:version>
    <ops:version>
        <ops:releaseName>VMware vRealize Operations Manager 6.5.0</ops:releaseName>
        <ops:major>1</ops:major>
        <ops:minor>6</ops:minor>
        <ops:minorMinor>0</ops:minorMinor>
        <ops:releasedDate>2017-03-31T00:00:00.370-07:00</ops:releasedDate>
        <ops:humanlyReadableReleaseDate>Friday, March 31, 2017 12:00:00 AM PDT</ops:humanlyReadableReleaseDate>
        <ops:description xsi:nil="true"/>
    </ops:version>
    <ops:version>
        <ops:releaseName>VMware vRealize Operations Manager 6.4.0</ops:releaseName>
        <ops:major>1</ops:major>
        <ops:minor>5</ops:minor>
        <ops:minorMinor>0</ops:minorMinor>
        <ops:releasedDate>2016-12-31T00:00:00.370-08:00</ops:releasedDate>
        <ops:humanlyReadableReleaseDate>Saturday, December 31, 2016 12:00:00 AM PST</ops:humanlyReadableReleaseDate>
        <ops:description xsi:nil="true"/>
    </ops:version>
    <ops:version>
        <ops:releaseName>VMware vRealize Operations Manager 6.3.0</ops:releaseName>
        <ops:major>1</ops:major>
        <ops:minor>4</ops:minor>
        <ops:minorMinor>0</ops:minorMinor>
        <ops:releasedDate>2016-08-31T00:00:00.370-07:00</ops:releasedDate>
        <ops:humanlyReadableReleaseDate>Wednesday, August 31, 2016 12:00:00 AM PDT</ops:humanlyReadableReleaseDate>
        <ops:description xsi:nil="true"/>
    </ops:version>
    <ops:version>
        <ops:releaseName>VMware vRealize Operations Manager 6.2.1</ops:releaseName>
        <ops:major>1</ops:major>
        <ops:minor>3</ops:minor>
        <ops:minorMinor>0</ops:minorMinor>
        <ops:releasedDate>2016-04-30T00:00:00.370-07:00</ops:releasedDate>
        <ops:humanlyReadableReleaseDate>Saturday, April 30, 2016 12:00:00 AM PDT</ops:humanlyReadableReleaseDate>
        <ops:description xsi:nil="true"/>
    </ops:version>
    <ops:version>
        <ops:releaseName>VMware vRealize Operations Manager 6.1.0</ops:releaseName>
        <ops:major>1</ops:major>
        <ops:minor>2</ops:minor>
        <ops:minorMinor>0</ops:minorMinor>
        <ops:releasedDate>2015-10-31T00:00:00.370-07:00</ops:releasedDate>
        <ops:humanlyReadableReleaseDate>Saturday, October 31, 2015 12:00:00 AM PDT</ops:humanlyReadableReleaseDate>
        <ops:description xsi:nil="true"/>
    </ops:version>
    <ops:version>
        <ops:releaseName>VMware vRealize Operations Manager 6.0.3</ops:releaseName>
        <ops:major>1</ops:major>
        <ops:minor>1</ops:minor>
        <ops:minorMinor>1</ops:minorMinor>
        <ops:releasedDate>2015-09-30T00:00:00.370-07:00</ops:releasedDate>
        <ops:humanlyReadableReleaseDate>Wednesday, September 30, 2015 12:00:00 AM PDT</ops:humanlyReadableReleaseDate>
        <ops:description xsi:nil="true"/>
    </ops:version>
    <ops:version>
        <ops:releaseName>VMware vRealize Operations Manager 6.0</ops:releaseName>
        <ops:major>1</ops:major>
        <ops:minor>0</ops:minor>
        <ops:minorMinor>0</ops:minorMinor>
        <ops:releasedDate>2014-12-31T00:00:00.370-08:00</ops:releasedDate>
        <ops:humanlyReadableReleaseDate>Wednesday, December 31, 2014 12:00:00 AM PST</ops:humanlyReadableReleaseDate>
        <ops:description xsi:nil="true"/>
    </ops:version>
</ops:versions>
{
  "values" : [ {
    "releaseName" : "VMware vRealize Operations Manager 6.7.0",
    "major" : 1,
    "minor" : 8,
    "minorMinor" : 0,
    "buildNumber" : null,
    "releasedDate" : 1522479600370,
    "humanlyReadableReleaseDate" : "Saturday, March 31, 2018 12:00:00 AM PDT",
    "description" : null
  }, {
    "releaseName" : "VMware vRealize Operations Manager 6.6.0",
    "major" : 1,
    "minor" : 7,
    "minorMinor" : 0,
    "buildNumber" : null,
    "releasedDate" : 1498806000370,
    "humanlyReadableReleaseDate" : "Friday, June 30, 2017 12:00:00 AM PDT",
    "description" : null
  }, {
    "releaseName" : "VMware vRealize Operations Manager 6.5.0",
    "major" : 1,
    "minor" : 6,
    "minorMinor" : 0,
    "buildNumber" : null,
    "releasedDate" : 1490943600370,
    "humanlyReadableReleaseDate" : "Friday, March 31, 2017 12:00:00 AM PDT",
    "description" : null
  }, {
    "releaseName" : "VMware vRealize Operations Manager 6.4.0",
    "major" : 1,
    "minor" : 5,
    "minorMinor" : 0,
    "buildNumber" : null,
    "releasedDate" : 1483171200370,
    "humanlyReadableReleaseDate" : "Saturday, December 31, 2016 12:00:00 AM PST",
    "description" : null
  }, {
    "releaseName" : "VMware vRealize Operations Manager 6.3.0",
    "major" : 1,
    "minor" : 4,
    "minorMinor" : 0,
    "buildNumber" : null,
    "releasedDate" : 1472626800370,
    "humanlyReadableReleaseDate" : "Wednesday, August 31, 2016 12:00:00 AM PDT",
    "description" : null
  }, {
    "releaseName" : "VMware vRealize Operations Manager 6.2.1",
    "major" : 1,
    "minor" : 3,
    "minorMinor" : 0,
    "buildNumber" : null,
    "releasedDate" : 1461999600370,
    "humanlyReadableReleaseDate" : "Saturday, April 30, 2016 12:00:00 AM PDT",
    "description" : null
  }, {
    "releaseName" : "VMware vRealize Operations Manager 6.1.0",
    "major" : 1,
    "minor" : 2,
    "minorMinor" : 0,
    "buildNumber" : null,
    "releasedDate" : 1446274800370,
    "humanlyReadableReleaseDate" : "Saturday, October 31, 2015 12:00:00 AM PDT",
    "description" : null
  }, {
    "releaseName" : "VMware vRealize Operations Manager 6.0.3",
    "major" : 1,
    "minor" : 1,
    "minorMinor" : 1,
    "buildNumber" : null,
    "releasedDate" : 1443596400370,
    "humanlyReadableReleaseDate" : "Wednesday, September 30, 2015 12:00:00 AM PDT",
    "description" : null
  }, {
    "releaseName" : "VMware vRealize Operations Manager 6.0",
    "major" : 1,
    "minor" : 0,
    "minorMinor" : 0,
    "buildNumber" : null,
    "releasedDate" : 1420012800370,
    "humanlyReadableReleaseDate" : "Wednesday, December 31, 2014 12:00:00 AM PST",
    "description" : null
  } ]
}

Request description about parameters and structure of input data

This method does not take any request parameters.

Response http response codes, description about schema of return types

HTTP Response Codes
200
Response type
<ns3:versions/>