openapi: 3.0.0 info: title: Resource Management version: 2.0.0 description: Resource Management API Documentation contact: name: OpsRamp Support email: support@opsramp.com url: 'https://www.opsramp.com/about-opsramp/contact-us/' tags: - name: resource-management description: Resource Management APIs. externalDocs: url: 'https://develop.opsramp.com/resource-management/' servers: - url: 'https://api.opsramp.com' description: Partner - All Others - url: 'https://{subdomain}.api.opsramp.com' description: Partner or Client custom branded sub-domain variables: subdomain: default: demo description: Custom sub-domain assigned to the client paths: '/api/v2/tenants/{clientId}/resources': summary: Creates Resource description: |- Creates a resource. Different fields are mandatory for different resource types, use Get minimal resource type to know more. ### Resource Types Supported (case in-sensitive values) - LAPTOP/laptop - LINUX/linux - SYNTHETIC/synthetic - Windows/windows - Other post: tags: - resource-management requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/genericResource' - $ref: '#/components/schemas/syntheticResource' examples: example-cloud-resource: value: dnsName: testdevice-api.com hostName: testdevice-api resourceName: CloudProviderName aliasName: CustomName description: test description extResourceId: '67034' resourceType: server os: Ubuntu 12.04.5 LTS serialNumber: 564D35B8-3FF8-D31F-935D-558A15B81234 make: Ubuntu make model: Ubuntu model managementProfile: Test providerType: AWS providerUID: PVDR10 systemUID: LINUX100 resourceNetworkInterface: - ipAddressType: STATIC macAddress: '2E:8B:EB:32:7A:F9' default: 1 ipAddress: 192.168.56.86 - ipAddressType: STATIC macAddress: '00:0C:29:B8:C8:8F' default: 0 ipAddress: 172.22.221.90 - ipAddressType: DHCP macAddress: '00:0C:29:B8:C8:95' default: 0 ipAddress: 172.22.100.86 oobInterfaceCards: - name: Controller 1 macAddress: 'hj:23:gb:67:vb:sd' description: Demo Description url: 'https://www.acmeit.com/' oobVersion: '7.5' accessInfo: source-ip location accessInfoIpV4: 122.28.20.123 remoteAccessType: SSH port: 443 make: Cisco Routers model: Cisco 890 Series example-generic-resource: value: resourceName: minimalistic-Generic-Device resourceType: Linux managementProfile: TestPro example-synthetics-dns: value: checkType: DNS url: www.dns-monioring.com locationUuids: - 223087d3-ef45-4efd-9587-0b20ad8ca355 - ac346708-cb6a-4221-adc2-6b15c0d6e5af resourceName: dnsResource resourceType: SYNTHETIC example-synthetics-basicAuth: value: checkType: HTTP credential: password: s1234 securityLevel: basic userName: s1234 locationUuids: - 7b77f37f-5eb0-4ec2-bd19-15cc6853e3ca resourceName: sythentic-basic-auth resourceType: SYNTHETIC url: www.oriental.com example-synthetics-auth2: value: checkType: HTTP credential: oauthAccessTokenUrl: auth/oauth/token oauthClientKey: kHSageRP9CTeCFP7Wfrzzc45pFJZ99N4 oauthClientSecret: 5w6rKEAgYpsYDdd8vm5PnUMsQWqTnh423FArQYxGW6V3zqDcTG2z7UvjV3YBMq9Y oauthGrantType: client_credentials securityLevel: oauth2 locationUuids: - 7b77f37f-5eb0-4ec2-bd19-15cc6853e3ca resourceName: http-auth2 resourceType: SYNTHETIC url: www.oriental.com example-synthetic-mutliple-credentials: value: checkType: HTTP credential: password: s1234 securityLevel: basic userName: s1234 credentials: - credentialType: HTTP_PROXY password: s1234 securityLevel: basic userName: opsramp - credentialType: POP3 password: s1234 userName: s1234 - credentialType: FTP password: FTPPassword userName: FTP_creds locationUuids: - 9ede8f37-531c-463e-97d5-846d67d4ff58 resourceName: HTTPWithMultCreds resourceType: SYNTHETIC url: www.oriental.com responses: '200': description: OK content: application/json: schema: type: object properties: resourceUUID: type: string tenantID: type: string examples: example-cloud-resource: value: resourceUUID: 612acfb0-6890-4d52-950b-1c4ec17a7248 tenantID: client_12 example-generic-resource: value: resourceUUID: 9ba781b3-ea6c-457d-9dfc-d353f9883548 tenantID: client_13598 example-synthetics-resource: value: resourceUUID: 612acfb0-6890-4d52-950b-1c4ec17a7248 tenantID: client_12 description: '' parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/resources/{resourceId}': summary: Manage Resources description: 'Gets resource information, update resource details, and delete a resource using a resource ID.' delete: description: Deletes a resource using the resource ID. tags: - resource-management responses: '200': description: OK get: description: Gets information and optional device details for a specific resource. tags: - resource-management responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/managedResource' examples: example-resource: value: id: 46646d0b-976f-46ed-b47b-40178f5b0508 ipAddress: 172.31.20.84 extResourceId: '67034' state: active source: MANUAL agentInstalled: false agentStatus: OFFLINE agentLastConnectedTime: '2021-12-30T15:24:40+0000' status: UP location: id: 516 name: us-east-1a clientId: 10 mspId: 3 city: N.Virginia components: - disks tags: - name: test value: testValue tagSource: OPSRAMP bios: systemSerial: '347585869' systemModel: c1.medium cpus: [] generalInfo: name: Test Device1 osName: win make: HP Server osArchitecture: '64' description: '' hostName: Test Device1 dns: '' resourceType: Linux keyboardType: US104 encodingType: UTF8 physicalMemory: '0.0' resourceName: TestResource aliasName: '' createdTime: '2016-06-30T15:24:40+0000' updatedTime: '2016-06-30T15:25:00+0000' agentDeploytime: '2016-06-30T15:24:40+0000' assetManagedTime: '2015-06-30T15:25:40+0000' firstAssetManagedTime: '2015-06-30T15:24:40+0000' consoles: [] networkCardDetails: - id: 1 networkName: wlp2s0 status: Up ipAddress: 172.24.133.91 macAddress: 'f8:94:c2:0c:10:f2' dhcpEnabled: false linkMode: MGNT_MODE_LINK aliasIps: '172.24.133.100, 172.24.133.101' installedApp: id: INTG-0d249a09-32a5-4703-b5c9-1475456f2011 displayName: AWS_INTG integration: id: AWS name: AWS properties: provider: AWS instanceId: i-0eff82b84a8037c2d instanceState: running instanceType: c1.medium publicIp: 34.202.160.29 ami: ami-021800badbd6a2e64 launchDate: '2018-12-12T05:37:09+0000' owner: '371067416711' privateDns: ip-172-31-20-84.ec2.internal privateIp: 172.31.20.84 zone: us-east-1a monitoringState: disabled metricTypes: - metricName: resource.availability displayName: Availability unit: COUNTER availabilityMetric: false thresholdType: STATIC clientUniqueId: client_10 appRoles: - name: cassandra - name: hbase - name: hdfs-namenode wsusSettings: disabled example-device: value: id: 4f7f63a0-c7a3-4f2a-89de-74ff5eecb805 createdDate: '2018-05-03T06:29:38+0000' updatedDate: '2018-05-04T10:20:30+0000' type: EBS state: active source: MANUAL status: UP location: id: 0 name: East US resourceName: SJ-Host consoles: [] clientUniqueId: client_16 example-synthetic-resource: value: id: 1c83b80b-276c-4824-9501-90c89f058f2f state: active name: dnsResource consoles: [] resourceType: SYNTHETIC checkType: DNS host: www.dns-monitoring.com frequency: 0 paused: false deleted: false validateSSL: false port: 0 encrypted: false timeout: 0 ts: 1628589841000 clientId: 13598 locationUuids: - 5f618dd2-a019-4ce4-806d-9165c5a2c0dc locationOffset: 0 totalLocations: 0 receiverHostPort: 0 topologyEnabled: false device: false excludeIndexing: false cloudInstance: false saId: 0 aws-resource: value: id: 4a74dc3b-807a-430c-a877-613acd78d195 hostName: '' ipAddress: 162.12.36.227 identity: 'arn:aws:events:us-east-1:095202543984:event-bus/default' createdDate: '2021-04-26T11:02:55+0000' type: AWS_EVENT_BRIDGE_BUS state: active source: PUBLICCLOUD status: UNKNOWN aliasName: '' location: id: 0 name: us-east-1 name: default resourceName: default consoles: [] installedApp: id: INTG-e5084c50-cfbc-4619-be4d-248884b26481 displayName: AWS-ExternalId-API integration: id: AWS name: AWS multipleInstallations: true installedBy: opsramp_api_user installedTime: '2021-04-26T11:17:15+0100' status: enabled properties: provider: AWS zone: us-east-1 uniqueId: 3946ba4a-d5f9-4e5b-b977-e0f4085ff43a policy: test arn: 'arn:aws:events:us-east-1:095202543984:event-bus/default' clientUniqueId: client_809322 resourceType: AWS_EVENT_BRIDGE_BUS frequency: 0 paused: false deleted: false validateSSL: false port: 0 encrypted: false timeout: 0 ts: 0 clientId: 0 locationOffset: 0 totalLocations: 0 receiverHostPort: 0 topologyEnabled: false nativeType: AWS EventBridge Event bus azure-resource: value: id: 5e24119a-8fd6-4295-9349-9e25a18fc072 hostName: '' ipAddress: 12.134.122.1212 identity: /subscriptions/fa50c578-bd7f-4cfb-ae12-f205420131b9/resourcegroups/QA/providers/Microsoft.IoTCentral/IoTApps/qa-iot createdDate: '2021-04-14T12:45:23+0000' updatedDate: '2021-04-15T02:25:52+0000' type: AZ_IOT_CENTRAL state: active source: PUBLICCLOUD status: UNKNOWN aliasName: '' name: qa-iot resourceName: qa-iot consoles: [] installedApp: id: INTG-74eeea20-3951-4397-a672-57bd4140ddca displayName: AzureARM integration: id: AZURE name: Azure multipleInstallations: true installedBy: opsramp_api_user installedTime: '2021-04-14T13:35:47+0100' status: enabled properties: provider: AZURE uniqueId: a05c51b2-dacb-4183-8c7b-f8e539c5754f applicationId: null state: null displayName: null subdomain: null createdDate: null geography: null template: null clientUniqueId: client_786966 resourceType: AZ_IOT_CENTRAL frequency: 0 paused: false deleted: false validateSSL: false port: 0 encrypted: false timeout: 0 ts: 0 clientId: 0 locationOffset: 0 totalLocations: 0 receiverHostPort: 0 topologyEnabled: false nativeType: Azure IoT Central example-agent-offline: value: id: 31a4f8ae-dddd-4251-bea2-99e6a505946a ipAddress: 10.128.0.32 state: active model: Google Compute Engine serialNumber: GoogleCloud-1C1409327D5681D9385683D282261DEE source: Agent agentInstalled: true agentVersion: 10.0.0-1 timeZone: GMT modifiedTime: '2021-12-13T07:55:30+0000' lastMonitorTime: '2021-12-13T08:05:29+0000' status: DOWN tags: - name: agent_installed value: 'Yes' tagSource: OPSRAMP bios: biosName: Google biosVersion: Google systemSerial: GoogleCloud-1C1409327D5681D9385683D282261DEE systemModel: Google Compute Engine cpus: - processor: CPU0 processorName: AMD EPYC 7B12 processorVersion: '' manufacturer: AuthenticAMD …: null generalInfo: name: freebsd-12-2 osName: freebsd 12.2-release-p7 osArchitecture: amd64-bit make: Google description: 12.2-RELEASE-p7 FreeBSD 12.2-RELEASE-p7 GENERIC amd64 hostName: freebsd-12-2 dns: freebsd-12-2 resourceType: BSD resourcePath: Server >> BSD domainRole: '1' macAddress: '42:01:0a:80:00:20' keyboardType: US104 encodingType: UTF8 physicalMemory: '3.83' resourceName: '' aliasName: '' createdTime: '2021-12-13T07:55:29+0000' updatedTime: '2021-12-13T07:55:30+0000' agentDeploytime: '2021-12-13T07:55:29+0000' assetManagedTime: '2021-12-13T07:55:29+0000' firstAssetManagedTime: '2021-12-13T07:55:29+0000' agentConnectivity: DIRECT consoles: - ipAddress: 127.0.0.1 port: '22' consoleConnector: Agent consoleAuthType: PASSWORD …: null deviceGroups: - id: DGP-34187966-9c0a-4711-8be0-562d01f9036c name: All_Agents description: All Agent Devices …: null - id: DGP-a865b4f1-9136-4951-b390-a52d1634a8e0 name: POD Agents description: '' …: null metricTypes: - id: 0 metricName: opsramp.agent.status displayName: Agent Status description: 'Agent Status - 0 -Critical :Agent is not reporting, 1 -Ok :Agent Status is Ok' …: null - id: 0 metricName: resource.availability displayName: Availability unit: COUNTER …: null clientUniqueId: client_347120 systemUUID: 1c140932-7d56-81d9-3856-83d282261dee drives: - id: 58059 total: 20.33 free: 0.92 fileSystem: ufs name: / …: null networkCardDetails: - id: 963261 uniqueId: c98359cd-b2ee-330b-2558-52f32e23b7b4 networkName: vtnet0 status: Up …: null - id: 963262 uniqueId: 85a8f1d8-0b3e-0239-7eb3-54605ec2a248 networkName: lo0 status: Down …: null wsusSettings: disabled frequency: 0 paused: false deleted: false validateSSL: false port: 0 encrypted: false timeout: 0 ts: 0 clientId: 0 locationOffset: 0 totalLocations: 0 receiverHostPort: 0 topologyEnabled: false device: false excludeIndexing: false cloudInstance: false saId: 0 postScreenshotOnError: false postSuccessScreenshotAlongWithError: false lastConfigurationScanTime: '2021-12-13T07:55:30+0000' agentLastConnectedTime: '2021-12-13T07:55:29+0000' agentStatus: OFFLINE summary: '' post: description: Updates the details of a resource. tags: - resource-management requestBody: content: application/json: schema: type: object properties: aliasName: type: string description: | Another name of a resource. alternateIP: type: string description: | Gateway uses alternate IP to discover a resource when populated. extResourceId: type: string description: | Attach third-party integration ID. description: type: string description: Description for the resource. managementProfile: type: string description: | Name of management profile of a resource that is managed. resourceNetworkInterface: type: array description: | Details of network interface. items: type: object properties: ipAddressType: type: string macAddress: type: string default: type: integer ipAddress: type: string logicalDiskDrives: type: array items: type: object properties: name: type: string description: Name of the disk drive. utilizationWarningThreshold: type: integer description: |- Define a warning threshold value for disk utilization. A warning alert is triggered when the utilization exceeds the threshold value. Example: 60 minimum: 0 maximum: 100 utilizationCriticalThreshold: type: integer description: Define a critical threshold value for disk utilization. A critical alert is triggered when the utilization exceeds the threshold value. The utilization threshold value is represented as a percentage. minimum: 0 maximum: 100 freeDiskWarningThreshold: type: integer description: |- Define a warning threshold value for free disk space. A warning alert is triggered when the free disk space exceeds the threshold value. Example: 40 minimum: 0 maximum: 100 freeDiskCriticalThreshold: type: integer description: |- Define a critical threshold value for free disk space. A critical alert is triggered when the free disk space exceeds the threshold value. Example: 80. The free disk threshold value is represented in MB. maximum: 100 minimum: 0 oobInterfaceCards: type: array description: | OOB interface card details. items: type: object properties: name: type: string macAddress: type: string description: type: string url: type: string oobVersion: type: string accessInfo: type: string accessInfoIpV4: type: string remoteAccessType: type: string port: type: integer make: type: string model: type: string resourceType: type: string description: |- Type of resource. Example: server, SYNTHETICS systemUID: type: string description: | Unique ID of system. serialNumber: type: string description: | Serial number of resource. providerType: type: string description: | Type of provider. providerUID: type: string description: | Unique ID of provider. checkType: type: string description: |- Category type for Synthetics. Example: http, https, ftp, and so on. credential: type: object description: (Optional) Credentials for Synthetics. properties: securityLevel: type: string description: 'Security level. For example, oauth2.' oauthClientKey: type: string description: Generated client key. oauthClientSecret: type: string description: Generated secret key. oauthAccessTokenUrl: type: string description: auth or oauth token. oauthGrantType: type: string description: Credentials of the client. sslCertPath: type: string description: | (Optional) Path of the SSL Certificate SslCertKeyPath: type: string description: | (Optional) Path of the SSL certificate key. downloadFilePath: type: string description: | (Optional) Path where you want to download the file. script: type: string required: - resourceType examples: example-ds-resource: value: aliasName: aliasServerName alternateIP: 4.2.2.2 extResourceId: '67035' resourceType: server managementProfile: Gateway Profile resourceNetworkInterface: - ipAddressType: STATIC macAddress: '5G:7H:HN:12:8H:D7' default: 1 ipAddress: 121.156.43.12 - ipAddressType: STATIC macAddress: '00:0C:23:C5:D6:H7' default: 0 ipAddress: 161.32.556.56 - ipAddressType: DHCP macAddress: '00:0C:32:B7:D8:54' default: 0 ipAddress: 161.11.132.21 logicalDiskDrives: - name: / utilizationWarningThreshold: 85 utilizationCriticalThreshold: 90 freeDiskWarningThreshold: 0 freeDiskCriticalThreshold: 0 - name: /boot/efi utilizationWarningThreshold: 85 utilizationCriticalThreshold: 90 freeDiskWarningThreshold: 0 freeDiskCriticalThreshold: 0 oobInterfaceCards: - name: Controller 1 macAddress: 'hj:12:hb:32:vg:sa' description: Server controller details url: 'https://www.myorganization.com/' oobVersion: '7.5' accessInfo: source-ip location accessInfoIpV4: 121.32.21.112 remoteAccessType: SSH port: 443 make: Cisco Routers model: Cisco 890 Series example-resources-synthetics: value: checkType: DNS url: www.dns-monitoring.com locationUuids: - 5f618dd2-a019-4ce4-806d-9165c5a2c0dc resourceName: dnsResource resourceType: SYNTHETIC responses: '200': description: OK parameters: - $ref: '#/components/parameters/resourceId' - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/resources/minimal': summary: Get Minimal Resource Details description: Gets minimal resource details of the given tenant. get: tags: - resource-management parameters: - schema: type: string in: query name: 'locationId ' description: Use the `Get Time zones` API to fetch location IDs. - schema: type: string in: query name: deviceGroupId description: Use the `Get Minimal Details of Device Group` API to fetch device group IDs. - schema: type: string in: query name: deviceTypeId description: Use the `Get Device Types` API to fetch device type IDs. - schema: type: string default: active in: query name: state description: |- Supported resource states: - active: Indicates managed devices - inactive: Indicates unmanaged devices - discovered: indicates all discovered devices - all: indicates the total device states including active, inactive and discovered - $ref: '#/components/parameters/queryString' - schema: type: string in: query name: hostName description: Name of the host. - schema: type: string in: query name: dnsName description: Domain service name. - schema: type: string in: query name: resourceName description: Name of the resource. - schema: type: string in: query name: aliasName description: Other name of resource. - schema: type: string in: query name: id description: 'Resource unique ID.Example: d5bce6fe-d19f-4ad7-8c50-5f639f2dd321' - schema: type: string in: query name: serialNumber description: 'Resource serial number.Example: d7bce6fe-d19f-4ad7-8c50-2f639f2dd778' - schema: type: string in: query name: ipAddress description: Resource IP address. - schema: type: string in: query name: systemUID description: 'System Unique ID.Example: 10.10.10.10' - schema: type: string in: query name: state description: 'Resource state supported values: active, inactive, discovered, all. Filter devices based on the device state.Example: discovered' - schema: type: string in: query name: type description: 'Values accepted as Resource Type:DEVICE, AUTO_SCALING, EBS, LOAD_BALANCER, SQL_DATABASE, SQL_SERVER, SYNTHETIC.Example: DEVICE' - schema: type: string in: query name: deviceType description: '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' - schema: type: string in: query name: resourceType description: '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' - schema: type: string in: query name: startCreationDate description: 'Indicates the date to search the creation date of a resource. Start indicates from date.Example: 2017-01-01T00:00:00 0000' - schema: type: string in: query name: endCreationDate description: 'Indicates the date to search for the last date of resource creation. End indicates to date.Example: 2017-01-31T00:00:00 0000' - schema: type: string in: query name: startUpdationDate description: 'Search for a resource updated within a specific duration. Start indicates from date.Example: 2017-01-01T00:00:00 0000' - schema: type: string in: query name: endUpdationDate description: 'Search for a resource updated within a specific duration. End indicates to date.Example: 2017-01-31T00:00:00 0000' - schema: type: string in: query name: tags description: 'Custom attribute tag names. Enumerate multiple tags, by separating each tag with a comma.Example: Admin' - schema: type: string in: query name: template description: Monitoring template ID used to get the list of devices assigned on a particular template. - schema: type: string in: query name: agentProfile description: Agent profile ID. - schema: type: string in: query name: gatewayProfile description: Gateway profile ID. - schema: type: string in: query name: instanceId description: Cloud instance ID. - schema: type: string in: query name: accountNumber description: 'Cloud provider''s account number.Example: 290642135901' - schema: type: string in: query name: installedIntgId description: 'Installed integration ID.Example: INTG-6dcbc22c-5436-5eb8-5e7c-8db0319938a4' - schema: type: boolean enum: - 'true' - 'false' in: query name: agentInstalled description: 'Filter for agent-installed resources:- agentInstalled: true gets agent-installed resources.- agentInstalled: false gets non-agent resources.
Example: true' - schema: type: string in: query name: deviceGroup description: 'Fetch resources that are part of a specific device/child group. Provide a device group name.Example: Windows Servers' - schema: type: string in: query name: serviceGroup description: 'Fetch resources that are part of a specific service group. Provide service group name.Example: Admin Group' - schema: type: string in: query name: deviceLocation description: 'Fetch resources that are at a specific location. Provide a location name.Example: West-SJ' - schema: type: string in: query name: isEquals description: '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' - schema: type: string in: query name: assetManagedTime description: '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' - schema: type: string in: query name: firstAssetManagedTime description: 'The first time a resource is managed.Example: 2017-01-31T00:00:00 0000' - schema: type: string enum: - activemq - hbase - mongodb - rabbitmq - apache - hdfs-datanode - monitdMemoryStats - redis - cassandra - hdfs-namenode - moxi-server - iptable - mysql - solr - couchbase - jboss - nfsiostat - spark - couchdb - kafka - nginx - squid - DNS-Server - kubernetes - ntp - tomcat - docker - kvm - openvpn - docker-container - lighttpd - oracle - weblogic - elasticsearch - mesosmaster - postfix - websphere - haproxy - mesosslave - postgresql - zookeeper - riak - ceph example: mysql in: query name: appRoles description: 'Filter for resources based on applications running on the resources.List of supported applications:' responses: '200': description: OK content: application/json: schema: type: array items: type: object properties: id: type: string name: type: string hostName: type: string ipAddress: type: string aliasName: type: string resourceName: type: string resourceType: type: string dnsName: type: string description: DNS name of the resource. examples: example-resources-minimal-details: value: - id: ec9bbd29-b89f-4e6d-ac23-59b81c405cac name: Linux Server hostName: SJ-Linux ipAddress: 45.34.23.12 aliasName: '' resourceName: '' resourceType: Linux - id: 867a8316-8ec2-4e32-b3ec-ce8154856798 name: 3e3cc106-aad5-4b32-9b3d-5079b8fbb2f5 hostName: '' ipAddress: 54.179.70.212 aliasName: '' resourceName: 3e3cc106-aad5-4b32-9b3d-5079b8fbb2f5 resourceType: ROUTE_53 - id: 5df106d1-bebd-4c14-befc-5ac07f5088f8 name: dc6446ee-9451-44ee-ae8f-8d1e4a0bb0ea hostName: '' ipAddress: 54.123.234.12 aliasName: '' resourceName: dc6446ee-9451-44ee-ae8f-8d1e4a0bb0ea resourceType: ROUTE_53 - id: 0473052b-fed7-4f49-954f-fb22d82f9b52 name: vcenter hostName: '' ipAddress: 172.26.105.126 aliasName: '' resourceName: '' resourceType: CLOUD_PROVIDER example-resources-dns: value: - id: b081b43e-6c52-462c-bb6c-e81803c0d969 name: Linux Server hostName: test-linux1 ipAddress: '' aliasName: '' resourceName: XP_test resourceType: Server dnsName: test-linux1.sjc.net - id: 801bb8cf-4f93-4a5b-a7b4-ab734cea63b4 name: Tri-Test-VM3 hostName: test-win1 ipAddress: 'fe80::d055:f2b2:6dd:d933' aliasName: '' resourceName: Tri-Test-VM3 resourceType: Windows dnsName: test-win1.sjc.net - id: 31321789-ef92-41cd-bc96-01cc7bd38e1e name: DOT-TEST-NET hostName: test-win2 ipAddress: '' aliasName: '' resourceName: DOT-TEST-NET resourceType: Server dnsName: test-win1.sjc.net - id: 543ea045-f9d5-410e-846c-27b5b772dea9 name: Tri_test_VM hostName: test-win3 ipAddress: 147.121.111.95 aliasName: '' resourceName: Tri_test_VM resourceType: Windows dnsName: test-win3.sjc.net parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{tenantId}/resources/search': summary: Search Resources description: Gets the resources of tenant(s). Default search list all the managed resources which may not be same as UI listing. get: tags: - resource-management parameters: - schema: type: integer default: 1 in: query name: pageNo description: Page no. - schema: type: integer default: 100 in: query name: pageSize description: Page size. - schema: type: boolean default: true in: query name: isDescendingOrder description: Is Descending order. - schema: type: string default: id in: query name: sortName description: Sort order field. - $ref: '#/components/parameters/queryString' - schema: type: boolean default: false in: query name: includeStatus - schema: type: string in: query name: hostName description: Name of the host. - schema: type: string in: query name: dnsName description: Domain service name. - schema: type: string in: query name: resourceName description: Name of the resource. - schema: type: string in: query name: aliasName description: Other name of resource. - schema: type: string in: query name: id description: 'Resource unique ID.Example: d5bce6fe-d19f-4ad7-8c50-5f639f2dd321' - schema: type: string in: query name: serialNumber description: 'Resource serial number.Example: d7bce6fe-d19f-4ad7-8c50-2f639f2dd778' - schema: type: string in: query name: ipAddress description: Resource IP address. - schema: type: string in: query name: systemUID description: 'System Unique ID.Example: 10.10.10.10' - schema: type: string enum: - active - inactive - discovered - all in: query name: state description: 'Resource state supported values: active, inactive, discovered, all. Filter devices based on the device state.Example: discovered' - schema: type: string in: query name: type description: 'Values accepted as Resource Type:DEVICE, AUTO_SCALING, EBS, LOAD_BALANCER, SQL_DATABASE, SQL_SERVER, SYNTHETIC.Example: DEVICE' - schema: type: string enum: - Windows - Linux in: query name: deviceType description: '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' - schema: type: string enum: - DEVICE - DOCUMENT_DB in: query name: resourceType description: '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' - schema: type: string in: query name: startCreationDate description: 'Indicates the date to search the creation date of a resource. Start indicates from date.Example: 2017-01-01T00:00:00 0000' - schema: type: string in: query name: endCreationDate description: 'Indicates the date to search for the last date of resource creation. End indicates to date.Example: 2017-01-31T00:00:00 0000' - schema: type: string in: query name: startUpdationDate description: 'Search for a resource updated within a specific duration. Start indicates from date.Example: 2017-01-01T00:00:00 0000|' - schema: type: string in: query name: endUpdationDate description: 'Search for a resource updated within a specific duration. End indicates to date.Example: 2017-01-31T00:00:00 0000' - schema: type: string in: query name: tags description: 'Custom attribute tag names. Enumerate multiple tags, by separating each tag with a comma.Example: Admin' - schema: type: string in: query name: template description: Monitoring template ID used to get the list of devices assigned on a particular template. - schema: type: string in: query name: agentProfile description: Agent profile ID. - schema: type: string in: query name: gatewayProfile description: Gateway profile ID. - schema: type: string in: query name: instanceId description: Cloud instance ID. - schema: type: string in: query name: accountNumber description: 'Cloud provider''s account number.Example: 290642135901' - schema: type: boolean enum: - 'true' - 'false' in: query name: agentInstalled description: 'Filter for agent-installed resources: agentInstalled: true gets agent-installed resources.- agentInstalled: false gets non-agent resources.Example: true' - schema: type: string in: query name: deviceGroup description: 'Fetch resources that are part of a specific device/child group. Provide a device group name.Example: Windows Servers' - schema: type: string in: query name: serviceGroup description: 'Fetch resources that are part of a specific service group. Provide service group name.Example: Admin Group' - schema: type: string in: query name: deviceLocation description: 'Fetch resources that are at a specific location. Provide a location name.Example: West-SJ' - schema: type: string in: query name: isEquals description: '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' - schema: type: string in: query name: assetManagedTime description: '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' - schema: type: string in: query name: firstAssetManagedTime description: 'The first time a resource is managed.Example: 2017-01-31T00:00:00 0000' - schema: type: string in: query name: aliasIp description: Alias IP address of the network you have. - schema: type: string enum: - 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 - docker-container - lighttpd - oracle - weblogic - elasticsearch - mesosmaster - postfix - websphere - haproxy - mesosslave - postgresql - zookeeper in: query name: appRoles description: 'Filter for resources based on applications running on the resources.List of supported applications:' - schema: type: string in: query name: osArchitecture description: Filter for supported architecture 32 bit or 64 bit. responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: type: object properties: primaryId: type: integer id: type: string hostName: type: string ipAddress: type: string client: type: object properties: id: type: integer uniqueId: type: string name: type: string featureFlags: type: object properties: {} webConsoles: type: boolean identity: type: string createdDate: type: string updatedDate: type: string classCode: type: string deviceType: type: string devicePath: type: string type: type: string state: type: string macAddress: type: string make: type: string model: type: string osName: type: string systemUID: type: string gatewayProfileId: type: string source: type: string agentInstalled: type: boolean status: type: string attributes: type: object properties: installedIntgId: type: string providerType: type: string accountNumber: type: string accountName: type: string publicIPAddress: type: 'null' instanceId: type: string network: type: array items: type: object properties: {} aliasName: type: string location: type: object properties: id: type: integer name: type: string city: type: string path: type: string tags: type: array items: type: object properties: name: type: string value: type: string metricLabel: type: boolean scope: type: string name: type: string resourceName: type: string consoles: type: array items: type: object properties: {} deviceGroups: type: array items: type: object properties: id: type: string name: type: string description: type: string createdDate: type: string updatedDate: type: string linkedService: type: boolean scope: type: string uniqueId: type: string resourceType: type: string assetManagedTime: type: string firstAssetManagedTime: type: string frequency: type: integer paused: type: boolean deleted: type: boolean validateSSL: type: boolean port: type: integer encrypted: type: boolean timeout: type: integer ts: type: integer clientId: type: integer locationOffset: type: integer totalLocations: type: integer receiverHostPort: type: integer topologyEnabled: type: boolean device: type: boolean excludeIndexing: type: boolean cloudInstance: type: boolean saId: type: integer postScreenshotOnError: type: boolean postSuccessScreenshotAlongWithError: type: boolean totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean descendingOrder: type: boolean x-examples: Example 1: results: - primaryId: 715998 id: 65d89331-52cc-4f52-9ff3-970a883d75bf hostName: '' ipAddress: 10.0.0.9 client: id: 98 uniqueId: 322ff0e9-32f2-477a-b3ba-899d5d8cb2ef name: ITC Client featureFlags: {} webConsoles: true identity: /subscriptions/fa50c578-bd7f-4cfb-ae12-f205420131b9/resourceGroups/QA/providers/Microsoft.Compute/virtualMachines/windowsGW01 createdDate: '2023-03-03T08:09:03+0000' updatedDate: '2023-03-24T14:36:20+0000' classCode: cloudinstance deviceType: Windows devicePath: Server >> Windows type: DEVICE state: active macAddress: '00:0D:3A:C9:C5:F8' make: AZURE model: Standard_B4ms osName: Windows 2019-Datacenter systemUID: CE7FA842-6008-6046-AEE5-50FC4E68C362 gatewayProfileId: '0' source: PUBLICCLOUD agentInstalled: false status: UNDEFINED attributes: installedIntgId: INTG-8910ce98-9c14-4e94-b47a-97c7da084d79 providerType: AZURE accountNumber: fa50c578-bd7f-4cfb-ae12-f205420131b9 accountName: azure publicIPAddress: null instanceId: /subscriptions/fa50c578-bd7f-4cfb-ae12-f205420131b9/resourceGroups/QA/providers/Microsoft.Compute/virtualMachines/windowsGW01 network: [] aliasName: '' location: id: 9183 name: South India city: Chennai path: AZURE>>South India tags: - name: zoom-key4 value: New Room metricLabel: false scope: CLIENT name: windowsGW01 resourceName: windowsGW01 consoles: [] deviceGroups: - id: '472903' name: test-child-RG description: '' createdDate: '2023-02-20T07:26:12+0000' updatedDate: '2023-02-20T07:27:03+0000' linkedService: false scope: CLIENT uniqueId: DGP-1fd3759b-7471-4a78-a678-5fa9c013278c - id: '9913' name: Child1 description: '' createdDate: '2022-12-16T06:59:25+0000' updatedDate: '2023-02-07T12:59:17+0000' linkedService: false scope: CLIENT uniqueId: DGP-de735491-a7f8-4a0d-92dd-882a61edc02e - id: '9903' name: Test_RG description: '' createdDate: '2022-12-16T06:58:35+0000' updatedDate: '2023-02-08T12:06:08+0000' linkedService: false scope: CLIENT uniqueId: DGP-6e1aa8fc-b4a3-43ff-85df-734e170d4795 resourceType: Windows assetManagedTime: '2023-03-03T08:09:03+0000' firstAssetManagedTime: '2023-03-03T08:09:03+0000' frequency: 0 paused: false deleted: false validateSSL: false port: 0 encrypted: false timeout: 0 ts: 0 clientId: 0 locationOffset: 0 totalLocations: 0 receiverHostPort: 0 topologyEnabled: false device: false excludeIndexing: false cloudInstance: false saId: 0 postScreenshotOnError: false postSuccessScreenshotAlongWithError: false totalResults: 1 orderBy: name pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false descendingOrder: false examples: example-resources: value: results: - primaryId: 715998 id: 65d89331-52cc-4f52-9ff3-970a883d75bf hostName: '' ipAddress: 10.0.0.9 client: id: 98 uniqueId: 322ff0e9-32f2-477a-b3ba-899d5d8cb2ef name: ITC Client featureFlags: {} webConsoles: true identity: /subscriptions/fa50c578-bd7f-4cfb-ae12-f205420131b9/resourceGroups/QA/providers/Microsoft.Compute/virtualMachines/windowsGW01 createdDate: '2023-03-03T08:09:03+0000' updatedDate: '2023-03-24T14:36:20+0000' classCode: cloudinstance deviceType: Windows devicePath: Server >> Windows type: DEVICE state: active macAddress: '00:0D:3A:C9:C5:F8' make: AZURE model: Standard_B4ms osName: Windows 2019-Datacenter systemUID: CE7FA842-6008-6046-AEE5-50FC4E68C362 gatewayProfileId: '0' source: PUBLICCLOUD agentInstalled: false status: UNDEFINED attributes: installedIntgId: INTG-8910ce98-9c14-4e94-b47a-97c7da084d79 providerType: AZURE accountNumber: fa50c578-bd7f-4cfb-ae12-f205420131b9 accountName: azure publicIPAddress: null instanceId: /subscriptions/fa50c578-bd7f-4cfb-ae12-f205420131b9/resourceGroups/QA/providers/Microsoft.Compute/virtualMachines/windowsGW01 network: [] aliasName: '' location: id: 9183 name: South India city: Chennai path: AZURE>>South India tags: - name: zoom-key4 value: New Room metricLabel: false scope: CLIENT name: windowsGW01 resourceName: windowsGW01 consoles: [] deviceGroups: - id: '472903' name: test-child-RG description: '' createdDate: '2023-02-20T07:26:12+0000' updatedDate: '2023-02-20T07:27:03+0000' linkedService: false scope: CLIENT uniqueId: DGP-1fd3759b-7471-4a78-a678-5fa9c013278c - id: '9913' name: Child1 description: '' createdDate: '2022-12-16T06:59:25+0000' updatedDate: '2023-02-07T12:59:17+0000' linkedService: false scope: CLIENT uniqueId: DGP-de735491-a7f8-4a0d-92dd-882a61edc02e - id: '9903' name: Test_RG description: '' createdDate: '2022-12-16T06:58:35+0000' updatedDate: '2023-02-08T12:06:08+0000' linkedService: false scope: CLIENT uniqueId: DGP-6e1aa8fc-b4a3-43ff-85df-734e170d4795 resourceType: Windows assetManagedTime: '2023-03-03T08:09:03+0000' firstAssetManagedTime: '2023-03-03T08:09:03+0000' frequency: 0 paused: false deleted: false validateSSL: false port: 0 encrypted: false timeout: 0 ts: 0 clientId: 0 locationOffset: 0 totalLocations: 0 receiverHostPort: 0 topologyEnabled: false device: false excludeIndexing: false cloudInstance: false saId: 0 postScreenshotOnError: false postSuccessScreenshotAlongWithError: false totalResults: 1 orderBy: name pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false descendingOrder: false description: |- Query string should be valid input values - Eg 1: **state** values are enum: active/inactive "queryString=state:active" or "queryString=state:inactive" - Eg 2: we should allow only above listed variables - Valid: "queryString=hostName:abc" - Invalid: "queryString=hostName2:abc" - Eg 3: We should give both variable name and value - Valid: "queryString=hostName:abc" - Invalid: "queryString=hostName" parameters: - $ref: '#/components/parameters/tenantId' '/api/v2/tenants/{clientId}/resources/antivirus/search': summary: Get Latest Antivirus Definitions on Resources description: Gets the latest antivirus definitions installed on resources. get: tags: - resource-management parameters: - schema: type: integer default: 1 in: query name: pageNo - schema: type: integer default: 100 in: query name: pageSize - schema: type: boolean default: true in: query name: isDescendingOrder - schema: type: string default: scanDate in: query name: sortName - $ref: '#/components/parameters/queryString' - schema: type: string enum: - UPTODATE - OUTOFDATE in: query name: status description: 'Antivirus definition status on a resource.Example: UPTODATE.' responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: type: object properties: name: type: string version: type: string currentDefinition: type: string currentDefinitionDate: type: string format: date-time scanDate: type: string format: date-time supported: type: boolean status: type: string resource: type: object properties: id: type: string hostName: type: string ipAddress: type: string osName: type: string totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example-resources-av-details: value: results: - name: McAfee VirusScan Enterprise version: 8.8.0.1804 currentDefinition: '8637' currentDefinitionDate: '2017-08-28T00:00:00+0000' scanDate: '2017-08-29T07:59:10+0000' supported: true status: UPTODATE resource: id: d9dba1ce-dec0-46b6-8ad6-51975cd9991e hostName: HYDLPT082 ipAddress: 192.123.23.1 osName: 'Microsoft Windows 8.1 Pro ' - name: VIPRE Enterprise version: 8.8.0.1804 currentDefinition: '8575' currentDefinitionDate: '2017-01-28T05:17:13+0000' scanDate: '2017-02-01T00:00:00+0000' supported: false status: OUTOFDATE resource: id: 2912ca9f-5c62-451f-82a8-8c08ca9c9447 hostName: HYDLPT159 ipAddress: 162.12.2.233 osName: 'Microsoft Windows 8.1 Enterprise Edition, 64-bit' totalResults: 2 orderBy: scanDate pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/resources/{resourceId}/notes': summary: Create Resource Note description: Creates a resource note. post: tags: - resource-management requestBody: content: application/json: schema: $ref: '#/components/schemas/resourceNote' examples: example-expiryDateType-1: value: subject: Device created for maintain logs-updated description: The Device is for auditing purpose only-updated expiryDateType: 1 example-expiryDateType -2: value: subject: Device created for maintain logs-updated description: The Device is for auditing purpose only-updated expiryDateType: 2 startTime: '2016-03-26T10:10:10+0000' expiryTime: '2016-04-26T10:10:10+0000' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/resourceNote' examples: example-notes: value: id: 50 subject: Device created for maintain logs description: The Device is for auditing purpose only createdTime: '2016-03-21T12:02:11+0000' updatedTime: '2016-03-21T12:02:11+0000' startTime: '2016-03-25T15:40:10+0000' expiryTime: '2016-04-25T15:40:10+0000' createdBy: id: USR0000002095 loginName: John.Smith lastName: Smith firstName: John email: john.smith@opsramp.com changePassword: false parameters: - schema: type: string in: path name: resourceId required: true - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/resources/{resourceId}/notes/{noteId}': summary: Update Resource Note description: Updates a resource note. post: tags: - resource-management requestBody: content: application/json: schema: $ref: '#/components/schemas/resourceNote' examples: example-expiryDateType-1: value: subject: Device created for maintain logs-updated description: The Device is for auditing purpose only-updated expiryDateType: 1 example-expiryDateType-2: value: subject: Device created for maintain logs-updated description: The Device is for auditing purpose only-updated expiryDateType: 2 startTime: '2016-03-26T10:10:10+0000' expiryTime: '2016-04-26T10:10:10+0000' example-expiryDateType-3: value: subject: Device created for maintain logs-updated description: The Device is for auditing purpose only-updated expiryDateType: 3 description: '' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/resourceNote' examples: example-notes: value: id: 50 subject: Device created for maintain logs-updated description: The Device is for auditing purpose only-updated createdTime: '2016-03-21T12:02:11+0000' updatedTime: '2016-03-21T12:06:26+0000' startTime: '2016-03-26T15:40:10+0000' expiryTime: '2016-04-26T15:40:10+0000' createdBy: id: USR0000002095 loginName: John.Smith lastName: Smith firstName: John email: john.smith@opsramp.com changePassword: false parameters: - schema: type: string in: path name: resourceId required: true - schema: type: string in: path name: noteId required: true - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/resources/{resourceId}/notes/search': summary: Search Resource Notes description: Gets the latest antivirus definitions installed on resources. get: tags: - resource-management responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/resourceNote' totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example-resource-notes: value: results: - id: 49 subject: notes testing with resource-1 description: testing notes createdTime: '2016-03-21T11:46:03+0000' updatedTime: '2016-03-21T11:46:03+0000' startTime: '2016-03-22T15:40:10+0000' expiryTime: '2016-03-24T15:40:10+0000' createdBy: id: USR0000000001 loginName: superadmin lastName: Admin firstName: Super email: sarma519@gmail.com changePassword: false - id: 48 subject: notes testing with resource description: testing notes createdTime: '2016-03-21T11:45:12+0000' updatedTime: '2016-03-21T11:45:12+0000' startTime: '2016-03-22T15:40:10+0000' expiryTime: '2016-03-24T15:41:10+0000' createdBy: id: USR0000000001 loginName: superadmin lastName: Admin firstName: Super email: sarma519@gmail.com changePassword: false - id: 42 subject: Device Notes Test Case - testing description: Testing please ignore 2-testing createdTime: '2016-03-21T08:06:43+0000' updatedTime: '2016-03-21T08:06:43+0000' startTime: '2016-03-22T15:40:10+0000' expiryTime: '2016-03-24T15:41:10+0000' createdBy: id: USR0000002095 loginName: James.Hudson lastName: Hudson firstName: James email: james.h@opsramp.com changePassword: false totalResults: 3 orderBy: note.id pageNo: 1 pageSize: 10 totalPages: 1 nextPage: false nextPageNo: 0 previousPageNo: 0 descendingOrder: true parameters: - schema: type: integer default: 1 in: query name: pageNo - schema: type: integer default: 100 in: query name: pageSize - schema: type: boolean default: true in: query name: isDescendingOrder - schema: type: string default: note.id in: query name: sortName - schema: type: string in: query name: queryString parameters: - schema: type: string in: path name: resourceId required: true - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/devices/{resourceId}/deviceWarranty': summary: Manage Device Warranty description: Creates a device warranty and gets device warranty details. post: description: Creates a warranty for a device. tags: - resource-management responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/warranty' examples: example-resource-warranty: value: - id: 7 purchaseDate: '2015-11-09 12:30:00 UTC' warrantyExpireDate: '2016-12-09 12:30:00 UTC' deviceId: DEV0000011576 requestBody: content: application/json: schema: $ref: '#/components/schemas/warranty' examples: example-resource-warranty: value: purchaseDate: '2015-11-09 12:30:00 UTC' warrantyExpireDate: '2020-12-09 12:30:00 UTC' get: description: Gets device warranty details. tags: - resource-management responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/warranty' examples: example-resource-warranties: value: id: 1 purchaseDate: '2015-11-09T18:00:00+0000' warrantyExpireDate: '2020-12-09T18:00:00+0000' deviceId: fb3d81e9-cb01-4178-a7c7-7336ddd3c756 parameters: - $ref: '#/components/parameters/resourceId' - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/resources/{resourceId}/decommission': summary: Decommission a Resource description: Decommissions a resource. post: tags: - resource-management requestBody: content: application/json: schema: type: object properties: reason: type: string description: (Optional) Reason to decommission a resource. examples: example-decomm-string: value: reason: Decommission Reason/Note responses: '200': description: OK parameters: - $ref: '#/components/parameters/resourceId' - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/resources/{resourceId}/availability': summary: Get Resource Availability description: |- 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: tags: - resource-management responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/availablility' examples: example-resources-availability: value: totalAvailability: 2.2682053322721845 totalDowntime: 2456 totalLogList: - key: 0443e878-92fb-4401-82b3-97bd961d50e5 startTs: 1493622507 endTs: 1493622540 actStartTs: 1493622507 state: 0 rca: false schStartTs: 0 schEndTs: 0 - key: 0443e878-92fb-4401-82b3-97bd961d50e5 startTs: 1493620027 endTs: 1493622450 actStartTs: 1493620027 state: 0 rca: false schStartTs: 0 schEndTs: 0 downTimeList: - key: 0443e878-92fb-4401-82b3-97bd961d50e5 startTs: 1493622507 endTs: 1493622540 actStartTs: 1493622507 state: 0 rca: false schStartTs: 0 schEndTs: 0 - key: 0443e878-92fb-4401-82b3-97bd961d50e5 startTs: 1493620027 endTs: 1493622450 actStartTs: 1493620027 state: 0 rca: false schStartTs: 0 schEndTs: 0 noOfOccurences: 2 noOfPauseOccurences: 0 degradedTimeList: [] noOfDegradedOccurences: 0 totalDegradedTime: 0 pauseTimeList: [] currentState: down totalPauseTime: 0 parameters: - schema: type: string in: query name: startTime description: |- startTime indicates the from date. (Convert the time frame to Epoch timestamp.) For example, if 12 Dec 2018 10:00 AM is the start time, then epoch timestamp is 1544608800 - schema: type: string in: query name: endTime description: | endTime indicates the to date. For example, if 17 Dec 2018 12:00 PM is the end time, then epoch timestamp is 1545048000 parameters: - name: resourceId in: path required: true schema: type: string description: Resource uuid of the managed resource - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/resources/{resourceId}/availability/rule': summary: Manage Resource Availability Rule description: Updates and gets the availability rule defined on a resource. get: description: Gets the availability rule defined on a resource.Refer to Search Resources API to get the list of a client’s resource IDs. tags: - resource-management responses: '200': description: OK content: application/json: schema: type: object properties: availabilityRule: type: string description: type: string examples: example-availability-rule-and: value: availabilityRule: AND description: 'Resource is Up if ALL availability monitors are OK, Resource is Down otherwise' example-availability-rule-or: value: availabilityRule: OR description: 'Resource is Up if ANY availability monitor is OK, Resource is Down otherwise' post: description: Updates the availability rule defined on a resource. tags: - resource-management requestBody: content: application/json: schema: type: object properties: availabilityRule: type: string enum: - AND - OR description: |- AND - Show resource status Up if ALL the availability monitors assigned on the resource are in OK state, else show the status as Down. OR - Show resource status Up if ANY of the availability monitors assigned on the resource are in OK state, else show the status as Down. examples: example-availability-rules: value: availabilityRule: OR description: | >If a value is not defined, a value of Null is assumed and the availability rule is not updated. responses: '200': description: OK parameters: - schema: type: string in: path name: resourceId required: true description: Resource uuid of the managed resource - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/resources/{resourceId}/applications': summary: Get Resource Applications description: Gets the list of applications running on a resource. get: tags: - resource-management responses: '200': description: OK content: application/json: schema: type: array items: type: object properties: id: type: integer name: type: string vendor: type: string version: type: string installedDate: type: string format: date-time createdDate: type: string format: date-time modifiedDate: type: string format: date-time examples: example-resources-applications: value: - id: 538 name: Google Chrome vendor: Google Inc. version: 51.0.2704.63 installedDate: '2016-05-27T00:00:00+0000' createdDate: '2016-05-30T10:13:27+0000' modifiedDate: '2016-06-09T07:58:25+0000' - id: 539 name: Internet Explorer vendor: Microsoft Corporation version: 8.0.7600.16385 createdDate: '2016-05-30T10:13:27+0000' modifiedDate: '2016-06-09T07:58:25+0000' - id: 540 name: Microsoft .NET Framework 4 Client Profile vendor: Microsoft Corporation version: 4.0.30319 createdDate: '2016-05-30T10:13:27+0000' modifiedDate: '2016-06-09T07:58:25+0000' - id: 541 name: Microsoft Visual C++ 2012 Redistributable (x86) - 11.0.61030 vendor: Microsoft Corporation version: 11.0.61030.0 createdDate: '2016-05-30T10:13:27+0000' modifiedDate: '2016-06-09T07:58:25+0000' - id: 542 name: Oracle VM VirtualBox Guest Additions 5.0.20 vendor: Oracle Corporation version: 5.0.20.0 createdDate: '2016-05-30T10:13:27+0000' modifiedDate: '2016-06-09T07:58:25+0000' - id: 545 name: Microsoft .NET Framework 3.5 SP1 vendor: Microsoft Corporation version: 3.5.30729 installedDate: '2016-01-01T00:00:00+0000' createdDate: '2016-07-24T10:30:18+0000' modifiedDate: '2016-09-07T07:27:42+0000' parameters: - name: resourceId in: path required: true schema: type: string description: Resource uuid of the managed resource - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/resources/{resourceId}/discoveredServices': summary: Get Last Discovered Services. description: Gets the list of last discovered services of the resource.The last discovered services can be maximum 6 hours old. get: tags: - resource-management responses: '200': description: | OK content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/discoveredService' totalResults: type: number orderBy: type: string pageNo: type: number pageSize: type: number totalPages: type: number nextPage: type: boolean previousPageNo: type: number descendingOrder: type: boolean examples: example-services-all: value: results: - name: Application Experience state: Running logonAs: localSystem monitored: false mode: Manual serviceStatus: OK - name: Application Information state: Running logonAs: LocalSystem monitored: false mode: Manual serviceStatus: OK - name: Application Management state: Running logonAs: LocalSystem monitored: false mode: Manual serviceStatus: OK - name: Base Filtering Engine state: Running logonAs: NT AUTHORITY\\LocalService monitored: false mode: Auto serviceStatus: OK - name: Background Intelligent Transfer Service state: Running logonAs: LocalSystem monitored: false mode: Manual serviceStatus: OK - name: Background Tasks Infrastructure Service state: Running logonAs: LocalSystem monitored: false mode: Auto serviceStatus: OK - name: Certificate Propagation state: Running logonAs: LocalSystem monitored: false mode: Manual serviceStatus: OK - name: Cryptographic Services state: Running logonAs: NT Authority\\NetworkService monitored: false mode: Auto serviceStatus: OK - name: DCOM Server Process Launcher state: Running logonAs: LocalSystem monitored: false mode: Auto serviceStatus: OK - name: Device Install Service state: Running logonAs: LocalSystem monitored: false mode: Manual serviceStatus: OK totalResults: 73 pageNo: 1 pageSize: 10 totalPages: 8 nextPage: true nextPageNo: 2 descendingOrder: false operationId: get-api-v2-tenants-tenantId-resources-installedServices-search parameters: - schema: type: string enum: - Paused - Start Pending - Stop Pending - Continue Pending - Stopped - Running example: Running default: Running in: query name: state description: Query based on State of discovered services description: get the list of discovered services of the resource parameters: - $ref: '#/components/parameters/resourceId' - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{tenantId}/resources/auditRecordings/search': summary: Get Console Recording Details of Resources description: Get console recording of resources for an organization. parameters: - $ref: '#/components/parameters/tenantId' get: description: Get console recording of resources. tags: - resource-management responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/auditRecordings' examples: consoles-search-all: value: results: - id: '743' resourceId: ad05b24b-6e61-4101-8718-049ba5370b3a userId: USR000000003 startTime: '2021-05-21T08:25:57+0000' endTime: '2021-05-21T08:26:32+0000' consoleProtocol: SSH url: 'https://app.opsramp.com/itop/webconsole/launchHtml5Player/NzQz' notes: test playbackCodec: HTML5 recStatus: Completed 'hostName ': host1 IpAddress: 199.44.72.19 gatewayIp: 199.44.72.19 loginName: loginName gatewayProfileName: gate-prof - id: '742' resourceId: ad05b24b-6e61-4101-8718-049ba5370b3a userId: USR000000003 gatewayId: 003cccd3-1283-4462-861f-de01a617ec4e ticketId: INC0000000001 startTime: '2021-05-21T08:10:48+0000' endTime: '2021-05-21T08:11:19+0000' consoleProtocol: RDP url: 'https://app.opsramp.com/itop/webconsole/launchHtml5Player/NzQy' notes: test RDP playbackCodec: HTML5 recStatus: Completed 'hostName ': host2 IpAddress: 199.44.72.20 gatewayIp: 199.44.72.19 loginName: loginName gatewayProfileName: gate-prof - id: '741' resourceId: ad05b24b-6e61-4101-8718-049ba5370b3a userId: USR000000003 startTime: '2021-05-18T14:45:51+0000' endTime: '2021-05-18T14:46:12+0000' consoleProtocol: SSH url: 'https://app.opsramp.com/computer.do?action=launchPlayer&recId=741' notes: test playbackCodec: HTML5 recStatus: Completed 'hostName ': host3 IpAddress: 199.44.72.29 gatewayIp: 199.44.72.39 loginName: loginName gatewayProfileName: gate-prof - id: '740' resourceId: ad05b24b-6e61-4101-8718-049ba5370b3a userId: USR000000003 gatewayId: 003cccd3-1283-4462-861f-de01a617ec4e startTime: '2021-05-18T13:59:32+0000' endTime: '2021-05-18T14:01:17+0000' consoleProtocol: RDP url: 'https://app.opsramp.com/itop/webconsole/launchHtml5Player/NzQw' notes: ops test playbackCodec: HTML5 recStatus: Completed - id: '739' resourceId: ad05b24b-6e61-4101-8718-049ba5370b3a userId: USR000000003 ticketId: INC0000000001 startTime: '2021-05-18T13:55:05+0000' endTime: '2021-05-18T14:01:14+0000' consoleProtocol: SSH url: 'https://app.opsramp.com/itop/webconsole/launchHtml5Player/NzM5' notes: test playbackCodec: HTML5 recStatus: Completed 'hostName ': host1 IpAddress: 199.44.72.31 gatewayIp: 199.44.72.36 loginName: loginName gatewayProfileName: gate-prof totalResults: 650 orderBy: id pageNo: 1 pageSize: 5 totalPages: 130 nextPage: true nextPageNo: 2 previousPageNo: 0 descendingOrder: true single-console: value: results: - id: '311' resourceId: ad05b24b-6e61-4101-8718-049ba5370b3a userId: USR000000003 ticketId: INC0000000001 startTime: '2020-12-18T10:32:10+0000' endTime: '2020-12-18T10:35:57+0000' consoleProtocol: SSH url: 'https://app.opsramp.com/itop/webconsole/launchHtml5Player/MzEx' notes: browser consoles test playbackCodec: HTML5 recStatus: Completed totalResults: 1 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true consoles-by-users: value: results: - id: '503' resourceId: ad05b24b-6e61-4101-8718-049ba5370b3a userId: USR000000005 startTime: '2021-05-21T08:25:57+0000' endTime: '2021-05-21T08:26:32+0000' consoleProtocol: SSH url: 'https://app.opsramp.com/itop/webconsole/launchHtml5Player/NzQz' notes: test playbackCodec: HTML5 recStatus: Completed - id: '266' resourceId: ad05b24b-6e61-4101-8718-049ba5370b3a userId: USR000000005 gatewayId: 003cccd3-1283-4462-861f-de01a617ec4e ticketId: INC0000000001 startTime: '2021-05-21T08:10:48+0000' endTime: '2021-05-21T08:11:19+0000' consoleProtocol: RDP url: 'https://app.opsramp.com/itop/webconsole/launchHtml5Player/NzQy' notes: test playbackCodec: HTML5 recStatus: Completed totalResults: 2 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true console-by-client: value: results: - id: '450' client: uniqueId: client_35 name: Demo resourceId: yx3z4e21-5e51-7101-3718-0d92a5376b0s userId: USR000000021 startTime: '2021-04-16T15:14:43+0000' endTime: '2021-04-16T15:15:14+0000' consoleProtocol: SSH url: 'https://app.opsramp.com/itop/webconsole/launchHtml5Player/NjQ3' notes: demo playbackCodec: HTML5 recStatus: Completed totalResults: 1 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true console-by-mgmt-profiles: value: results: - id: '150' client: uniqueId: client_22 name: ConsoleClient resourceId: ad05b24b-6e61-4101-8718-049ba5370b3a userId: USR0000002711 gatewayId: 010ddd3c-1283-4462-861f-ht673f48de2d startTime: '2020-08-27T15:00:23+0000' endTime: '2020-08-27T15:00:23+0000' consoleProtocol: SSH url: 'https://app.opsramp.com/computer.do?action=launchPlayer&recId=266' playbackCodec: NRC recStatus: Completed totalResults: 1 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true console-by-page: value: results: - id: '699' client: uniqueId: client_22 name: ConsoleClient resourceId: ad05b24b-6e61-4101-8718-049ba5370b3a userId: USR000000003 startTime: '2021-05-06T07:51:35+0000' endTime: '2021-05-06T07:54:06+0000' consoleProtocol: SSH url: 'https://app.opsramp.com/itop/webconsole/launchHtml5Player/Njk5' notes: test playbackCodec: HTML5 recStatus: Completed - id: '698' client: uniqueId: client_22 name: ConsoleClient resourceId: ad05b24b-6e61-4101-8718-049ba5370b3a userId: USR000000003 startTime: '2021-05-06T07:25:36+0000' endTime: '2021-05-06T07:50:34+0000' consoleProtocol: SSH url: 'https://app.opsramp.com/itop/webconsole/launchHtml5Player/Njk4' notes: test playbackCodec: HTML5 recStatus: Completed - id: '697' client: uniqueId: client_22 name: ConsoleClient resourceId: ad05b24b-6e61-4101-8718-049ba5370b3a userId: USR000000003 startTime: '2021-05-06T07:10:03+0000' endTime: '2021-05-06T07:22:02+0000' consoleProtocol: SSH url: 'https://app.opsramp.com/itop/webconsole/launchHtml5Player/Njk3' notes: test playbackCodec: HTML5 recStatus: Completed - id: '696' client: uniqueId: client_22 name: ConsoleClient resourceId: ad05b24b-6e61-4101-8718-049ba5370b3a userId: USR000000003 startTime: '2021-05-06T07:08:59+0000' endTime: '2021-05-06T07:09:37+0000' consoleProtocol: SSH url: 'https://app.opsramp.com/itop/webconsole/launchHtml5Player/Njk2' notes: test playbackCodec: HTML5 recStatus: Completed - id: '695' client: uniqueId: client_22 name: ConsoleClient resourceId: ad05b24b-6e61-4101-8718-049ba5370b3a userId: USR000000003 startTime: '2021-05-06T07:07:07+0000' endTime: '2021-05-06T07:07:49+0000' consoleProtocol: SSH url: 'https://app.opsramp.com/itop/webconsole/launchHtml5Player/Njk1' notes: test playbackCodec: HTML5 recStatus: Completed totalResults: 681 orderBy: id pageNo: 10 pageSize: 5 totalPages: 137 nextPage: true nextPageNo: 11 previousPageNo: 9 descendingOrder: true operationId: get_consoles parameters: - schema: type: number in: query name: pageNo description: queried page - schema: type: number in: query name: pageSize description: size of the query objects - schema: type: string in: query name: queryString description: queryString - schema: type: string in: query name: userId description: user uniqueId - schema: type: string in: query name: startDate description: 'Date range start time e.g. 2021-01-05T05:17:58 0000' - schema: type: string in: query name: endDate description: 'Date range end time e.g. 2021-01-05T05:17:58 0000' - schema: type: string in: query name: resourceId description: resource uniqueId - schema: type: string in: query name: ticketId description: ticket uniqueId - schema: type: string in: query name: gatewayId description: gateway profile uniqueId - schema: type: string enum: - RDP - SSH - TELNET example: SSH in: query name: consoleType description: Console communication protocol - schema: type: string enum: - Open - Completed example: Completed in: query name: recStatus description: recording status - schema: type: string in: query name: clientId description: client uuid '/api/v2/tenants/{clientId}/resources/{resourceId}/remoteConsoles': summary: Manages Remote Consoles of the Resource description: |- Create or list all the remote consoles of the resource. ### Supported Fields |Name|Type|Mandatory|References| |--------|--------|--------|--------| |consoleConnector|String|true|Agent, Gateway| |consoleProtocol|String|true|SSH,RDP,TELNET| |ipAddress|String |true| | |port|Integer|true| | |consoleAuthType|String|false|PASSWORD, PUBLICKEY| |userName|String |false| | |password|String|false| | |name|String|false| | parameters: - $ref: '#/components/parameters/resourceId' - $ref: '#/components/parameters/clientId' get: description: List all the remote consoles on the resource. tags: - resource-management responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/listRemoteConsoles' examples: example-resource-consoles: value: results: - consoleConnector: Agent consoleProtocol: RDP name: RDp console - consoleConnector: Agent consoleProtocol: RDP name: 'RDP 172.26.105.140:3389' - consoleConnector: Agent consoleProtocol: RDP name: RDP Test Console - consoleConnector: Gateway consoleProtocol: RDP name: 'RDP 192.168.56.121: 23' - consoleConnector: Agent consoleAuthType: PASSWORD consoleProtocol: SSH name: 'SSH 1.2.4.35: 22' totalResults: 17 pageNo: 1 pageSize: 5 totalPages: 4 nextPage: true nextPageNo: 2 previousPageNo: 0 descendingOrder: false operationId: getRemoteConsoleDetails post: operationId: createResourceConsole responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/remoteConsole' examples: example-1: value: - ipAddress: 192.168.56.103 port: '22' consoleConnector: Agent consoleAuthType: PASSWORD consoleProtocol: SSH userName: vadmin name: Agent SSH console - ipAddress: 192.168.56.112 port: '3389' consoleConnector: Gateway consoleProtocol: RDP name: Gateway RDP tags: - resource-management requestBody: content: application/json: schema: $ref: '#/components/schemas/remoteConsole' examples: example-resource-consoles-config: value: - consoleConnector: Agent consoleAuthType: PASSWORD consoleProtocol: SSH ipAddress: 192.168.56.103 port: '22' userName: vadmin name: Agent SSH console - consoleConnector: Gateway consoleProtocol: RDP ipAddress: 192.168.56.112 port: '3389' name: Gateway RDP description: '' description: |- * consoleAuthTypes - PASSWORD or PUBLICKEY only applicable if the consoleProtocol is SSH. * consoleProtocol - TELNET,SSH,RDP for browser consoles '/api/v2/tenants/{clientId}/devices/{resourceId}/{actions}': summary: Perform Resource Management Actions description: Perform manage or un-manage action on a given resource. parameters: - $ref: '#/components/parameters/clientId' - $ref: '#/components/parameters/resourceId' - schema: type: string enum: - manage - unmanage example: manage name: actions in: path required: true description: Manage or UnManage action on the resource post: summary: Perform Resource Management Actions tags: - resource-management responses: '200': description: OK operationId: get-api-v2-tenants-clientId-devices-resourceId-actions '/api/v2/tenants/{clientId}/history/resources': summary: Search Decommissioned Resources description: Gets the list of decommissioned resources. get: tags: - resource-management parameters: - schema: type: integer default: 1 in: query name: pageNo - schema: type: integer default: 100 in: query name: pageSize - schema: type: string in: query name: queryString responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/resourceFull' totalResults: type: integer pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean descendingOrder: type: boolean examples: example-resources-history: value: results: - id: 740e2b6d-77ae-46d0-85ca-414e41607b15 hostName: SJLPT1122 ipAddress: 161.43.12.54 dns: opsrampdev updatedDate: '2018-08-02T10:24:16+0000' deviceType: Linux devicePath: Server >> Linux type: DEVICE state: Decommissioned macAddress: '0A:00:27:00:00:02' make: innotek GmbH model: VirtualBox osName: Ubuntu 16.04.4 LTS serialNumber: 7GH9NH2 systemUID: 5G6H6874-1246-4H60-9012-D4C04F4E4123 description: 'BIOS Date: 09/12/17 00:52:26 Ver: 1.6.4.00 ' agentInstalled: true aliasName: HYDLPT117@OpsRamp name: SJLPT117 resourceName: SJLPT117 resiurceType: Linux attributes: provider: AWS instanceId: i-373dcec7 instanceState: running instanceType: t1.micro publicIp: 54.211.85.6 ami: ami-84562dec launchDate: '2015-11-03T21:14:28+0000' owner: '23422135901' privateDns: ip-10-33-136-158.ec2.internal privateIp: 12.32.345.132 zone: us-east-1e monitoringState: disabled managementProfile: id: 7 name: vg-ubuntu16 type: Gateway tags: - name: vmtesttag value: tagvalue history: decommissionReason: Sample decommission reason - id: d0d2c5f0-22e0-4a02-be73-135e696ca4f9 hostName: Windows-SJ ipAddress: 123.11.32.34 dns: Sample DNS updatedDate: '2018-07-27T09:48:48+0000' type: DEVICE state: Decommissioned serialNumber: HYD102394574 agentInstalled: false managementProfile: id: 7 name: vg-ubuntu16 type: Gateway history: decommissionReason: Replacement of the server - id: fd6b542f-e35c-4d34-8068-47e4f2e92391 hostName: globalasset1 ipAddress: 132.23.1.2 updatedDate: '2018-07-27T09:36:48+0000' type: DEVICE state: Decommissioned systemUID: 6709ADA4-2345-C148-DCDE-4236F5C6DE12 agentInstalled: false attributes: instanceId: /subscriptions/9ee6993f-a036-4118-9eab-c66d9fda1ef3/resourceGroups/TEST/providers/Microsoft.Compute/virtualMachines/globalasset1 history: decommissionReason: Expiry of the Instance - id: fbb6c1df-b85e-4016-bcac-93487b6129f4 hostName: TestLinuxVM ipAddress: 10.0.0.4 updatedDate: '2018-07-26T12:46:42+0000' type: DEVICE state: Decommissioned systemUID: 223C543D-0CD7-2A56-2345-3DCDD332901D agentInstalled: false tags: - name: vmtesttag value: tagvalue history: decommissionReason: Sample decommission reason - id: f22d5518-d380-4edf-a6f4-1fb52af83151 hostName: Linux-SJ ipAddress: 12.321.43.125 updatedDate: '2018-07-21T11:03:47+0000' type: DEVICE state: Decommissioned agentInstalled: false tags: - name: Device Location value: SJ history: decommissionReason: Sample decommission reason totalResults: 5 pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false descendingOrder: false parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/history/resources/{resourceId}': summary: Get Decommissioned Resource Data description: Gets the data of a decommissioned resource. get: tags: - resource-management parameters: - schema: type: string in: query name: additionalInfo description: |- Fetch additional resource data, such as: - BIOS - Network cards - Physical disks - Logical disks - CPUs - Video cards responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/resourceFull' examples: example-data: value: id: 740e2b6d-77ae-46d0-85ca-414e41607b15 hostName: SJJCD110022 ipAddress: 142.11.32.12 dns: opsrampdev updatedDate: '2018-08-02T10:24:16+0000' deviceType: Linux devicePath: Server >> Linux type: DEVICE state: Decommissioned macAddress: '0A:00:12:00:00:02' make: innotek GmbH model: VirtualBox osName: Ubuntu 16.04.4 LTS serialNumber: 8FL9NH2 systemUID: 5D6C3423-2123-5F21-6836-H5D75G6G1232 description: 'BIOS Date : 09/12/17 00:52:26 Ver : 1.6.4.00 ' agentInstalled: true aliasName: HYDLPE1010@OpsRamp name: SJJCD110022 resourceName: SJJCD110022 attributes: provider: AWS instanceId: i-453dccd2 instanceState: running instanceType: t1.micro publicIp: 52.321.54.2 ami: ami-84562dec launchDate: '2015-11-03T21:14:28+0000' owner: '321432654123' privateDns: ip-11-12-142-221.ec2.internal privateIp: 11.12.142.221 zone: us-east-1e monitoringState: disabled managementProfile: id: 7 name: vg-ubuntu16 type: Gateway tags: - name: Device location value: SJ history: decommissionReason: Replacement of resource example-additional-data: value: id: 740e2b6d-77ae-46d0-85ca-414e41607b15 hostName: SJJCD110022 ipAddress: 142.11.32.12 dns: opsrampdev updatedDate: '2018-08-02T10:24:16+0000' deviceType: Linux devicePath: Server >> Linux type: DEVICE state: Decommissioned macAddress: '0A:00:12:00:00:02' make: innotek GmbH model: VirtualBox osName: Ubuntu 16.04.4 LTS serialNumber: 8FL9NH2 systemUID: 5D6C3423-2123-5F21-6836-H5D75G6G1232 description: 'BIOS Date : 09/12/17 00:52:26 Ver : 1.6.4.00 ' agentInstalled: true aliasName: HYDLPE132@OpsRamp name: SJJCD110022 resourceName: SJJCD110022 resourceType: Linux attributes: provider: AWS instanceId: i-373dcec7 instanceState: running instanceType: t1.micro publicIp: 52.321.54.2 ami: ami-84562dec launchDate: '2015-11-03T21:14:28+0000' owner: '321432654123' privateDns: ip-11-12-142-221.ec2.internal privateIp: 11.12.142.221 zone: us-east-1e monitoringState: disabled managementProfile: id: 7 name: vg-ubuntu16 type: Gateway tags: - name: Device location value: SJ history: decommissionReason: Replacement of resource bios: biosName: 'BIOS Date : 09/12/17 00:52:26 Ver : 1.6.4.00 ' biosVersion: 1.6.4 smBiosVersion: 1.6.4 smBiosMajorVersion: '3' smBiosMinorVersion: '0' smBiosPresent: 'True' systemSerial: 8FL9NH2 systemModel: Latitude 5580 systemManufacturer: Microsoft Corporation networkCards: - id: 44373 networkName: Intel(R) Dual Band Wireless-AC 8265 ipAddress: '162.12.321.414;de12::21dd:3f:f412:321v;' macAddress: '5C:SD:4D:45:5D:56' dhcpEnabled: true linkMode: MGNT_MODE_LINK physicalDisks: - name: \\.\PHYSICALDRIVE0 model: ST500LM021-1KJ152 manufacturer: (Standard disk drives) interfaceType: IDE partitions: 4 mediaType: Fixed hard disk media logicalDisks: - total: 107 free: 73 fileSystem: NTFS name: 'C:' description: Local Fixed Disk monitor: true utilizationWarningThreshold: 0 utilizationCriticalThreshold: 0 freeDiskWarningThreshold: 0 freeDiskCriticalThreshold: 0 - total: 182 free: 146 fileSystem: NTFS name: 'D:' description: Local Fixed Disk monitor: true utilizationWarningThreshold: 0 utilizationCriticalThreshold: 0 freeDiskWarningThreshold: 0 freeDiskCriticalThreshold: 0 - total: 175 free: 175 fileSystem: NTFS name: 'E:' description: Local Fixed Disk monitor: true utilizationWarningThreshold: 0 utilizationCriticalThreshold: 0 freeDiskWarningThreshold: 0 freeDiskCriticalThreshold: 0 cpus: - processor: CPU0 processorName: Intel(R) Core(TM) i5-7200U CPU @ 2.50GHz processorVersion: '' manufacturer: GenuineIntel family: '205' powerManagementSupported: false l2CacheSize: 512 maxClockSpeed: 2701 dataWidth: 64 numberOfCores: 2 videoCards: - name: Intel(R) HD Graphics 620 ram: 1024MB version: 21.20.16.4627 resolution: 1366 x 768 x 4294967296 colors bitsPerPixel: '32' parameters: - name: resourceId in: path required: true schema: type: string description: Resource uuid of the managed resource - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/devices/wsussettings/{action}': summary: Change WSUS Settings description: The endpoint to assign agent policy for resources. post: tags: - resource-management requestBody: content: application/json: schema: type: array items: type: object properties: entityId: type: string description: Id of the entity entityType: type: string enum: - DEVICE - DEVICE_GROUP - SITE example: DEVICE description: 'Type of entity i..e Resource or Resource Group or Site ' examples: example-wsus: value: - entityId: '717' entityType: SITE - entityId: DGP-437315a3-0931-4165-b960-10e06642e942 entityType: DEVICE_GROUP - entityId: 123237d7-9854-454d-ae97-7ad007efa486 entityType: DEVICE responses: '200': description: OK parameters: - schema: type: string enum: - enable - disable in: path name: action required: true description: Supporting actions enable or disable - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/deviceGroups': summary: Create and update device groups description: |- 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. post: tags: - resource-management responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/deviceGroup' examples: example-rg-create: value: - id: DGP-a20e13ad-e98f-416e-a9dd-40158ffdb2af name: Storage Device Group createdDate: '2017-08-10T07:28:47+0000' updatedDate: '2017-08-10T07:28:47+0000' entityType: DEVICE_GROUP kbArticlesIds: - 10897 - id: DGP-0cd9cf8e-bb6b-42ac-b438-1c005679f543 name: Warehouse Device Group createdDate: '2017-11-14T06:20:09+0000' updatedDate: '2017-11-14T06:20:09+0000' entityType: DEVICE_GROUP filterCriteria: matchType: ANY rules: - key: Name operator: Contains value: Switch resourceType: DEVICE - key: Topic Name operator: Contains value: sns resourceType: SNS example-rg-update: value: - id: DGP-a20e13ad-e98f-416e-a9dd-40158ffdb2af name: Network Device Groups description: Network Device Groups in SJ Site entityType: DEVICE_GROUP kbArticlesIds: - 10897 example-rg-add-as-child: value: - id: DGP-1d021aca-f360-4c14-967c-892296b7d4f5 name: Commincations Server description: Communications Server in SJ createdDate: '2017-08-10T07:40:55+0000' updatedDate: '2017-08-10T07:40:55+0000' entityType: DEVICE_GROUP kbArticlesIds: - 20123 - id: DGP-c87c9dd5-b7fe-498d-a242-338683e745b4 name: Print Servers description: Print Servers in SJ createdDate: '2017-08-10T07:40:55+0000' updatedDate: '2017-08-10T07:40:55+0000' entityType: DEVICE_GROUP filterCriteria: matchType: ALL rules: - key: Name operator: Contains value: Luminax resourceType: DEVICE - key: Region Name operator: Contains value: SJ resourceType: DEVICE kbArticlesIds: - 20122 requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/deviceGroup' examples: example-rg-create: value: - name: Storage Device Group entityType: DEVICE_GROUP kbArticlesIds: - 10897 - name: Warehouse Device Group entityType: DEVICE_GROUP filterCriteria: matchType: ANY rules: - key: Name operator: Contains value: Switch resourceType: DEVICE - key: Topic Name operator: Contains value: sns resourceType: SNS example-rg-update: value: - id: DGP-a20e13ad-e98f-416e-a9dd-40158ffdb2af name: Network Device Groups description: Network Devices in SJ Office entityType: DEVICE_GROUP kbArticlesIds: - 10897 example-rg-add-as-child: value: - name: Communications Server description: Communications server in SJ parent: id: DGP-a20e13ad-e98f-416e-a9dd-40158ffdb2af entityType: DEVICE_GROUP kbArticlesIds: - 20123 - name: Print Servers description: Print Servers in SJ parent: id: DGP-a20e13ad-e98f-416e-a9dd-40158ffdb2af entityType: DEVICE_GROUP filterCriteria: matchType: ALL rules: - key: Name operator: Contains value: Luminax resourceType: DEVICE - key: Region Name operator: Contains value: SJ resourceType: DEVICE kbArticlesIds: - 20122 description: '' parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/deviceGroups/{resourceGroupId}': summary: Manage Device Groups description: Gets device group details and delete sdevice groups. delete: description: |- Deletes a device group. ### Notes - Deleting a device group indicates removing the device group name and details. - Resources under a deleted device group are retained and available in infrastructure APIs. - Deleting a parent device group deletes child device groups. tags: - resource-management responses: '200': description: OK get: description: Gets the details of a device group. tags: - resource-management responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/deviceGroup' examples: example-rg-without-policy: value: id: DGP-1c31a30a-95e9-4b5d-809b-ff3a193c8001 name: Network Devices createdDate: '2017-08-08T12:16:26+0000' updatedDate: '2017-08-08T12:16:26+0000' type: DEVICE_GROUP example-rg-with-policy-and-parent: value: id: DGP-1c31a30a-95e9-4b5d-809b-ff3a193c8001 name: LAP Storage Devices description: '' createdDate: '2017-08-08T12:16:26+0000' updatedDate: '2017-11-14T06:20:09+0000' type: DEVICE_GROUP parent: id: DGP-a215ea93-d824-46a6-b434-9c59ceaca7bc name: Storage type: DEVICE_GROUP resourceType: DEVICE_GROUP filterCriteria: id: 1319 matchType: ALL rules: - id: 214 key: Name operator: Contains value: 172.31.23 resourceType: DEVICE - key: Site Name operator: Contains value: US-WA resourceType: DEVICE entityType: DEVICE_GROUP parameters: - name: clientId in: path required: true schema: type: string description: Describes the clientId of the tenant - $ref: '#/components/parameters/resourceGroupId' '/api/v2/tenants/{clientId}/deviceGroups/minimal': summary: Get Minimal Details of Device Groups description: Gets minimal details of device groups. get: tags: - resource-management responses: '200': description: OK content: application/json: schema: type: array items: type: object properties: id: type: string name: type: string examples: example-rg-minimal: value: - id: DGP-a705e5c9-0825-4f52-b403-c43106be6d34 name: Agent Devices - id: DGP-3cac84fa-1613-4035-ac23-e44c0a450a9c name: Communication Servers - id: DGP-876f73a7-c0e4-409c-a757-5c64205ff97a name: SJ-WINDOWS - id: DGP-04af6cb6-269b-4785-a4e1-17773c1bf43c name: Network Devices - id: DGP-420a80f4-5fba-46d5-a1c1-20e2df4a326a name: Storage Resources parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/deviceGroups/search': summary: Get Root Level Device Groups description: Gets the root level device groups. get: tags: - resource-management responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: type: object properties: id: type: string name: type: string createdDate: type: string updatedDate: type: string type: type: string entityType: type: string totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example-rg-search: value: results: - id: DGP-46f180ed-5ab8-45e2-a06b-e902f53a2b3c name: Storage Device Group createdDate: '2017-08-08T12:16:26+0000' updatedDate: '2017-08-08T12:16:26+0000' type: DEVICE_GROUP entityType: DEVICE_GROUP - id: DGP-dd1ac3ae-549b-4b41-a4f9-3a3af592334d name: Windows Device Group createdDate: '2017-08-08T07:44:21+0000' updatedDate: '2017-08-08T07:45:28+0000' type: DEVICE_GROUP entityType: DEVICE_GROUP - id: DGP-9d3d15f3-8ce4-4027-88a3-e36f9033dad3 name: IT Support Devices description: '' createdDate: '2017-05-11T12:32:12+0000' updatedDate: '2017-07-13T11:14:25+0000' type: DEVICE_GROUP entityType: DEVICE_GROUP - id: DGP-0f3c5bbd-3a0c-4d57-a4db-64c1e7a895a0 name: Communication Servers description: '' createdDate: '2017-05-11T12:20:09+0000' updatedDate: '2017-05-11T12:20:10+0000' type: DEVICE_GROUP entityType: DEVICE_GROUP - id: DGP-63a8881c-a537-40d9-bc89-100b5fe98933 name: SJ Network Device Group createdDate: '2017-04-27T07:31:30+0000' updatedDate: '2017-04-27T07:31:30+0000' type: DEVICE_GROUP entityType: DEVICE_GROUP totalResults: 5 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true parameters: - schema: type: integer default: 1 in: query name: pageNo - schema: type: integer default: 100 in: query name: pageSize - schema: type: boolean default: true in: query name: isDescendingOrder - schema: type: string default: id in: query name: sortName - schema: type: string in: query name: queryString parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/deviceGroups/{resourceGroupId}/childs': summary: Manage Child Resources for Device Groups description: Assigns and unassigns a child resources for device groups. post: description: Manually adds devices and resources to a device group without a defined set of rules. tags: - resource-management requestBody: content: application/json: schema: type: array items: type: object properties: id: type: string description: | Device unique ID. name: type: string type: type: string description: | Device/Resource type. required: - id - type examples: example-rg-hierarchy: value: - id: fcc492e9-64df-4ef0-b1b7-82167d87d4b4 name: 'arn:aws:sns:us-east-1:290642135901:cloudtrail-sns' type: SNS - id: 57778bb1-a294-450a-93e4-4371a74ac39f name: 'arn:aws:sns:us-east-1:290642135901:onboa-demo-sns' type: SNS - id: f7f247e2-3461-4ff1-bfdb-65ee2124c6c3 name: 'arn:aws:sns:us-east-1:290642135901:alarm-notifications-topic' type: SNS responses: '200': description: OK delete: description: Manually removes devices and resources from a device group. tags: - resource-management requestBody: content: application/json: schema: type: array items: type: object properties: id: type: string examples: example-remove-rg: value: - id: 042761ba-542e-4a7a-8e38-3ebbea7eeb16 - id: 023471da-698b-3a2e-1e93-6dbaca8eea23 - id: 855eb82e-3064-40a1-a26e-77efabe300da responses: '200': description: OK parameters: - name: clientId in: path required: true schema: type: string description: Describes the clientId of the tenant - $ref: '#/components/parameters/resourceGroupId' '/api/v2/tenants/{clientId}/deviceGroups/{resourceGroupId}/childs/search': summary: Get Child Resources and Device Groups description: Gets the child resources or child device groups within a parent device group. get: tags: - resource-management responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/resource' totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean nextPageNo: type: integer previousPageNo: type: integer descendingOrder: type: boolean examples: example-rg-childs-search-resources: value: results: - id: DGP-bc92ea8e-f3cd-476e-a736-a8e606d43207 name: Network Devices createdDate: '2017-08-09T09:52:26+0000' updatedDate: '2017-08-09T09:52:26+0000' type: DEVICE_GROUP entityType: DEVICE_GROUP - id: e6d7e7a5-a410-47fe-a99d-33323b700d04 name: dot-exp-bos-045.massdot.trans.internal type: DEVICE resourceType: VMWAREHOST hostName: '' resourceName: dot-exp-bos-045.massdot.trans.internal aliasName: '' - id: e14dae78-b68a-4179-98db-02eab5feeea7 name: dot-exp-bos-039.massdot.trans.internal type: DEVICE resourceType: VMWAREHOST hostName: '' resourceName: dot-exp-bos-039.massdot.trans.internal aliasName: '' - id: 4b53d84c-760a-49cb-a904-47271aed9091 name: dot-exp-bos-022.massdot.trans.internal type: DEVICE resourceType: VMWAREHOST hostName: '' resourceName: dot-exp-bos-022.massdot.trans.internal aliasName: '' totalResults: 4 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true example-rg-childs-search: value: results: - id: fcc492e9-64df-4ef0-b1b7-82167d87d4b4 name: 'arn:aws:sns:us-east-1:290642135901:cloudtrail-sns' type: SNS - id: 57778bb1-a294-450a-93e4-4371a74ac39f name: 'arn:aws:sns:us-east-1:290642135901:onboa-demo-sns' type: SNS - id: f7f247e2-3461-4ff1-bfdb-65ee2124c6c3 name: 'arn:aws:sns:us-east-1:290642135901:alarm-notifications-topic' type: SNS totalResults: 3 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true parameters: - schema: type: integer default: 1 in: query name: pageNo - schema: type: integer default: 100 in: query name: pageSize - schema: type: boolean default: true in: query name: isDescendingOrder - schema: type: string default: id in: query name: sortName - schema: type: string in: query name: queryString parameters: - $ref: '#/components/parameters/clientId' - $ref: '#/components/parameters/resourceGroupId' '/api/v2/tenants/{tenantId}/{ca_context}/customAttributes': x-internal: true summary: Update Custom Attributes For Entities description: Update Custom Attributes Of Tenant Entities. parameters: - $ref: '#/components/parameters/tenantId' - schema: type: string enum: - DEVICE - SERVICEGROUP - CLIENT name: ca_context in: path required: true description: Custom attributes context post: summary: '' operationId: post-api-v2-tenants-tenantId-ca_context-customAttributes responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/response' examples: example-ca-all-contextTypes: value: failedEntities: {} failedCount: 0 successCount: 0 tags: - resource-management requestBody: content: application/json: schema: $ref: '#/components/schemas/caUpdateModel' examples: example-ca-all-contextTypes: value: entities: - id: string entityType: RESOURCE ca: currentValues: attributeId: string valueId: string updatedValues: attributeId: string valueId: string '/api/v2/tenants/{clientId}/policies/management/search': summary: Search Device Management Policy description: Searches for a device management policy with a policy name. get: tags: - resource-management responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/policy' examples: example-policy-search: value: - id: 210 name: test-Mysql-policyWeb resourceType: DEVICE matchType: ALL rules: - id: 155833 key: Name operator: Contains value: mysql isNativeAttribute: true actions: - action: ASSIGN MONITORINGTEMPLATE items: - item: '4053' parameters: Packet Count: '3' Packet interval: '1000' Data Bytes: '64' instances: {} forceAssignOrUnassign: false - action: ASSIGN KNOWLEDGEARTICLE items: - item: '7188' forceAssignOrUnassign: true executionOrder: 0 - id: 209 name: test-Mysql-policy-Web resourceType: DEVICE matchType: ALL rules: - id: 155863 key: Name operator: Contains value: mysql isNativeAttribute: true actions: - action: Assign Jobs items: - item: asset info itemType: assetinfo itemUid: c072cd67-779a-4206-a3d9-7c761fd563d8 forceAssignOrUnassign: true - action: Assign Availability Rule items: - item: AND executionOrder: 0 - id: 205 name: test-Mysql-policy-Web-name resourceType: DEVICE matchType: ALL rules: - id: 154833 key: Name operator: Contains value: mysql isNativeAttribute: true actions: - action: ASSIGN CREDENTIALSET items: - item: '36218' forceAssignOrUnassign: true - action: ASSIGN CUSTOMATTRIBUTES items: - item: '264313' forceAssignOrUnassign: true executionOrder: 0 parameters: - schema: type: string in: query name: name description: | Device management policy name. parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/policies/management': summary: Manage Device Management Policy description: 'Creates and updates device management policies, and gets tenant device management policies, without pagination.' get: description: Gets device management policies of a tenant without pagination. tags: - resource-management responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/policy' examples: example-rm-policies: value: - id: 168 name: Test resourceType: ALL matchType: ANY rules: - id: 155798 filterType: ANY_CLOUD_RESOURCE actions: [] executionOrder: 0 - id: 181 name: TestCAttrdf matchType: ALL rules: - id: 156798 key: Name operator: Contains value: a resourceType: DEVICE isNativeAttribute: true - id: 155833 key: Name operator: Contains value: b resourceType: DEVICE isNativeAttribute: true actions: - action: ASSIGN MONITORINGTEMPLATE items: - item: '4053' parameters: Packet Count: '3' Packet interval: '1000' Data Bytes: '64' instances: {} forceAssignOrUnassign: false executionOrder: 0 - id: 208 name: TestCustom matchType: ANY rules: - id: 155838 key: 'aws:cloudformation:stack-name' operator: Contains value: catalogs resourceType: LOAD_BALANCER isNativeAttribute: false - id: 182199 key: Name operator: Contains value: test2 resourceType: DEVICE isNativeAttribute: true - id: 174698 key: Name operator: Contains value: test3 resourceType: DEVICE isNativeAttribute: true - id: 182239 key: Name operator: Contains value: test4 resourceType: DEVICE isNativeAttribute: true actions: - action: ASSIGN KNOWLEDGEARTICLE items: - item: '7188' forceAssignOrUnassign: true executionOrder: 0 - id: 209 name: TestCustomDevice matchType: ANY rules: - id: 155933 key: BusinessType operator: Contains value: Internal resourceType: DEVICE isNativeAttribute: false - id: 155843 key: 'aws:autoscaling:groupName' operator: Contains value: Test resourceType: DEVICE isNativeAttribute: false actions: - action: Assign Availability Rule items: - item: AND executionOrder: 0 - id: 211 name: TestCombo matchType: ALL rules: - id: 156833 key: Name operator: Contains value: active resourceType: DEVICE isNativeAttribute: true - id: 178833 key: NewField operator: Contains value: active resourceType: DEVICE isNativeAttribute: false - id: 152833 key: Agent Installed operator: Contains value: 'TRUE' resourceType: DEVICE isNativeAttribute: true actions: - action: ASSIGN CUSTOMATTRIBUTES items: - item: '264313' forceAssignOrUnassign: true executionOrder: 0 - id: 240 name: TestLBPartner matchType: ALL rules: - id: 182198 key: Name operator: Contains value: test resourceType: DEVICE isNativeAttribute: true actions: - action: ASSIGN MONITORINGTEMPLATE forceAssignOrUnassign: true items: - item: '6693' parameters: {} instances: {} executionOrder: 0 - id: 250 name: TestEpicGames matchType: ALL rules: - id: 155333 key: TestEpic operator: Contains value: TestEpicValue2 resourceType: DEVICE isNativeAttribute: false actions: - action: ASSIGN CREDENTIALSET items: - item: '36218' forceAssignOrUnassign: true executionOrder: 0 - id: 251 name: TestEpicElb matchType: ALL rules: - id: 182198 key: Name operator: Contains value: test resourceType: DEVICE isNativeAttribute: true actions: - action: ASSIGN MONITORINGTEMPLATE forceAssignOrUnassign: true items: - item: '6693' parameters: {} instances: {} executionOrder: 0 - id: 257 name: TestCase matchType: ALL rules: - id: 115833 key: Name operator: Contains value: ce resourceType: DEVICE isNativeAttribute: true - id: 155893 key: Name operator: Contains value: d resourceType: DEVICE isNativeAttribute: true actions: - action: ASSIGN MONITORINGTEMPLATE forceAssignOrUnassign: true items: - item: '2761' parameters: Apache Port: '8443' instances: {} executionOrder: 0 - id: 264 name: TestPolicy2 matchType: ALL rules: - id: 255833 key: Name operator: Contains value: hydlpt311 resourceType: DEVICE isNativeAttribute: true - id: 156633 key: Name operator: Contains value: '204' resourceType: DEVICE actions: [] executionOrder: 0 - id: 265 name: check-policy-name-update matchType: ALL rules: - id: 155893 key: Name operator: Contains value: test resourceType: DEVICE isNativeAttribute: true actions: - action: ASSIGN MONITORINGTEMPLATE forceAssignOrUnassign: true items: - item: '2761' parameters: Apache Port: '8443' instances: {} - action: UNASSIGN MONITORINGTEMPLATE forceAssignOrUnassign: true items: - item: '971' parameters: {} instances: {} - action: ASSIGN CREDENTIALSET forceAssignOrUnassign: true items: - item: '309' parameters: {} instances: {} executionOrder: 0 - id: 85908 uid: POLICY-4eb7d892-91dc-4ba9-bc92-980effbea64f name: all actions matchType: ALL rules: - id: 182208 key: Name operator: Contains value: test resourceType: DEVICE isNativeAttribute: true actions: - action: ASSIGN MONITORINGTEMPLATE items: - item: '4053' parameters: Packet Count: '3' Packet interval: '1000' Data Bytes: '64' instances: {} forceAssignOrUnassign: false - action: ASSIGN KNOWLEDGEARTICLE items: - item: '7188' forceAssignOrUnassign: true - action: Assign Jobs items: - item: asset info itemType: assetinfo itemUid: c072cd67-779a-4206-a3d9-7c761fd563d8 forceAssignOrUnassign: true - action: Assign Availability Rule items: - item: AND - action: ASSIGN CREDENTIALSET items: - item: '36218' forceAssignOrUnassign: true - action: ASSIGN CUSTOMATTRIBUTES items: - item: '264313' forceAssignOrUnassign: true summary: '' post: description: Creates a device management policy with required filters on the resources. tags: - resource-management requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/policy' examples: example-policy-assign-all-actions: value: - name: all actions matchType: ALL rules: - key: Name operator: Contains value: test resourceType: DEVICE isNativeAttribute: true actions: - action: ASSIGN MONITORINGTEMPLATE items: - item: '4053' parameters: Packet Count: '3' Packet interval: '1000' Data Bytes: '64' instances: {} forceAssignOrUnassign: false - action: ASSIGN KNOWLEDGEARTICLE items: - item: '7188' forceAssignOrUnassign: true - action: Assign Jobs items: - item: asset info itemType: assetinfo itemUid: c072cd67-779a-4206-a3d9-7c761fd563d8 forceAssignOrUnassign: true - action: Assign Availability Rule items: - item: AND - action: ASSIGN CREDENTIALSET items: - item: '36218' forceAssignOrUnassign: true - action: ASSIGN CUSTOMATTRIBUTES items: - item: 'tagName[value=''tagValue'']' forceAssignOrUnassign: true example-policy-assign-kb-article-with-uid: value: - name: TestArticle matchType: ALL rules: - key: Name operator: Contains value: desktop resourceType: DEVICE isNativeAttribute: true actions: - action: ASSIGN KNOWLEDGEARTICLE items: - item: KB0000000123 forceAssignOrUnassign: true example-policy-assign-template-without-manadatory-config-params: value: - name: test matchType: ALL rules: - key: Name operator: Equals value: https1 resourceType: SYNTHETIC isNativeAttribute: true actions: - action: ASSIGN MONITORINGTEMPLATE items: - item: '28' parameters: {} forceAssignOrUnassign: false description: |- - Supported actions - ASSIGN MONITORINGTEMPLATE - ASSIGN KNOWLEDGEARTICLE - Assign Availability Rule - ASSIGN CUSTOMATTRIBUTES - Assign Jobs - ASSIGN CREDENTIALSET - Supported values for items for given action - For Assign Availability Rule , item value is AND - For ASSIGN CUSTOMATTRIBUTES, item value is tagName[value='tagValue'] - For all others this is number in string eg "12345" - Scenarios for Custom attributes item values in response payload - New TagName : New Tag created with given Name and Tag Value, and Assigned. - Id of New Tag Value added to response - Old TagName and New Tag Value : New Tag Value added to Tag and Assigned - Id of New Tag Value added to response. - Old TagName and Old TagValue : Both the details are verfied and Assigned - Id of TagValue added to Response responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/policy' examples: example-policy-assign-all-actions: value: - id: 85908 uid: POLICY-4eb7d892-91dc-4ba9-bc92-980effbea64f name: all actions matchType: ALL rules: - id: 182208 key: Name operator: Contains value: test resourceType: DEVICE isNativeAttribute: true actions: - action: ASSIGN MONITORINGTEMPLATE items: - item: '4053' forceAssignOrUnassign: false - action: ASSIGN KNOWLEDGEARTICLE items: - item: '7188' forceAssignOrUnassign: true - action: Assign Jobs items: - item: asset info itemType: assetinfo itemUid: c072cd67-779a-4206-a3d9-7c761fd563d8 forceAssignOrUnassign: true - action: Assign Availability Rule items: - item: AND - action: ASSIGN CREDENTIALSET items: - item: '36218' forceAssignOrUnassign: true - action: ASSIGN CUSTOMATTRIBUTES items: - item: '264313' forceAssignOrUnassign: true createdDate: '2020-04-21T12:50:34+0000' updatedDate: '2020-04-21T12:50:34+0000' example-policy-assign-kb-article-with-uid: value: - id: 9 uid: POLICY-ef02531c-b090-4535-8e83-968f00787fa6 name: TestArticle matchType: ALL rules: - id: 16 key: Name operator: Contains value: desktop resourceType: DEVICE isNativeAttribute: true actions: - action: ASSIGN KNOWLEDGEARTICLE items: - item: KB0000000123 forceAssignOrUnassign: true '400': description: Bad Request content: application/json: schema: type: array description: '' minItems: 1 uniqueItems: true items: type: object required: - code - fieldName - message properties: code: type: string minLength: 1 fieldName: type: string minLength: 1 message: type: string minLength: 1 examples: example-invalid-action-item: value: - code: '0002' fieldName: item message: 'ASSIGN CUSTOMATTRIBUTES action does not support Numerical item : 89, please use item : tagName[value=''tagValue''] ' example-error-assign: value: - code: '0002' fieldName: parameters message: Application Type required inorder to assign a template - code: '0002' fieldName: parameters message: connection timeout in ms required inorder to assign a template - code: '0002' fieldName: parameters message: Remote Server Operating System required inorder to assign a template - code: '0002' fieldName: parameters message: Remote Server Script Type required inorder to assign a template summary: '' put: description: Updates the device management policy. tags: - resource-management responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/policy' examples: example-1: value: - id: 1790 name: Mysql-policy resourceType: DEVICE matchType: ALL rules: - key: Name operator: Contains value: dc01-mysql- actions: - action: ASSIGN MONITORINGTEMPLATE items: - item: '4053' parameters: Packet Count: '3' Packet interval: '1000' Data Bytes: '64' instances: {} forceAssignOrUnassign: false - action: ASSIGN CREDENTIALSET items: - item: '36218' forceAssignOrUnassign: true executionOrder: 0 '400': description: Bad Request content: application/json: schema: type: array description: '' minItems: 1 uniqueItems: true items: type: object required: - code - fieldName - message properties: code: type: string minLength: 1 fieldName: type: string minLength: 1 message: type: string minLength: 1 examples: invalid-action-item: value: - code: '0002' fieldName: item message: 'ASSIGN CUSTOMATTRIBUTES action does not support Numerical item : 89, please use item : tagName[value=''tagValue''] ' requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/policy' examples: example-policy-update: value: - id: 1790 resourceType: DEVICE matchType: ALL rules: - key: Name operator: Contains value: dc01-mysql- actions: - action: ASSIGN MONITORINGTEMPLATE items: - item: '4053' parameters: Packet Count: '3' Packet interval: '1000' Data Bytes: '64' instances: {} forceAssignOrUnassign: false - action: ASSIGN CREDENTIALSET items: - item: '36218' forceAssignOrUnassign: true parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/policies/management/{id}': summary: Get and Delete Device Management Policy description: The endpoint is used to get device management policy details and unassign agent policy for resources. delete: description: Unassigns agent policies for resources. tags: - resource-management responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/httpResponse' examples: example-remove-rm-policy: value: status: 200 entity: 'Removed policy with id: 2325' metadata: {} length: -1 headers: {} cookies: {} links: [] stringHeaders: {} allowedMethods: [] statusInfo: family: SUCCESSFUL statusCode: 200 reasonPhrase: OK actualEntity: 'Removed policy with id: 2325' get: description: Gets device management policy details. tags: - resource-management responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/policy' examples: example-rm-policies: value: id: 85908 uid: POLICY-4eb7d892-91dc-4ba9-bc92-980effbea64f name: all actions matchType: ALL rules: - id: 182208 key: Name operator: Contains value: test resourceType: DEVICE isNativeAttribute: true actions: - action: ASSIGN MONITORINGTEMPLATE items: - item: '4053' parameters: Packet Count: '3' Packet interval: '1000' Data Bytes: '64' instances: {} forceAssignOrUnassign: false - action: ASSIGN KNOWLEDGEARTICLE items: - item: '7188' forceAssignOrUnassign: true - action: Assign Jobs items: - item: asset info itemType: assetinfo itemUid: c072cd67-779a-4206-a3d9-7c761fd563d8 forceAssignOrUnassign: true - action: Assign Availability Rule items: - item: AND - action: ASSIGN CREDENTIALSET items: - item: '36218' forceAssignOrUnassign: true - action: ASSIGN CUSTOMATTRIBUTES items: - item: '264313' forceAssignOrUnassign: true parameters: - schema: type: string in: path name: id required: true description: Resource management policy uuid - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/policies/management/{id}/action/run': summary: Run Device Management Policy description: Runs a device management policy. get: tags: - resource-management responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/httpResponse' examples: example-policy-action: value: status: 200 entity: Request to run the policy has been initiated metadata: {} headers: {} length: -1 cookies: {} allowedMethods: [] actualEntity: Request to run the policy has been initiated links: [] statusInfo: family: SUCCESSFUL statusCode: 200 reasonPhrase: OK stringHeaders: {} parameters: - schema: type: string in: path name: id required: true description: Resource management policy uuid - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/serviceGroups': summary: Create or Update Service Group description: |- Use this API to create a parent (root level) service group. This API can perform the following actions on a service group: 1. Create a service group 2. Rename a service group 3. Add set of services to a service group 4. Change knowledge base articles assigned to a service group 5. Add a service group as child to a parent service group post: tags: - resource-management requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/serviceGroup' examples: example-sg-create: value: - name: Finance Inventory createdDate: '2018-06-20T11:33:08+0000' updatedDate: '2018-06-20T11:33:08+0000' childType: SERVICEGROUP frequency: 5 thresholdType: count thresholdLimit: 1 monitorNames: - service.availability.metric include: ALL type: alert alertType: 2 alert: false metrics: [] example-sg-rename: value: - id: SGP-a20e13ad-e98f-416e-a9dd-40158ffdb2af name: Warehouse servers renamed description: Warehouse maintenance servers in North VJ childType: SERVICEGROUP kbArticlesIds: - 1 example-sg-add-child-to-parent: value: - name: Warehouse Inventory createdDate: '2018-06-20T11:33:08+0000' updatedDate: '2018-06-20T11:33:08+0000' childType: DEVICE frequency: 5 thresholdType: count thresholdLimit: 1 monitorNames: - service.availability.metric include: ALL type: alert alertType: 2 alert: false metrics: [] filterCriteria: matchType: ANY rules: - key: Name operator: Contains value: Linux resourceType: DEVICE parent: id: SGP-c93673d0-355e-40bf-807c-44cc1d8678a4 description: '' responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/serviceGroup' examples: example-sg-create: value: - id: SGP-c45e0394-99f5-41ee-ae36-931e991c5b2e name: Finance Inventory createdDate: '2022-04-25T01:28:10+0000' updatedDate: '2022-04-25T01:28:11+0000' linkedService: false childType: SERVICE thresholdType: count thresholdLimit: 1 monitorNames: - service.availability.metric include: ALL type: alert alertType: 2 alert: false client: id: 26813 uniqueId: client_26813 name: Monitoring-integrations activated: true offlineAlertstoThirdPartyTool: false uuid: d200fbb4-ffdf-3a43-9faa-ee70238a204c addOns: - Alert Problem Area - Knowledgebase Management - OS Service Start/Stop Actions - Process Automation - Remote Access Management - SMS and Voice packages: - Hybrid Discovery and Monitoring - Event and Incident Management - Remediation and Automation featureFlags: {} webConsoles: true metrics: [] depth: 0 example-sg-rename: value: - id: SGP-4e78d0cf-060a-45d1-8863-2bbc8bebca05 name: Warehouse servers renamed createdDate: '2022-04-25T01:31:47+0000' updatedDate: '2022-04-25T01:48:58+0000' linkedService: false childType: SERVICE thresholdType: count thresholdLimit: 1 monitorNames: - service.availability.metric kbArticlesIds: - 1 include: ALL type: alert alertType: 2 alert: false client: id: 26813 uniqueId: client_26813 name: Monitoring-integrations activated: true offlineAlertstoThirdPartyTool: false uuid: d200fbb4-ffdf-3a43-9faa-ee70238a204c addOns: - Alert Problem Area - Knowledgebase Management - OS Service Start/Stop Actions - Process Automation - Remote Access Management - SMS and Voice packages: - Hybrid Discovery and Monitoring - Event and Incident Management - Remediation and Automation featureFlags: {} webConsoles: true metrics: [] depth: 0 example-sg-add-child-to-parent: value: - id: SGP-0765b170-e1c9-49d6-8278-af10edfa5c11 name: Warehouse Inventory createdDate: '2022-04-25T01:46:09+0000' updatedDate: '2022-04-25T01:46:09+0000' linkedService: false childType: DEVICE thresholdType: count thresholdLimit: 1 monitorNames: - service.availability.metric include: ALL type: alert alertType: 2 alert: false client: id: 26813 uniqueId: client_26813 name: Monitoring-integrations activated: true offlineAlertstoThirdPartyTool: false uuid: d200fbb4-ffdf-3a43-9faa-ee70238a204c addOns: - Alert Problem Area - Knowledgebase Management - OS Service Start/Stop Actions - Process Automation - Remote Access Management - SMS and Voice packages: - Hybrid Discovery and Monitoring - Event and Incident Management - Remediation and Automation featureFlags: {} webConsoles: true metrics: [] filterCriteria: matchType: ANY rules: - key: Name operator: Contains value: Linux resourceType: DEVICE depth: 0 parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/serviceGroups/{sgId}': summary: Manage Service Group description: Gets and delete service groups. delete: description: |- Deletes a service group. ### Notes - Deleting a service group removes the service group name and its details. - Deleting a parent service group also deletes the child entities (resources or service groups). - Resources or Services under the deleted service group are retained and are available in the OpsRamp infrastructure page. tags: - resource-management responses: '200': description: OK get: description: Gets service group details. tags: - resource-management responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/serviceGroup' examples: example-sg-minimal: value: id: SGP-c93673d0-355e-40bf-807c-44cc1d8678a4 name: VG Lab Inventory createdDate: '2018-06-20T11:48:20+0000' childType: SERVICEGROUP thresholdType: count thresholdLimit: 1 include: ALL type: alert alertType: 0 alert: false metrics: [] example-sg-detailed: value: id: SGP-f4e6100a-7180-43c8-955c-679205bbc419 name: Finance Inventory createdDate: '2018-06-20T12:13:34+0000' updatedDate: '2018-06-20T12:13:34+0000' childType: DEVICE frequency: 5 thresholdType: count thresholdLimit: 1 monitorNames: - service.availability.metric include: ALL type: alert alertType: 2 alert: false metrics: [] parent: id: SGP-c93673d0-355e-40bf-807c-44cc1d8678a4 name: Finance Services childType: SERVICEGROUP alert: false filterCriteria: matchType: ANY rules: - key: Name operator: Contains value: Printer resourceType: DEVICE parameters: - schema: type: string in: path name: sgId required: true description: Service group uuid - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/serviceGroups/link': summary: Link Service Group description: Links or shares an existing service group with other service groups. post: tags: - resource-management requestBody: content: application/json: schema: type: array description: '' minItems: 1 uniqueItems: true items: type: object required: - id - parent properties: id: type: string minLength: 1 parent: type: object properties: id: type: string minLength: 1 required: - id examples: 'example-sg-hierarchy ': value: - id: SGP-0c0c5fd8-7fdc-49f5-af84-4ae245140e59 parent: id: SGP-c282a79c-4295-4a43-9906-1a073eccf076 - id: SGP-0c0c5sd8-7fdc-49f5-ag84-4ae245140e23 parent: id: SGP-k282a79c-4295-5a43-9906-1a073eccf081 responses: '200': description: OK parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/serviceGroups/{sgId}/childs': summary: Manage Child Resource for Service Group description: Assigns and unassigns child resources for a service group. post: description: Adds resources and devices of the same resource type as a child to a service group. tags: - resource-management requestBody: content: application/json: schema: type: array items: type: object properties: id: type: string description: | Service group unique ID or name. name: type: string description: | Service group unique ID or name. required: - id - name examples: example-servicegrp: value: - id: fef562e9-64df-4ef0-b1b7-82167d87d4b4 name: 'arn:aws:sns:us-east-1:290642135901:cloudtrail-sns' - id: 57778bb1-a294-450a-93e4-6534a74ac39f name: 'arn:aws:sns:us-east-1:290642135901:onboard-sns' - id: g5g247e2-3461-4ff1-bfgh-65ee2124c6c3 name: 'arn:aws:sns:us-east-1:290642135901:alarm-notifications-topic' responses: '200': description: OK delete: description: Deletes child resources and devices from a service group. tags: - resource-management requestBody: content: application/json: schema: type: array items: type: object properties: id: type: string name: type: string examples: example-remove-servicegrp: value: - id: fgh672e9-64df-4ef0-b1b7-82167d87d4b4 name: 'arn:aws:sns:us-east-1:290642135901:cloudtrail-sns' - id: 57778bb1-a294-450a-87f5-4371a74ac39f name: 'arn:aws:sns:us-east-1:290642135901:onboa-demo-sns' - id: h5h677e2-3461-4ff1-bfdb-65ee2124c6c3 name: 'arn:aws:sns:us-east-1:290642135901:alarm-notifications-topic' responses: '200': description: OK parameters: - schema: type: string in: path name: sgId required: true description: Service group uuid - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/serviceGroups/unLink/{parentSgId}/{childSgId}': summary: Unlink Child Service Group description: Unlinks a child service group from a parent service group. delete: tags: - resource-management responses: '200': description: OK parameters: - schema: type: string in: path name: parentSgId required: true description: Parent Service Group uuid - schema: type: string in: path name: childSgId required: true description: Child Service Group uuid - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/serviceGroups/{sgId}/childs/search': summary: Get Child Resources and Service Groups description: Gets the child entities (resources or service groups) of a parent service group. get: tags: - resource-management parameters: - schema: type: integer default: 1 in: query name: pageNo description: '' - schema: type: integer default: 100 in: query name: pageSize description: '' - schema: type: boolean default: true in: query name: isDescendingOrder description: '' - schema: type: string default: id in: query name: sortName description: '' - schema: type: string in: query name: queryString responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: type: object properties: id: type: string name: type: string createdDate: type: string format: date-time updatedDate: type: string format: date-time childType: type: string frequency: type: integer thresholdType: type: string thresholdLimit: type: integer monitorNames: type: array items: type: string include: type: string type: type: string alertType: type: integer alert: type: boolean metrics: type: array items: {} totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example-sg-child-entities: value: results: - id: SGP-f4e6100a-7180-43c8-955c-679205bbc419 name: Finance Inventory createdDate: '2018-06-20T12:13:34+0000' updatedDate: '2018-06-20T12:13:34+0000' childType: DEVICE frequency: 5 thresholdType: count thresholdLimit: 1 monitorNames: - service.availability.metric include: ALL type: alert alertType: 2 alert: false metrics: [] totalResults: 1 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true example-sg-child-resources: value: results: - id: a783e031-9f97-49b2-a913-1999ac879e49 name: ubuntu childType: DEVICE alert: false - id: 658ea8aa-b52c-46c4-8143-22000c15b573 name: Windows SJ Lab childType: DEVICE alert: false - id: ae7b2ca4-a08e-4940-8a32-a9568d927095 name: HYDLPT039 childType: DEVICE alert: false - id: f287105e-3bd8-4c39-9f1f-49e2d3f9fdd8 name: import_printer childType: DEVICE alert: false - id: 712a9177-d363-41e8-93ba-f1001d250d06 name: acme-ecomm-aws-api34 childType: DEVICE alert: false - id: aad5642e-b772-4067-8727-31c84f9fbb96 name: VM SJ Lab childType: DEVICE alert: false - id: 55ef8611-4bce-4eab-94bb-a0d6dabc86c9 name: VG-ECC AWS childType: DEVICE alert: false - id: 936f2dea-50f5-42b5-a781-169f2cc1f48c name: JOHN-PC childType: DEVICE alert: false totalResults: 8 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true parameters: - schema: type: string in: path name: sgId required: true description: Service group uuid - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/serviceGroups/search': summary: Get Root-Level Service Groups description: 'Gets root-level, parent service groups.' get: tags: - resource-management parameters: - schema: type: integer default: 1 in: query name: pageNo description: '' - schema: type: integer default: 100 in: query name: pageSize description: '' - schema: type: boolean default: true in: query name: isDescendingOrder description: '' - schema: type: string default: id in: query name: sortName description: '' - schema: type: string in: query name: queryString responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/serviceGroup' totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example-service-groups: value: results: - id: SGP-35ce4940-dc09-43f4-95d7-de4dec4ee9c5 name: Finance Inventory createdDate: '2018-06-20T12:22:11+0000' childType: SERVICEGROUP thresholdType: count thresholdLimit: 1 include: ALL type: alert alertType: 0 alert: false metrics: [] - id: SGP-c93673d0-355e-40bf-807c-44cc1d8678a4 name: VG Lab Servers createdDate: '2018-06-20T11:48:20+0000' childType: SERVICEGROUP thresholdType: count thresholdLimit: 1 include: ALL type: alert alertType: 0 alert: false metrics: [] - id: SGP-d71e0398-f33b-48ba-a283-1fa11ebe3e17 name: Warehouse Maintenance Servers createdDate: '2018-06-20T11:33:08+0000' updatedDate: '2018-06-20T11:43:17+0000' childType: DEVICE frequency: 5 thresholdType: count thresholdLimit: 1 monitorNames: - service.availability.metric include: ALL type: alert alertType: 2 alert: false metrics: [] - id: SGP-0e2ddd05-225e-4078-8d4a-93e03d9aad1b name: Audit Networks createdDate: '2018-06-19T13:04:17+0000' updatedDate: '2018-06-20T11:16:35+0000' childType: DEVICE thresholdType: count thresholdLimit: 1 include: ALL type: alert alertType: 2 alert: false metrics: [] - id: SGP-615a32d1-67b1-47f8-b4e4-e224b66d2ca1 name: Finance Services createdDate: '2018-01-03T12:56:55+0000' childType: DEVICE thresholdType: count thresholdLimit: 1 include: ALL type: alert alertType: 2 alert: false metrics: [] - id: SGP-1a15ad00-69cf-440c-b19e-880d5a550e2b name: Synthetic Monitoring createdDate: '2017-10-24T19:25:25+0000' childType: SYNTHETIC thresholdType: count thresholdLimit: 1 include: ALL type: alert alertType: 0 alert: false metrics: [] - id: SGP-54d8a28a-3b00-4fb5-9079-e008d132f648 name: testing createdDate: '2016-12-08T11:03:02+0000' childType: DEVICE frequency: 5 thresholdType: count thresholdLimit: 1 monitorNames: - service.availability.metric include: ALL type: alert alertType: 2 alert: false metrics: [] totalResults: 7 orderBy: id pageNo: 1 pageSize: 100 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/serviceGroups/minimal': summary: Get Minimal Details of Service Groups description: Gets minimal details (including service group ID and name) of service groups. get: tags: - resource-management responses: '200': description: OK content: application/json: schema: type: array items: type: object properties: id: type: string name: type: string examples: example-sg-minimal-info: value: - id: SGP-d4ad6f5f-c788-4747-b62c-17b59c89ca06 name: Network Engineering Services - id: SGP-c2af3866-fc89-47dd-b83f-bcc8df0b2a0a name: Finance Inventory - id: SGP-d7657432-3698-4894-a07f-c2ef9aa0789e name: ELB - id: SGP-c3d0173b-54a0-4c30-bac9-b48ddaa36bc6 name: VTH Services - id: SGP-63d0163a-d4ac-ec30-fac1-cb2ddaa36b84 name: Cloud Instances parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/sites': summary: Create Site description: Creates a site to organize devices based on location. post: tags: - resource-management requestBody: content: application/json: schema: $ref: '#/components/schemas/site' examples: example-site: value: name: SJ-North_EAST parent: id: 4 name: SJ-East description: Resources in north east zone address: '5th Avenue, Park street' state: California city: San Jose country: USA zip: '94088' primaryContact: id: USR0000000014 loginName: InsLab@organization.com phoneNumber: 406-232-1234 phoneExtension: '1' resources: - id: ad0a218d-7512-435c-9b58-614470ee8658 - id: b7001583-db6a-4c7c-b4df-ab1ba6505d60 filterCriteria: matchType: ANY rules: - key: Name operator: Contains value: SJ resourceType: DEVICE - key: Name operator: Regex value: VM resourceType: LOAD_BALANCER - key: Agent Installed operator: Is value: 'TRUE' resourceType: DEVICE responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/site' examples: example-1: value: id: 31 name: SJ-North_EAST parent: id: 4 name: SJ-East description: Resources in east zone address: Parkway description: Resources in north east zone address: '5th Avenue, Park street' city: San Jose state: california country: USA zip: '94088' phoneNumber: 406-232-1234 phoneExtension: '1' primaryContact: id: USR0000000014 loginName: InsLab@organization.com lastName: Lab firstName: Ins email: john.smith@gamil.com phoneNumber: 406-625-1234 resources: - id: b7001583-db6a-4c7c-b4df-ab1ba6505d60 name: DESKTOP-V5DV65M ipAddress: 192.168.56.1 type: DEVICE - id: 19a49e09-da18-4d91-92b7-01d6858ec2cf name: Windows ipAddress: 10.0.4.15 type: DEVICE - id: ad0a218d-7512-435c-9b58-614470ee8658 name: WORK-PC ipAddress: 192.168.126.1 type: DEVICE filterCriteria: id: 70 matchType: ANY rules: - id: 223 key: Name operator: Contains value: SJ resourceType: DEVICE - id: 224 key: Name operator: Regex value: .*VM.* resourceType: LOAD_BALANCER - id: 225 key: Agent Installed operator: Is value: 'TRUE' resourceType: DEVICE parameters: - schema: type: string name: clientId in: path required: true '/api/v2/tenants/{clientId}/sites/{siteId}': summary: Manage Site description: 'Updates and gets site details, and deletes a site.' delete: description: Deletes a site. tags: - resource-management responses: '200': description: OK get: description: Gets site details. tags: - resource-management responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/site' examples: example-site-details: value: id: 1139 name: TestSite clientId: 4 mspId: 3 description: '' address: '' city: '' state: '' country: United States zip: '' devices: - uniqueId: 1875653f-c5b7-40dd-998e-54b6fb25b422 hostName: '' ipAddress: '' type: DEVICE aliasName: '' resourceName: DOT-D1-SCCM-01_Old TEST resourceType: Windows - uniqueId: 31321789-ef92-41cd-bc96-01cc7bd38e1e hostName: '' ipAddress: '' type: DEVICE aliasName: '' resourceName: DOT-TEST-NET resourceType: Server resources: - id: 1875653f-c5b7-40dd-998e-54b6fb25b422 name: DOT-D1-SCCM-01_Old TEST ipAddress: '' type: Windows metaData: {} resourceType: Windows hostName: '' resourceName: DOT-D1-SCCM-01_Old TEST aliasName: '' - id: 31321789-ef92-41cd-bc96-01cc7bd38e1e name: DOT-TEST-NET ipAddress: '' type: Server metaData: {} resourceType: Server hostName: '' resourceName: DOT-TEST-NET aliasName: '' filterCriteria: id: 1320 uid: POLICY-c8e77000-9401-406b-8a1a-914cc00283c5 name: policy matchType: ALL rules: - id: 215 key: Name operator: Contains value: test resourceType: DEVICE post: description: Updates site details. tags: - resource-management requestBody: content: application/json: schema: $ref: '#/components/schemas/site' examples: example-site-update: value: name: SJ-North-East description: Datacenter at SJ East address: '4th Cross, Blue Valley' state: California city: San Jose country: USA zip: '94088' primaryContact: id: USR0000000014 loginName: InsLab@myorganization.com phoneNumber: '5232324543' phoneExtension: '1' resources: - id: ad0a218d-7512-435c-9b58-614470ee8658 - id: b7001583-db6a-4c7c-b4df-ab1ba6505d60 filterCriteria: matchType: ANY rules: - key: Name operator: Contains value: HYD resourceType: DEVICE - key: Name operator: Regex value: VM resourceType: LOAD_BALANCER - key: Agent Installed operator: Is value: 'TRUE' resourceType: DEVICE responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/site' examples: example-site-update: value: id: 31 name: SJ-North-East parent: id: 4 name: OPSRAMP-BMVR description: Resource in East address: Bheemavaram description: Datacenter at SJ East address: '4th Cross, Blue Valley' city: San Jose state: California country: USA zip: '94088' phoneNumber: '5232324543' phoneExtension: '1' primaryContact: id: USR0000000014 loginName: InsLab@myorganization.com lastName: Lab firstName: Ins email: inslab@gamil.com phoneNumber: '8096250653' resources: - id: b7001583-db6a-4c7c-b4df-ab1ba6505d60 name: DESKTOP-V5DV65M ipAddress: 192.168.56.1 type: DEVICE - id: 19a49e09-da18-4d91-92b7-01d6858ec2cf name: opsrampdev ipAddress: 10.0.4.15 type: DEVICE - id: ad0a218d-7512-435c-9b58-614470ee8658 name: WORK-PC ipAddress: 192.168.126.1 type: DEVICE filterCriteria: id: 70 matchType: ANY rules: - id: 223 key: Name operator: Contains value: HYD resourceType: DEVICE - id: 224 key: Name operator: Regex value: .*VM.* resourceType: LOAD_BALANCER - id: 225 key: Agent Installed operator: Is value: 'TRUE' resourceType: DEVICE parameters: - schema: type: string in: path name: siteId required: true description: Site uuid - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/sites/{siteId}/childs': summary: Manages resources for the Site description: Assign or Unassign resources for a Site. parameters: - schema: type: string name: siteId in: path required: true description: Location SiteId - $ref: '#/components/parameters/clientId' post: responses: '200': description: OK description: |- Assigns resources for a Site - Either Hostname(name) or uuid of resource is required in the payload tags: - resource-management requestBody: content: application/json: schema: $ref: '#/components/schemas/siteResources' examples: example-site-hierarchy: value: - uuid: c7ee6551-ddc2-41ae-97bd-85066f22be1e name: hostname-1 - uuid: c722b5fc-bb86-40e3-8993-d59fd584c360 name: hostname-2 delete: responses: '200': description: OK description: |- Unassigns resources for a Site - Either Hostname(name) or uuid of resource is required in the payload requestBody: content: application/json: schema: $ref: '#/components/schemas/siteResources' examples: example-remove-site-hierarchy: value: - uuid: c7ee6551-ddc2-41ae-97bd-85066f22be1e name: hostname-1 - uuid: c722b5fc-bb86-40e3-8993-d59fd584c360 name: hostname-2 tags: - resource-management '/api/v2/tenants/{tenantId}/sites/search': summary: Search Sites description: Searches sites. get: tags: - resource-management responses: '200': description: OK content: application/json: schema: type: object properties: results: type: array items: $ref: '#/components/schemas/site' totalResults: type: integer orderBy: type: string pageNo: type: integer pageSize: type: integer totalPages: type: integer nextPage: type: boolean previousPageNo: type: integer descendingOrder: type: boolean examples: example-site-search-details: value: results: - id: 31 name: SJ-EAST description: Resources in east zone address: '5th Avenue, Parkway' zip: '94088' phoneNumber: 406-232-1234 phoneExtension: '1' primaryContact: id: USR0000000014 loginName: InsLab@organization.com lastName: Lab firstName: Ins email: john.smith@gmail.com phoneNumber: 406-625-1234 - id: 11 name: SJ-North East description: Resources in North East zone address: '' primaryContact: id: USR0000000014 loginName: InsLab@organization.com lastName: Lab firstName: Ins email: john.smith@gmail.com phoneNumber: 408-625-1234 - id: 8 name: SJ-WEST description: Resources in West zone address: Vizag primaryContact: id: USR0000000014 loginName: InsLab@agency.com lastName: Lab firstName: Ins email: john.smith@gmail.com phoneNumber: 523-625-2345 - id: 6 name: SJ-South West description: Resources in south west zone address: WEST-ZONE - id: 5 name: SJ-NORTH description: Resources in North zone address: Blossom Valley phoneNumber: 406-746-2344 primaryContact: id: USR0000000014 loginName: InsLab@organization.com lastName: Lab firstName: Ins email: david.henry@gmail.com phoneNumber: 406-625-4567 - id: 4 name: SJ-SOUTH description: Resources in South zone address: Pink Valley primaryContact: id: USR0000000014 loginName: InsLab@company.com lastName: Lab firstName: Ins email: henry.williams@gmail.com phoneNumber: 809-625-2345 - id: 3 name: SJ-CENTRAL description: Primary site for the east zone address: Central Valley primaryContact: id: USR0000000014 loginName: sj.central@institution.com lastName: Smith firstName: John email: john.smith@gmail.com phoneNumber: 809-625-2233 - id: 2 name: SJ-MAIN description: High priority site address: Parkway primaryContact: id: USR0000000014 loginName: InsLab@institution.com lastName: Lab firstName: Main email: john.smith@gmail.com phoneNumber: 809-625-1234 totalResults: 9 orderBy: id pageNo: 1 pageSize: 10 totalPages: 1 nextPage: false previousPageNo: 0 descendingOrder: true parameters: - schema: type: integer default: 1 in: query name: pageNo description: '' - schema: type: integer default: 100 in: query name: pageSize description: '' - schema: type: boolean default: true in: query name: isDescendingOrder description: '' - schema: type: string default: id in: query name: sortName description: '' - schema: type: string in: query name: queryString parameters: - $ref: '#/components/parameters/tenantId' '/api/v2/tenants/{clientId}/sites/minimal': summary: Get Minimal Site Details description: Gets minimal details of sites. get: tags: - resource-management responses: '200': description: OK content: application/json: schema: type: array items: type: object properties: id: type: integer name: type: string description: type: string address: type: string examples: example-site-minimal-info: value: - id: 36 name: Brazil South description: 'Resources in south zone ' address: 'Street#1, Avenue Paradise' - id: 5 name: New Jersy description: Central Lab address: Trenton - id: 3 name: cn-north-1 description: North Lab address: Blossom Valley - id: 7 name: East South description: Resources in Kentucky - id: 38 name: Japan description: Resources in Japan address: 'Street#1, Tokyo' - id: 4 name: cn-north-2 description: Resources in San Jose address: 'Street#4, Parkway, San Jose' parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/deviceWarranties': summary: Get Warranties description: Gets the details of multiple device warranties. get: tags: - resource-management responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/warranty' examples: example-resource-warranties-search: value: - id: 1 purchaseDate: '2015-11-09T18:00:00+0000' warrantyExpireDate: '2020-12-09T18:00:00+0000' deviceId: DEV0000011576 - id: 2 purchaseDate: '2015-01-15T00:00:00+0000' warrantyExpireDate: '2015-01-20T00:00:00+0000' deviceId: f4a82c4a-8b65-4e7d-a57c-2e8a1aef14ff parameters: - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/services/{serviceId}/availability': summary: Get Service Availability description: Gets availability details of a service. get: tags: - resource-management parameters: - schema: type: string in: query name: startTime description: |- To view availability of a service within a given time frame, provide the start time and end time. startTime indicates the from date. Convert the time frame to Epoch timestamp. For example, if 12 Dec 2018 10:00 AM is the start time, then epoch timestamp is 1544608800. - schema: type: string in: query name: endTime description: 'endTime indicates the to dateFor example, if 17 Dec 2018 12:00 PM is the end time, then epoch timestamp is 1545048000.' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/availablility' examples: example-service-availability: value: totalDowntime: 152857 noOfPauseOccurences: 0 degradedTimeList: [] noOfDegradedOccurences: 0 pauseTimeList: [] totalPauseTime: 0 totalAvailability: 61.012133254094365 totalLogList: - key: 1c0d737b-7478-4e78-9b94-b2159e975a12 startTs: 1542805006 endTs: 1542957863 actStartTs: 1542805006 state: 0 rca: false schStartTs: 0 schEndTs: 0 downTimeList: - key: 1c0d737b-7478-4e78-9b94-b2159e975a12 startTs: 1542805006 endTs: 1542957863 actStartTs: 1542805006 state: 0 rca: false schStartTs: 0 schEndTs: 0 noOfOccurences: 1 downTimeKey: 1c0d737b-7478-4e78-9b94-b2159e975a12 totalDegradedTime: 0 currentState: down parameters: - schema: type: string in: path name: serviceId required: true description: Service group uuid - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{partnerId}/decommission/{action}': summary: Enable and Disable Client Resource Decommission description: Enables and disables resource decommission at partner level. post: tags: - resource-management requestBody: content: application/json: schema: type: object properties: allClients: type: string clients: type: string examples: example-clients-of-partner: value: allClients: 'TRUE' example-selected-clients: value: clients: '3,4,5' responses: '200': description: OK parameters: - schema: type: string in: path name: action required: true description: Enable or Disable Resource Decommission of client if that partner is enabled with Resource Decommission. - $ref: '#/components/parameters/partnerId' '/api/v2/tenants/{clientId}/resources/Resourcetype/{resourceType}/{identity}': x-internal: true summary: Delete Resource by Resource Type description: Deletes a resource based on resource type. delete: tags: - resource-management responses: '200': description: OK parameters: - schema: type: string in: path name: resourceType required: true description: Resource type - schema: type: string in: path name: identity required: true - $ref: '#/components/parameters/clientId' '/api/v2/tenants/{clientId}/resourceType/minimal': summary: Get Minimal Resource Type Details description: Gets minimal resource type details. get: tags: - resource-management responses: '200': description: OK content: application/json: schema: type: array items: type: object properties: id: type: integer name: type: string path: type: string examples: example-resource-minimal: value: - id: 213 name: CLOUD_PROVIDER path: Cloud Provider - id: 1 name: Work Station path: Desktop >> Work Station - id: 59 name: Android path: Mobile >> Android - id: 406 name: OOB_INTERFACE path: OOB Interface - id: 100 name: Other path: Other - id: 3 name: Server path: Server - id: 110 name: AIX path: 'Server >> AIX ' - id: 12 name: Linux path: Server >> Linux - id: 11 name: Windows path: Server >> Windows - id: 37 name: OpsRamp Gateway path: OpsRamp Gateway - id: 227 name: EBS path: Volume parameters: - $ref: '#/components/parameters/clientId' /api/v2/cfg/synthetics/checkpoints: summary: Get Public Locations for Synthetics description: Gets public locations for the synthetics. get: tags: - resource-management parameters: - schema: type: string in: query name: zone description: Zone. - schema: type: string in: query name: locationName description: Location name. responses: '200': description: OK content: application/json: schema: type: object description: '' properties: id: type: integer description: Checkpoint id readOnly: true name: type: string description: Checkpoint name readOnly: true uuid: type: string description: checkpoint uuid visibility: type: string description: Checkpoint visibility (public or private location) zone: type: string enum: - North America - HYDERABAD - On-premises description: Zone readOnly: true examples: example-1: value: results: - id: 14 name: TestPublic uuid: 423e2e3c-a300-4218-a69c-9e3d8c3c3c63 visibility: PUBLIC zone: North America - id: 15 name: TestPublic44 uuid: 423e2e3c-a300-4218-a69c-9e3d8c3c3c63 visibility: PUBLIC zone: North America '/api/v2/tenants/{clientId}/synthetics/checkpoints': summary: Get Private Locations for Synthetics description: Gets private locations for the synthetics. get: tags: - resource-management parameters: - schema: type: string in: query name: zone description: Zone. - schema: type: string in: query name: locationName description: Location name. responses: '200': description: OK content: application/json: schema: type: object description: '' properties: id: type: integer description: Checkpoint id name: type: string description: Checkpoint name uuid: type: string description: Checkpoint uuid visibility: type: string description: Checkpoint visibility (public or private location) zone: type: string enum: - North America - HYDERABAD - On-premises description: zone readOnly: true examples: example-1: value: results: - id: 13 name: TestPrivate uuid: 423e2e3c-ay00-6218-a69c-9e3d8c3c3c63 visibility: PRIVATE zone: North America - id: 14 name: TestPrivate1 uuid: 923e2e3c-a100-4268-a69c-9e3d8c3c3c63 visibility: PRIVATE zone: North America - id: 15 name: TestPrivate2 uuid: 8823e2e3c-h700-0218-a69c-9e3d8c3c3c63 visibility: PRIVATE zone: North America parameters: - $ref: '#/components/parameters/clientId' components: securitySchemes: accessToken: type: oauth2 flows: clientCredentials: tokenUrl: 'https://subdomain.api.opsramp.com' scopes: {} parameters: tenantId: in: path name: tenantId schema: type: string required: true description: Describes the clientId or partnerId of the tenant clientId: name: clientId in: path required: true schema: type: string description: Describes the clientId of the tenant resourceId: name: resourceId in: path required: true schema: type: string description: Resource uuid of the managed resource partnerId: name: partnerId in: path required: true schema: type: string description: Describes the mspId of the partner attributeId: name: attributeId in: path required: true schema: type: string description: Custom attribute uuid resourceGroupId: name: resourceGroupId in: path required: true schema: type: string description: Resource group uuid queryString: name: queryString in: query required: false schema: type: string description: Prepared query string consists of query parameters. schemas: discoveredService: title: discoveredService type: object description: '' properties: id: type: string name: type: string mode: type: string enum: - Manual - Disabled - Auto example: Auto default: Auto logonAs: type: string state: type: string enum: - Running - Stopped - Paused - Start Pending - Stop Pending - Continue Pending monitored: type: boolean serviceStatus: type: string taggable: title: taggable type: object properties: id: type: string name: type: string entityType: type: string resourceName: type: string hostName: type: string resourceType: type: string customAttributeValue: title: customAttributeValue type: object properties: id: type: integer customAttribute: type: object description: The custom attribute object properties: id: type: integer name: type: string description: type: string organization: $ref: '#/components/schemas/organization' value: type: string description: | Values of the custom attributes values. description: type: string customAttribute: title: customAttribute type: object properties: id: type: integer customAttributeValue: $ref: '#/components/schemas/customAttributeValue' taggable: $ref: '#/components/schemas/taggable' tagSource: type: string response: title: response type: object properties: failedEntities: type: object failedCount: type: integer successCount: type: integer organization: title: organization type: object description: The tenant to which custom attribute is associated properties: id: type: integer description: Tenant Id uniqueId: type: string description: Tenant unique Id name: type: string description: Tenant name activated: type: boolean description: Is tenant active customAttributeTypes: title: customAttributeTypes type: object description: Custom Attribute type properties: id: type: integer description: Custom attribute Id name: type: string description: Custon attribute bame description: type: string customAttributeValues: type: array description: Values of Custom Attribute items: $ref: '#/components/schemas/customAttributeValue' organization: $ref: '#/components/schemas/organization' resource: title: resource type: object description: OpsRamp basic resource object properties: id: type: string description: Resource uuid name: type: string description: Resource Name createdDate: type: string description: Resource created date updatedDate: type: string description: Last updated date Resourc entityType: type: string resourceType: type: string resourceName: type: string hostName: type: string aliasName: type: string deviceGroup: title: deviceGroup type: object properties: id: type: string name: type: string description: | Unique name for the device group. The device group is identified with this name. entityType: type: string description: | Type of resources in a group. Example: DEVICE_GROUP, SNS kbArticlesIds: type: array description: Knowledge base articleId to be attached to resouce groupId. items: type: integer filterCriteria: $ref: '#/components/schemas/policy' createdDate: type: string format: date-time updatedDate: type: string format: date-time parent: type: object description: Add a device group as child under an existing device group (parent). This field is mandatory while adding a child device group to parent device group. properties: id: type: string policy: title: deviceManagementPolicy type: object properties: matchType: type: string description: |- (Optional) The type of match: -To match all the filter conditions, provide matchType: ALL. - To match any one of the filter conditions, provide matchType: ANY. enum: - ALL - ANY rules: type: array description: |- (Optional) Filter devices with specific attributes: - Attribute name of device. Example: Name, Operating System. Attribute names change with device types. - Matching parameter. Supported operators are: Equals, Contains, Not Contains, Starts with, Ends with, Regex. Learn more about Regex. - Type of resource items: $ref: '#/components/schemas/rule' actions: type: array description: |- - Supported actions - ASSIGN MONITORINGTEMPLATE - ASSIGN KNOWLEDGEARTICLE - Assign Availability Rule - ASSIGN CUSTOMATTRIBUTES - Assign Jobs - ASSIGN CREDENTIALSET - Supported values for items for given action - For Assign Availability Rule , item value is AND - For ASSIGN CUSTOMATTRIBUTES, item value is tagName[value='tagValue'] - For all others this is number in string eg "12345" - Scenarios for Custom attributes item values in response payload - New TagName : New Tag created with given Name and Tag Value, and Assigned. - Id of New Tag Value added to response - Old TagName and New Tag Value : New Tag Value added to Tag and Assigned - Id of New Tag Value added to response. - Old TagName and Old TagValue : Both the details are verfied and Assigned - Id of TagValue added to Response items: $ref: '#/components/schemas/action' id: type: integer name: type: string description: | Name of the policy. resourceType: type: string description: |- Type of resource. Example: DEVICE, VOLUME, VPN, XENSERVER executionOrder: type: integer rule: title: rule type: object properties: key: type: string operator: type: string value: type: string id: type: integer resourceType: type: string filterType: type: string isNativeAttribute: type: boolean action: title: action type: object description: |- Refers to the actions performed on the filtered resources. Select at least one of the following actions: - Assign Monitoring Templates - Assign Knowledge Base Articles - Assign Availability Rule - Assign Custom Attributes - Assign Jobs - Assign Credentials Examples: "ASSIGN MONITORINGTEMPLATE" and "ASSIGN KNOWLEDGEARTICLE" properties: action: type: string items: type: array items: type: object properties: item: type: string parameters: type: object description: Template configuration parameters. These would be mandatory attributes in case the template has been configured to have configuration parameters for the "ASSIGN MONITORINGTEMPLATE" action. instances: type: object forceAssignOrUnassign: type: boolean httpResponse: title: httpResponse type: object properties: status: type: integer entity: type: string metadata: type: object length: type: integer headers: type: object cookies: type: object links: type: array items: {} stringHeaders: type: object allowedMethods: type: array items: {} statusInfo: type: object properties: family: type: string statusCode: type: integer reasonPhrase: type: string actualEntity: type: string warranty: title: warranty type: object properties: id: type: integer warrantyExpireDate: type: string description: | Warranty expire date deviceId: type: string purchaseDate: type: string description: | Warranty purchase date required: - warrantyExpireDate - purchaseDate resourceNote: title: resourceNote type: object properties: subject: type: string description: | Subject of the resource note. description: type: string description: | Description of the resource note. expiryDateType: type: integer description: |- Type of expiry. Supported Values: Never Expire, Validity Period: - expiryDateType=1 to create resource note that would never expire. - expiryDateType=2 to create resource note with a validity period. Both startTime and endTime are mandatory to create a note with a validity period. minimum: 1 maximum: 3 startTime: type: string description: | Start time of resource note. expiryTime: type: string description: | Expiry time of resource note. id: type: integer createdTime: type: string updatedTime: type: string createdBy: $ref: '#/components/schemas/user' user: title: user type: object properties: id: type: string loginName: type: string lastName: type: string firstName: type: string email: type: string changePassword: type: boolean phoneNumber: type: string resourceFull: title: resourceFull type: object properties: agentInstalled: type: boolean aliasName: type: string appRoles: type: array items: type: object properties: name: type: string assetManagedTime: format: date-time type: string attributes: type: object properties: ami: type: string instanceId: type: string instanceState: type: string instanceType: type: string launchDate: type: string monitoringState: type: string network: type: array items: type: object properties: aliasIp: type: string ip: type: string mac: type: string owner: type: string privateDns: type: string privateIp: type: string provider: type: string publicIp: type: string zone: type: string bios: type: object properties: biosName: type: string biosVersion: type: string smBiosMajorVersion: type: string smBiosMinorVersion: type: string smBiosPresent: type: string smBiosVersion: type: string systemManufacturer: type: string systemModel: type: string systemSerial: type: string classCode: type: string client: type: object properties: id: type: integer name: type: string uniqueId: type: string clientId: type: integer clientUniqueId: type: string components: type: array items: type: string consoles: type: array items: {} cpus: type: array items: type: object properties: dataWidth: type: integer family: type: string l2CacheSize: type: integer manufacturer: type: string maxClockSpeed: type: integer numberOfCores: type: integer powerManagementSupported: type: boolean processor: type: string processorName: type: string processorVersion: type: string createdDate: format: date-time type: string deleted: type: boolean description: type: string devicePath: type: string deviceType: type: string dns: type: string extResourceId: type: string firstAssetManagedTime: format: date-time type: string gatewayProfileId: type: string generalInfo: type: object properties: agentDeploytime: format: date-time type: string aliasName: type: string assetManagedTime: type: string createdTime: format: date-time type: string description: type: string dns: type: string encodingType: type: string firstAssetManagedTime: type: string hostName: type: string keyboardType: type: string make: type: string osArchitecture: type: string name: type: string osName: type: string physicalMemory: type: string resourceName: type: string resourceType: type: string updatedTime: format: date-time type: string dnsName: type: string description: dnsName is duplicate of dns. Both represents same property.This has been introduced for naming consistenc for search parameters. history: type: object properties: decommissionReason: type: string id: type: string hostName: type: string installedApp: type: object properties: displayName: type: string id: type: string integration: type: object properties: id: type: string name: type: string ipAddress: type: string location: type: object properties: city: type: string clientId: type: integer id: type: integer mspId: type: integer name: type: string locationOffset: type: integer logicalDisks: type: array items: type: object properties: description: type: string fileSystem: type: string free: type: integer freeDiskCriticalThreshold: type: integer freeDiskWarningThreshold: type: integer monitor: type: boolean name: type: string total: type: integer utilizationCriticalThreshold: type: integer utilizationWarningThreshold: type: integer macAddress: type: string make: type: string managementProfile: type: object properties: id: type: integer name: type: string type: type: string metricTypes: type: array items: type: object properties: availabilityMetric: type: boolean displayName: type: string metricName: type: string thresholdType: type: string unit: type: string model: type: string name: type: string networkCards: type: array items: type: object properties: dhcpEnabled: type: boolean id: type: integer ipAddress: type: string linkMode: type: string macAddress: type: string networkName: type: string osArchitecture: type: string osName: type: string physicalDisks: type: array items: type: object properties: interfaceType: type: string manufacturer: type: string mediaType: type: string model: type: string name: type: string partitions: type: integer properties: type: object properties: ami: type: string instanceId: type: string instanceState: type: string instanceType: type: string launchDate: type: string monitoringState: type: string owner: type: string privateDns: type: string privateIp: type: string provider: type: string publicIp: type: string zone: type: string resourceName: type: string serialNumber: type: string resourceType: type: string source: type: string state: type: string status: type: string systemUID: type: string tags: type: array items: type: object properties: name: type: string value: type: string totalLocations: type: integer ts: type: integer type: type: string updatedDate: format: date-time type: string videoCards: type: array items: type: object properties: bitsPerPixel: type: string name: type: string ram: type: string resolution: type: string version: type: string wsusSettings: type: string identity: type: string serviceGroup: title: serviceGroup type: object properties: id: type: string name: type: string description: | Unique name for the service group. The service group is identified with this name. createdDate: type: string format: date-time updatedDate: type: string format: date-time childType: type: string description: |- Child service group type. Example: DEVICE, SERVICEGROUP, SNS, SQS frequency: type: integer description: | (Optional) thresholdType: type: string description: |- (Optional) Define the availability status for a service group with below threshold types: - count: Define availability of a service group based on the number of resources in the group. For example, if 10 resources are down. - percentage: Percentage of resources or services that should be considered to determine the availability. Below are the supported availability statuses: - Down: If resources or services down are greater than or equal to a specific value(count/percentage), then service is considered as Down. - Degraded: If resource or services down are less than a specific value(count/percentage), then service is considered as Degraded. - OK: If all resources or services are Up, then service is considered as OK. For example, a user wants to define availability status as Down if 5 resources are down, then the values are provided as: `"thresholdType": "count","thresholdLimit": 5`. thresholdLimit: type: integer description: | (Optional) Provide a specific threshold value to determine count or percentage. monitorNames: type: array items: type: string include: type: string type: type: string description: |- (Optional) - To generate an alert when the threshold limits are breached, provide type: alert. - To display the availability status without generating an alert, provide type: default. alertType: type: integer description: |- (Optional) Provide specific alertType value to set service availability monitor: - Service Availability Monitor will be set to Available, If alertType = 2. - Service Availability Monitor will be set to Any critical alert, If alertType = 0. - Service Availability Monitor will be set to Critical alert, If alertType = 1. alert: type: boolean description: | (Optional) Generate an alert when the threshold limits are breached. metrics: type: array items: {} filterCriteria: $ref: '#/components/schemas/policy' parent: type: object properties: id: type: string description: | Add a service group as a child under an existing service group (parent). This field is required for adding a service group to a parent service group. kbArticlesIds: type: array description: |- Assign knowledge base articles to a device group.Note: To fetch a knowledge base article ID: 1. Log into OpsRamp. 2. Click Knowledge Base. 3. Select the required article and then copy the article ID. 4. Provide the article ID in "kbArticleIds" field. Example: "kbArticleIds": [22089]. items: type: integer depth: type: number client: $ref: '#/components/schemas/clientProps' availablility: title: availablility type: object properties: totalAvailability: type: number totalDowntime: type: integer totalLogList: type: array items: type: object properties: key: type: string startTs: type: integer endTs: type: integer actStartTs: type: integer state: type: integer rca: type: boolean schStartTs: type: integer schEndTs: type: integer downTimeList: type: array items: type: object properties: key: type: string startTs: type: integer endTs: type: integer actStartTs: type: integer state: type: integer rca: type: boolean schStartTs: type: integer schEndTs: type: integer noOfOccurences: type: integer noOfPauseOccurences: type: integer degradedTimeList: type: array items: {} noOfDegradedOccurences: type: integer totalDegradedTime: type: integer currentState: type: string totalPauseTime: type: integer pauseTimeList: type: array items: {} site: title: site type: object properties: id: type: integer name: type: string description: | Site name. clientId: type: integer mspId: type: integer parent: type: object description: | (Optional) Parent site. Required if creating a sub-site under a parent site: properties: id: description: | Parent site id type: integer name: type: string description: | Parent site name description: type: string address: type: string description: type: string description: | (Optional) Summary of the site. address: type: string description: | (Optional) Site address. state: type: string description: | (Optional) Site state. city: type: string description: | (Optional) Site city. country: type: string zip: type: string description: | (Optional) Zip code. primaryContact: $ref: '#/components/schemas/user' phoneNumber: type: string description: | (Optional) Site phone number for communication. phoneExtension: type: string description: | (Optional) Site phone extension number. filterCriteria: $ref: '#/components/schemas/policy' devices: type: array items: type: object properties: uniqueId: type: string hostName: type: string ipAddress: type: string type: type: string aliasName: type: string resourceName: type: string resourceType: type: string resources: type: array items: type: object properties: id: type: string name: type: string ipAddress: type: string type: type: string metaData: type: object resourceType: type: string hostName: type: string resourceName: type: string aliasName: type: string device: title: device type: object properties: name: type: string ipAddress: type: string uuid: type: string AliasName: type: string HostName: type: string ResourceName: type: string siteResources: type: array description: '' minItems: 1 uniqueItems: true x-examples: example-1: - uuid: c7ee6551-ddc2-41ae-97bd-85066f22be1e name: location1 - uuid: c722b5fc-bb86-40e3-8993-d59fd584c360 name: location2 items: type: object properties: uuid: type: string minLength: 1 description: UUID of the resource name: type: string minLength: 1 description: Hostname of the resource auditRecordings: type: object title: remoteConsoles properties: results: type: array uniqueItems: true minItems: 1 items: type: object properties: id: type: string minLength: 1 resourceId: type: string minLength: 1 userId: type: string minLength: 1 gatewayId: type: string minLength: 1 ticketId: type: string minLength: 1 startTime: type: string minLength: 1 endTime: type: string minLength: 1 consoleProtocol: type: string minLength: 1 url: type: string minLength: 1 notes: type: string minLength: 1 playbackCodec: type: string minLength: 1 recStatus: type: string minLength: 1 'hostName ': type: string description: resource Host Name IpAddress: type: string description: resource Ip Address gatewayIp: type: string description: Gateway IP to which management profile is attached loginName: type: string description: user loname totalResults: type: number orderBy: type: string minLength: 1 pageNo: type: number pageSize: type: number totalPages: type: number nextPage: type: boolean nextPageNo: type: number previousPageNo: type: number descendingOrder: type: boolean listRemoteConsoles: description: '' type: object title: remoteConsoles properties: results: type: array uniqueItems: true minItems: 1 items: type: object properties: consoleConnector: type: string minLength: 1 consoleAuthType: type: string minLength: 1 consoleProtocol: type: string minLength: 1 name: type: string minLength: 1 totalResults: type: number pageNo: type: number pageSize: type: number totalPages: type: number nextPage: type: boolean nextPageNo: type: number previousPageNo: type: number descendingOrder: type: boolean required: - totalResults - pageNo - pageSize - totalPages - nextPage - nextPageNo - previousPageNo - descendingOrder remoteConsole: type: array description: '' minItems: 1 uniqueItems: true title: remoteConsole items: type: object properties: consoleConnector: type: string minLength: 1 consoleAuthType: type: string minLength: 1 consoleProtocol: type: string minLength: 1 ipAddress: type: string minLength: 1 port: type: string minLength: 1 userName: type: string minLength: 1 name: type: string minLength: 1 syntheticResource: type: object description: '' x-examples: example-1: value: checkType: HTTP locationUuids: - string name: string extResourceId: string hostName: string resourceType: string metaData: {} resourceName: string url: string sslCertKeyPath: string uploadStream: string downloadFilePath: string credential: userName: string password: string securityLevel: basic oauthClientKey: string oauthClientSecret: string oauthAccessTokenUrl: string oauthGrantType: string sslCertPath: string script: string credentials: - credentialType: HTTP_PROXY password: string securityLevel: basic userName: string additionalProperties: false properties: checkType: type: string minLength: 1 enum: - HTTP - HTTPS - DNS - IMAP - PING - RTT - POP3 - SCRIPT - SMTP - SSL - TCP - UDP - FTP - SIP locationUuids: type: array items: type: string name: type: string minLength: 1 extResourceId: type: string minLength: 1 hostName: type: string minLength: 1 resourceType: type: string minLength: 1 metaData: type: object resourceName: type: string minLength: 1 url: type: string minLength: 1 sslCertKeyPath: type: string minLength: 1 uploadStream: type: string minLength: 1 downloadFilePath: type: string minLength: 1 credential: type: object properties: userName: type: string minLength: 1 password: type: string minLength: 1 securityLevel: type: string minLength: 1 enum: - basic - ntlm - oauth2 oauthClientKey: type: string minLength: 1 oauthClientSecret: type: string minLength: 1 oauthAccessTokenUrl: type: string minLength: 1 oauthGrantType: type: string minLength: 1 sslCertPath: type: string minLength: 1 script: type: string minLength: 1 credentials: type: array uniqueItems: true minItems: 1 items: type: object properties: credentialType: type: string minLength: 1 enum: - HTTP_PROXY - HTTP - FTP - POP3 - IMAP - RTT - SMTP password: type: string minLength: 1 securityLevel: type: string minLength: 1 enum: - basic - ntlm - oauth2 userName: type: string minLength: 1 required: - checkType - locationUuids - resourceType - resourceName - url genericResource: type: object description: '' additionalProperties: false properties: hostName: type: string minLength: 1 description: The resource hostname resourceName: type: string minLength: 1 description: The Resource Nam resourceType: type: string minLength: 1 description: Resources based on a resource type. Use Get Device Types API to get a list of supported resource types supported by OpsRamp extResourceId: type: string minLength: 1 dnsName: type: string minLength: 1 description: Resource Domain service name aliasName: type: string minLength: 1 description: Other name of resource os: type: string minLength: 1 serialNumber: type: string minLength: 1 make: type: string minLength: 1 model: type: string minLength: 1 managementProfile: type: string minLength: 1 description: Agent/Gateway profile ID systemUID: type: string providerUID: type: string providerType: type: string enum: - GOOGLE - VMWARE - AZURE - AWS - null description: 'Resource provider i..e ( Resource discovered from eg GOOGLE,VMWARE,AZURE,AWS )' resourceNetworkInterface: type: array description: Network interfaces of the resource items: $ref: '#/components/schemas/resourceInterface' description: type: string oobInterfaceCards: type: array description: OOB interface details items: $ref: '#/components/schemas/oobInterface' required: - resourceName - resourceType resourceInterface: description: '' type: object x-examples: example-1: ipAddressType: STATIC macAddress: '00:0C:29:B8:C8:8F' default: 0 ipAddress: 172.22.221.90 properties: ipAddressType: type: string minLength: 1 enum: - STATIC - DHCP macAddress: type: string minLength: 1 default: type: number ipAddress: type: string minLength: 1 format: ipv4 OpsManagedResource: oneOf: - $ref: '#/components/schemas/genericResource' - $ref: '#/components/schemas/syntheticResource' description: '' x-examples: example-1: value: id: string name: string createdDate: string updatedDate: string entityType: string resourceType: string resourceName: string hostName: string aliasName: string managedResource: description: '' type: object properties: id: type: string minLength: 1 format: uuid readOnly: true hostName: type: string ipAddress: type: string minLength: 1 identity: type: string minLength: 1 createdDate: type: string minLength: 1 updatedDate: type: string minLength: 1 type: type: string minLength: 1 nativeType: type: string minLength: 1 description: |- vendor defined native Type of resource. Example: AWS EventBridge Event bus, Azure IoT Central state: type: string minLength: 1 source: type: string minLength: 1 status: type: string minLength: 1 aliasName: type: string tags: type: array uniqueItems: true minItems: 1 items: type: object properties: name: type: string minLength: 1 value: type: string minLength: 1 tagSource: type: string minLength: 1 name: type: string minLength: 1 resourceName: type: string minLength: 1 consoles: type: array items: type: object properties: $ref: '#/components/schemas/props' clientUniqueId: type: string minLength: 1 resourceType: type: string minLength: 1 frequency: type: number paused: type: boolean deleted: type: boolean validateSSL: type: boolean port: type: number encrypted: type: boolean timeout: type: number ts: type: number clientId: type: number locationOffset: type: number totalLocations: type: number receiverHostPort: type: number topologyEnabled: type: boolean device: type: boolean excludeIndexing: type: boolean cloudInstance: type: boolean saId: type: number checkType: type: string enum: - HTTP - HTTPS - DNS - IMAP - PING - RTT - POP3 - SCRIPT - SMTP - SSL - TCP - UDP - FTP readOnly: true host: type: string locationUuids: type: array items: type: string credential: $ref: '#/components/schemas/syntheticCredential' credentials: $ref: '#/components/schemas/syntheticCredentailsSet' managementProfile: $ref: '#/components/schemas/mgmtProfile' components: type: array items: type: string bios: $ref: '#/components/schemas/bios' cpus: type: array items: $ref: '#/components/schemas/cpu' generalInfo: $ref: '#/components/schemas/genericResourceInfo' installedApp: $ref: '#/components/schemas/monitoringApp' metricTypes: type: array items: $ref: '#/components/schemas/metricType' networkCardDetails: type: array items: $ref: '#/components/schemas/networkCardDetail' discoveryProfile: $ref: '#/components/schemas/disovery' location: $ref: '#/components/schemas/location' appRoles: type: array items: type: object properties: name: type: string agentInstalled: type: boolean default: false description: Agent installed resource or not. agentStatus: type: string enum: - OFFLINE - ONLINE example: OFFLINE description: Agent live status. agentLastConnectedTime: type: string description: Agent's last connected timestamp based on the resource site timezone. required: - id syntheticCredential: description: '' type: object properties: userName: type: string minLength: 1 password: type: string minLength: 1 securityLevel: type: string minLength: 1 oauthClientKey: type: string minLength: 1 oauthClientSecret: type: string minLength: 1 oauthAccessTokenUrl: type: string minLength: 1 oauthGrantType: type: string minLength: 1 syntheticCredentailsSet: type: array description: '' minItems: 1 uniqueItems: true x-examples: example-1: - credentialType: HTTP_PROXY password: string securityLevel: basic userName: string items: type: object properties: credentialType: type: string minLength: 1 password: type: string minLength: 1 securityLevel: type: string minLength: 1 userName: type: string minLength: 1 metricType: type: object description: '' x-examples: example-1: id: 0 metricName: resource.availability displayName: Availability unit: COUNTER availabilityMetric: false thresholdType: STATIC factor: 0 displayByComponent: false displayOrder: 0 topMetric: false timeSeries: true tenantId: 0 version: 0 properties: id: type: number metricName: type: string minLength: 1 displayName: type: string minLength: 1 unit: type: string minLength: 1 availabilityMetric: type: boolean thresholdType: type: string minLength: 1 factor: type: number displayByComponent: type: boolean displayOrder: type: number topMetric: type: boolean timeSeries: type: boolean tenantId: type: number version: type: number readOnly: true networkCardDetail: description: '' type: object x-examples: example-1: id: 270873 networkName: vmnic0 status: DOWN ifName: '' ifAlias: '' ifDescription: '' ifType: OTHER ifTxType: IFTXTYPE_AUTO ipAddress: '' macAddress: '00:0C:29:0A:16:43' dhcpEnabled: false speed: 0 Bps linkMode: MGNT_MODE_LINK confLinkSpeed: 0 Bps adminStatus: DOWN operationalStatus: DOWN properties: id: type: number networkName: type: string minLength: 1 status: type: string minLength: 1 ifName: type: string ifAlias: type: string ifDescription: type: string ifType: type: string minLength: 1 ifTxType: type: string minLength: 1 ipAddress: type: string macAddress: type: string minLength: 1 dhcpEnabled: type: boolean speed: type: string minLength: 1 linkMode: type: string minLength: 1 confLinkSpeed: type: string minLength: 1 adminStatus: type: string minLength: 1 operationalStatus: type: string minLength: 1 monitoringApp: description: '' type: object x-examples: example-1: id: INTG-fe6ff403-53ef-41d9-99c4-f4df54d37e50 displayName: vcenter integration: id: VMWARE name: VMware multipleInstallations: true installedBy: vasu_admin installedTime: '2020-01-29T10:20:47+0000' status: enabled properties: id: type: string minLength: 1 displayName: type: string minLength: 1 integration: type: object properties: id: type: string minLength: 1 name: type: string minLength: 1 multipleInstallations: type: boolean installedBy: type: string minLength: 1 installedTime: type: string minLength: 1 status: type: string minLength: 1 genericResourceInfo: description: '' type: object x-examples: example-1: name: 172.26.105.12 osName: VMware ESXi 6.0.0 build-3620759 osVersion: '' make: 'VMware, Inc.' hostName: '' dns: '' resourceType: VMWAREHOST resourcePath: VMWareHost domainRole: '' macAddress: '' keyboardType: US104 encodingType: UTF8 physicalMemory: '8191.0' managementGatewayProfileName: TestPro resourceName: 172.26.105.12 aliasName: '' createdTime: '2020-01-29T10:21:49+0000' updatedTime: '2020-01-29T10:21:44+0000' assetManagedTime: '2020-01-29T10:21:49+0000' firstAssetManagedTime: '2020-01-29T10:21:49+0000' properties: name: type: string minLength: 1 osName: type: string minLength: 1 osVersion: type: string make: type: string minLength: 1 hostName: type: string dns: type: string resourceType: type: string minLength: 1 resourcePath: type: string minLength: 1 domainRole: type: string macAddress: type: string keyboardType: type: string minLength: 1 encodingType: type: string minLength: 1 physicalMemory: type: string minLength: 1 managementGatewayProfileName: type: string minLength: 1 resourceName: type: string aliasName: type: string createdTime: type: string minLength: 1 updatedTime: type: string minLength: 1 assetManagedTime: type: string minLength: 1 firstAssetManagedTime: type: string minLength: 1 cpu: description: '' type: object properties: processor: type: string minLength: 1 processorName: type: string minLength: 1 manufacturer: type: string minLength: 1 powerManagementSupported: type: boolean l2CacheSize: type: number maxClockSpeed: type: number dataWidth: type: number numberOfCores: type: number mgmtProfile: description: '' type: object x-examples: example-1: id: 5923 name: TestPro description: '' type: Gateway properties: id: type: number name: type: string minLength: 1 description: type: string type: type: string minLength: 1 required: - id bios: description: '' type: object properties: biosVersion: type: string minLength: 1 systemSerial: type: string minLength: 1 systemModel: type: string minLength: 1 systemManufacturer: type: string minLength: 1 disovery: description: '' type: object x-examples: example-1: id: 2933 name: vcenterpro scanNow: false properties: id: type: number name: type: string minLength: 1 scanNow: type: boolean props: description: '' type: object properties: provider: type: string minLength: 1 uniqueId: type: string physical_location_name: type: string vMotion: type: boolean ftmMode: type: boolean perfLevelInfo: type: string minLength: 1 licenceData: type: object properties: licenseExpiry: type: string minLength: 1 licenseName: type: string minLength: 1 licenseVersion: type: string minLength: 1 zone: type: string policy: type: string arn: type: string vpcId: type: string location: description: '' type: object properties: id: type: number name: type: string minLength: 1 clientId: type: number mspId: type: number city: type: string minLength: 1 caUpdateModel: title: caUpdateModel type: object properties: entities: type: array items: type: object properties: id: type: string entityType: type: string enum: - RESOURCE - NON_MON_RESOURCES example: RESOURCE required: - id - entityType ca: type: object required: - currentValues - updatedValues properties: currentValues: type: object required: - attributeId - valueId properties: attributeId: type: string valueId: type: string updatedValues: type: object required: - attributeId - valueId properties: attributeId: type: string valueId: type: string required: - ca oobInterface: description: '' type: object x-examples: example-1: resourceName: string macAddress: string url: string oobVersion: string description: string accessInfo: string accessInfoIpV4: string remoteAccessType: string port: 0 make: string model: string properties: name: type: string minLength: 1 macAddress: type: string minLength: 1 url: type: string minLength: 1 oobVersion: type: string minLength: 1 description: type: string minLength: 1 accessInfo: type: string minLength: 1 accessInfoIpV4: type: string minLength: 1 remoteAccessType: type: string minLength: 1 port: type: number make: type: string minLength: 1 model: type: string minLength: 1 required: - name - macAddress - url - oobVersion - description - accessInfo - accessInfoIpV4 - remoteAccessType - port - make - model clientProps: type: object properties: id: type: integer uniqueId: type: string name: type: string activated: type: boolean offlineAlertstoThirdPartyTool: type: boolean uuid: type: string addOns: type: array items: type: string packages: type: array items: type: string featureFlags: type: object properties: {} webConsoles: type: boolean responses: {}