In this section
Change WSUS settings
The endpoint to assign agent policy for resources.
Create and update device groups
Creates and updates device groups.
Update Group
Updates the details of a device group with one of these actions:
- Rename a device group
- Change the set of devices residing in a device group
- Change knowledge base articles assigned to a device group
- Add a device group as a child under an existing device group (the parent)
Add a device group as a child in an existing device group
The existing device group becomes the parent of the child device group.
Create generic resource
Creates a generic resource.
Resource Types Supported
- Generic
- DNS
- FTP
- HTTP Basic
- HTTP NTLM
- HTTP OAuth2
- HTTPS Basic
- HTTPS NTLM
- HTTPS OAuth2
- IMAP
- PING
- POP3
- SCRIPT
- SMTP
- SSL
- TCP
- UDP
Different fields are mandatory for different resource types. Refer to the examples.
Create or update service group
Creates or updates a service group.
Use this API to create a parent (root level) service group.
This API can perform the following actions on a service group:
- Create a service group
- Rename a service group
- Add set of services to a service group
- Change knowledge base articles assigned to a service group
- Add a service group as child to a parent service group
Create resource note
Creates a resource note.
Create site
Creates a site to organize devices based on location.
Create tenant custom attribute type and values
Creates a tenant custom attribute type and the list of values
Decommission a resource
Decommissions a resource.
Delete resource by resource type
Deletes a resource based on resource type.
Enable and disable client resource decommission
Enables and disables resource decommission at partner level.
Get and delete device management policy
The endpoint is used to get device management policy details and unassign agent policy for resources.
Get child resources and device groups
Gets the child resources or child device groups within a parent device group.
Get child resources and service groups
Gets the child entities (resources or service groups) of a parent service group.
Get client custom attributes
Gets client custom attributes.
Get decommissioned resource data
Gets the data of a decommissioned resource.
Get device custom attributes of a device
Gets device custom attributes.
Get latest antivirus definitions on resources
Gets the latest antivirus definitions installed on resources.
Query Variables
| Query Variables | Values | Description |
|---|---|---|
| status | - OUTOFDATE - UPTODATE | Antivirus definition status on a resource. Example: UPTODATE. |
Notes
There are special characters that can be used in a query string:
- (+) represents the next field and must be URL-encoded.
- (:) represents equals. An example is key : value.
- Space characters must be URL-encoded.
- Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).
Get minimal details of device groups
Gets minimal details of device groups.
Get minimal details of service groups
Gets minimal details (including service group ID and name) of service groups.
Get minimal resource details
Gets minimal resource details.
| Query Variables | Description |
|---|---|
| hostName | Name of the host. |
| dnsName | Domain service name. |
| resourceName | Name of the resource. |
| aliasName | Other name of resource. |
| id | Resource unique ID. Example: d5bce6fe-d19f-4ad7-8c50-5f639f2dd321 |
| serialNumber | Resource serial number. Example: d7bce6fe-d19f-4ad7-8c50-2f639f2dd778 |
| ipAddress | Resource IP address. |
| systemUID | System Unique ID. Example: 10.10.10.10 |
| state | Resource state supported values: active, inactive, discovered, all. Filter devices based on the device state. Example: discovered |
| type | Values accepted as Resource Type:DEVICE, AUTO_SCALING, EBS, LOAD_BALANCER, SQL_DATABASE, SQL_SERVER, SYNTHETIC Example: DEVICE |
| deviceType | Filter resources based on device type. This parameter is required if the resource type is a device. Use Get Device Types API to get the names of supported device types. Enumerate multiple device type names with comma-separated strings. Example: Windows, Linux |
| resourceType | Filter resources based on a resource type. Use Get Device Types API to get a list of supported resource types supported by OpsRamp. Enumerate multiple resource types with comma-separated strings. Example: DEVICE, DOCUMENT_DB |
| startCreationDate | Indicates the date to search the creation date of a resource. Start indicates from date. Example: 2017-01-01T00:00:00 0000 |
| endCreationDate | Indicates the date to search for the last date of resource creation. End indicates to date. Example: 2017-01-31T00:00:00 0000 |
| startUpdationDate | Search for a resource updated within a specific duration. Start indicates from date. Example: 2017-01-01T00:00:00 0000 |
| endUpdationDate | Search for a resource updated within a specific duration. End indicates to date. Example: 2017-01-31T00:00:00 0000 |
| tags | Custom attribute tag names. Enumerate multiple tags, by separating each tag with a comma. Example: Admin |
| template | Monitoring template ID used to get the list of devices assigned on a particular template. |
| agentProfile | Agent profile ID. |
| gatewayProfile | Gateway profile ID. |
| instanceId | Cloud instance ID. |
| accountNumber | Cloud provider’s account number. Example: 290642135901 |
| installedIntgId | Installed integration ID. Example: INTG-6dcbc22c-5436-5eb8-5e7c-8db0319938a4 |
| agentInstalled | Filter for agent-installed resources: - agentInstalled: true gets agent-installed resources. - agentInstalled: false gets non-agent resources. Example: true |
| deviceGroup | Fetch resources that are part of a specific device/child group. Provide a device group name. Example: Windows Servers |
| serviceGroup | Fetch resources that are part of a specific service group. Provide service group name. Example: Admin Group |
| deviceLocation | Fetch resources that are at a specific location. Provide a location name. Example: West-SJ |
| isEquals | To search for the exact match of a variable. - isEquals: true , to search for the exact match of a variable. - isEquals: false to search for a similar match of a variable. For example, to fetch list of resources in location West Valley and resource group, provide the query variable respectively as: - deviceLocation: West Valley%2BisEquals: true - deviceGroup: Windows Servers%2BisEquals:true Note: This is an optional parameter for deviceGroup/deviceLocation/serviceGroup |
| assetManagedTime | The most recent time a resource is managed. The asset managed time gets updated whenever a resource is managed or unmanaged. Example: 2017-01-01T00:00:00 0000 |
| firstAssetManagedTime | The first time a resource is managed. Example: 2017-01-31T00:00:00 0000 |
| appRoles | Filter for resources based on applications running on the resources.List of supported applications: |
| appRoles | appRoles | appRoles | appRoles |
|---|---|---|---|
| activemq | hbase | mongodb | rabbitmq |
| apache | hdfs-datanode | monitdMemoryStats | redis |
| cassandra | hdfs-namenode | moxi-server | riak |
| ceph | iptable | mysql | solr |
| couchbase | jboss | nfsiostat | spark |
| couchdb | kafka | nginx | squid |
| DNS-Server | kubernetes | ntp | tomcat |
| docker | kvm | openvpn | varnish |
| docker-container | lighttpd | oracle | weblogic |
| elasticsearch | mesosmaster | postfix | websphere |
| haproxy | mesosslave | postgresql | zookeeper |
Notes
There are special characters that can be used in a query string:
- (+) represents the next field and must be URL-encoded.
- (:) represents equals. An example is key : value.
- Space characters must be URL-encoded.
- Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).
Get minimal resource type details
Gets minimal resource type details.
Get minimal site details
Gets minimal details of sites.
Get private locations for synthetics
Gets private locations for the synthetics.
Get public locations for synthetics
Gets public locations for the synthetics.
Get resource applications
Gets the list of applications running on a resource.
Get resource availability
Gets the availability details of a resource within a specific time frame.
To view availability of a resource within a given time frame, provide the start time and end time.
Notes
- State 0 indicates the status of resource is down.
- State 4 indicates the status of resource is unknown.
Get root level device groups
Gets the root level device groups.
Get root-level service groups
Gets root-level, parent service groups.
Get service availability
Gets availability details of a service.
Get service group custom attributes
Gets service group custom attributes.
Get topology data by relationships
Gets topology data by providing relationship information about resources.
Topology relationships provide operators and administrators with the background for troubleshooting, capacity planning, and architecture review. This API gets these relationships that exist across the hybrid infrastructure. Topology data can be retrieved one-level away from the resource (nearest neighbor).
Get warranties
Gets the details of multiple device warranties.
Link service group
Links or shares an existing service group with other service groups.
Manage child resource for service group
Assigns and unassigns child resources for a service group.
Manage child resources for device groups
Assigns and unassigns a child resources for device groups.
Manage client custom attributes
Assigns and unassigns client custom attributes.
Manage custom attributes for devices
Assigns and unassigns custom attributes for devices
Manage custom attributes for service groups
Assigns and unassigns custom attributes for service groups
Manage device groups
Gets device group details and delete sdevice groups.
Manage device management policy
Creates and updates device management policies, and gets tenant device management policies, without pagination.
Manage device warranty
Creates a device warranty and gets device warranty details.
Manage resource availability rule
Updates and gets the availability rule defined on a resource.
Manage resource dependency
Creates, gets, and deletes resource dependency.
Manage resources
Gets resource information, update resource details, and delete a resource using a resource ID.
Manage service group
Gets and delete service groups.
Manage site
Updates and gets site details, and deletes a site.
Manage tenant custom attributes
Updates, gets, and deletes tenant custom attributes.
Run device management policy
Runs a device management policy.
Search assigned entities by attribute
Searches for the assigned entities by attribute.
Query Variables
| Query Variables | Description |
|---|---|
| id | The attribute ID. |
| value | Custom attribute value. |
| source | Filter with tagSource |
Search decommissioned resources
Gets the list of decommissioned resources.
Notes There are special characters that can be used in a query string:
- (+) represents the next field and must be URL-encoded.
- (:) represents equals. An example is
key : value. - Space characters must be URL-encoded.
- Date format must be
yyyy-MM-ddTHH:mm:ssZ (GMT).
Query Variables
| Query Variables | Description |
|---|---|
| id | Resource ID. Example: d7bce6fe-d19f-4ad7-8c50-2f639f2dd778 |
| state | Resource state.Supported value: DECOMMISSIONED |
| hostName | Resource host name. Example: SJKT1212 |
| ipAddress | Resource IP Address. Example: 10.23.89.226 |
| instanceId | Cloud instance ID. |
| tags | Additional information of a resource, preferably, a custom attribute name. |
| startDate | Search for resources decommissioned within a specific duration. startDate indicates the from date. For example, to fetch list resources decommissioned between 14th Aug 2018 to 18th Aug 2018, provide startDate as 2018-08-14T10:20:20 0000 and endDate as 2018-08-18T12:10:20 0000Note: Date format: yyyy-MM-ddTHH:mm:ssZ (GMT). |
| endDate | Search for resources decommissioned within a specific duration. endDate indicates the to date.Note: Date format: yyyy-MM-ddTHH:mm:ssZ (GMT). |
| type | Resource type. Example: DEVICE |
| accountNumber | Instance account number. This varies for each provider: - AWS: Account number - Azure: Subscription ID - Google: Project ID |
| provider | Cloud provider name. Example: AWS |
| owner | Owner ID. Example: 23422135901 |
| instanceType | Cloud instance type. |
| instanceState | Cloud instance state.Supported Value: DECOMMISSIONED |
| zone | Zone name in which instance is located. Example: virgina-east |
| region | Geographical location in which instance is located. Example: US-EAST |
| ami | Amazon Machine image. |
| hostedServiceName | Domain role. |
| startLaunchDate | Search for decommissioned cloud instances launched within a specific duration.Provide from date. Example: 2018-07-11T10:05:20 0000 |
| endLaunchDate | Search for decommissioned cloud instances launched within a specific duration.Provide to date. Example: 2018-08-20T11:10:20 0000 |
Search device management policy
Searches for a device management policy with a policy name.
Search resource notes
Gets the latest antivirus definitions installed on resources.
Query Variables
| Query Variables | Description |
|---|---|
| searchWord | Search with a unique word provided in the resource note. |
| startCreationDate | Search for the resource note created within a duration. startCreationDate indicates the from date. |
| endCreationDate | Search for the resource note created within a duration. endCreationDate indicates the to date. |
| startUpdationDate | Search for the resource note created within a duration. startUpdationDate indicates the from date. |
| endUpdationDate | Search for the resource note created within a duration. endUpdationDate indicates the to date. |
| id | Resource ID |
Notes
There are special characters that can be used in a query string:
- (+) represents the next field and must be URL-encoded.
- (:) represents equals. An example is key : value.
- Space characters must be URL-encoded.
- Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).
Search resources
Gets the resources of a partner or a client.
Query Variables
| Query Variables | Description |
|---|---|
| hostName | Name of the host. |
| dnsName | Domain service name. |
| resourceName | Name of the resource. |
| aliasName | Other name of resource. |
| id | Resource unique ID. Example: d5bce6fe-d19f-4ad7-8c50-5f639f2dd321 |
| serialNumber | Resource serial number. Example: d7bce6fe-d19f-4ad7-8c50-2f639f2dd778 |
| ipAddress | Resource IP address. |
| systemUID | System Unique ID. Example: 10.10.10.10 |
| state | Resource state supported values: active, inactive, discovered, all. Filter devices based on the device state. Example: discovered |
| type | Values accepted as Resource Type:DEVICE, AUTO_SCALING, EBS, LOAD_BALANCER, SQL_DATABASE, SQL_SERVER, SYNTHETIC Example: DEVICE |
| deviceType | Filter resources based on device type. This parameter is required if the resource type is a device. Use Get Device Types API to get the names of supported device types. Enumerate multiple device type names with comma-separated strings. Example: Windows, Linux |
| resourceType | Filter resources based on a resource type. Use Get Device Types API to get a list of supported resource types supported by OpsRamp. Enumerate multiple resource types with comma-separated strings. Example: DEVICE, DOCUMENT_DB |
| startCreationDate | Indicates the date to search the creation date of a resource. Start indicates from date. Example: 2017-01-01T00:00:00 0000 |
| endCreationDate | Indicates the date to search for the last date of resource creation. End indicates to date. Example: 2017-01-31T00:00:00 0000 |
| startUpdationDate | Search for a resource updated within a specific duration. Start indicates from date. Example: 2017-01-01T00:00:00 0000 |
| endUpdationDate | Search for a resource updated within a specific duration. End indicates to date. Example: 2017-01-31T00:00:00 0000 |
| tags | Custom attribute tag names. Enumerate multiple tags, by separating each tag with a comma. Example: Admin |
| template | Monitoring template ID used to get the list of devices assigned on a particular template. |
| agentProfile | Agent profile ID. |
| gatewayProfile | Gateway profile ID. |
| instanceId | Cloud instance ID. |
| accountNumber | Cloud provider’s account number. Example: 290642135901 |
| installedIntgId | Installed integration ID. Example: INTG-6dcbc22c-5436-5eb8-5e7c-8db0319938a4 |
| agentInstalled | Filter for agent-installed resources: - agentInstalled: true gets agent-installed resources. - agentInstalled: false gets non-agent resources. Example: true |
| deviceGroup | Fetch resources that are part of a specific device/child group. Provide a device group name. Example: Windows Servers |
| serviceGroup | Fetch resources that are part of a specific service group. Provide service group name. Example: Admin Group |
| deviceLocation | Fetch resources that are at a specific location. Provide a location name. Example: West-SJ |
| isEquals | To search for the exact match of a variable. - isEquals: true , to search for the exact match of a variable. - isEquals: false to search for a similar match of a variable. For example, to fetch list of resources in location West Valley and resource group, provide the query variable respectively as: - deviceLocation: West Valley%2BisEquals: true - deviceGroup: Windows Servers%2BisEquals:true Note: This is an optional parameter for deviceGroup/deviceLocation/serviceGroup |
| assetManagedTime | The most recent time a resource is managed. The asset managed time gets updated whenever a resource is managed or unmanaged. Example: 2017-01-01T00:00:00 0000 |
| firstAssetManagedTime | The first time a resource is managed. Example: 2017-01-31T00:00:00 0000 |
| aliasIp | Alias IP address of the network you have. |
| appRoles | Filter for resources based on applications running on the resources.List of supported applications: |
| appRoles | appRoles | appRoles | appRoles |
|---|---|---|---|
| activemq | hbase | mongodb | rabbitmq |
| apache | hdfs-datanode | monitdMemoryStats | redis |
| cassandra | hdfs-namenode | moxi-server | riak |
| ceph | iptable | mysql | solr |
| couchbase | jboss | nfsiostat | spark |
| couchdb | kafka | nginx | squid |
| DNS-Server | kubernetes | ntp | tomcat |
| docker | kvm | openvpn | varnish |
| docker-container | lighttpd | oracle | weblogic |
| elasticsearch | mesosmaster | postfix | websphere |
| haproxy | mesosslave | postgresql | zookeeper |
Notes
There are special characters that can be used in a query string:
- (+) represents the next field and must be URL-encoded.
- (:) represents equals. An example is key : value.
- Space characters must be URL-encoded.
- Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).
Search sites
Searches sites.
Query Variables
| Query Variables | Description |
|---|---|
| id | Site unique id. |
| name | Site name. |
| parentId | Parent side ID. |
Notes
There are special characters that can be used in a query string:
- (+) represents the next field and must be URL-encoded.
- (:) represents equals. An example is
key : value.
Search tenant custom attribute types and values
Searches for tenant custom attribute types and respective values.
Unlink child service group
Unlinks a child service group from a parent service group.
Update custom attribute value description
Updates a custom attribute value description.
Update resource note
Updates a resource note.