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">somebody@my.org</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" : "somebody@my.org"
  }, {
    "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">somebody@my.org</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" : "somebody@my.org"
  }, {
    "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">somebody@my.org</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" : "somebody@my.org"
  }, {
    "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">somebody@my.org</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" : "somebody@my.org"
  }, {
    "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">somebody@my.org</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" : "somebody@my.org"
  }, {
    "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">username@vmware.com</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">username@vmware.com</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" : "username@vmware.com"
  }, {
    "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" : "username@vmware.com"
  }, {
    "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">username@vmware.com</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" : "username@vmware.com"
  }, {
    "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>user1@vmware.com</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>user2@vmware.com</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" : "user1@vmware.com",
    "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" : "user2@vmware.com",
    "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>user1@vmware.com</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>user2@vmware.com</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" : "user1@vmware.com",
    "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" : "user2@vmware.com",
    "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">username@vmware.com</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">username@vmware.com</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" : "username@vmware.com"
  }, {
    "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" : "username@vmware.com"
  }, {
    "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>alex@vmware.com</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>bob@vmware.com</ops:emailAddress>
    </ops:user-search-response>
</ops:user-search-responses>
{
  "user-search-response" : [ {
    "name" : "vcadmin-1",
    "firstName" : "alex",
    "lastName" : "richard",
    "distinguishedName" : "",
    "emailAddress" : "alex@vmware.com"
  }, {
    "name" : "vcadmin-2",
    "firstName" : "bob",
    "lastName" : "watson",
    "distinguishedName" : "",
    "emailAddress" : "bob@vmware.com"
  } ]
}
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">username@vmware.com</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">username@vmware.com</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" : "username@vmware.com"
  }, {
    "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" : "username@vmware.com"
  }, {
    "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" : [ "CRITI