{"info":{"_postman_id":"17668e0a-703c-44a3-bcf3-d944d4b28e1b","name":"IBM Performance Management API","description":"My personal Postman collection for interacting with IBM Performance Application Management API (IPM8). Before using this collection, one must define a new environment containing the following variables:\n\n- **baseUrl**: The base API Endpoint for connection, as shown in the example below:\n\n*Ex for IPM8 SaaS: https://\\<SUBSCRIPTION_ID\\>.customers.\\<REGION\\>.apm.ibmserviceengage.com/1.0*\n\n*Ex for IPM8 On-Prem: https://\\<SUBSCRIPTION_IP\\>:\\<PORT\\>/1.0*\n\n- **username**: Username for connecting to the target IPM8 subscription.\n- **password**: Password for connecting to the target IPM8 subscription.\n\n\nListed below are some important information regarding supported filters:\n\n### _filter:\n\nmay be repeated one or more times to add additional property filters on the returned items. Takes the form, 'properyName[operator]value'.  If the property name contains an operator character, the property name must be enclosed in quotes. Filter operator are\n\n- '=' equals\n- '!=' not equals\n- '>' greater than (numeric properties only)\n- '<' less than (numeric properties only) \n- '>=' greater than or equal to (numeric properties only) \n- '<=' less than or equal to (numeric properties only)\n- ':' in\n\n### _field\n\nIndicates that the specified field should be added to the collection members in the response. May be repeated one or more times to add additional properties. For example, specifying _field=keyIndexName will cause the keyIndexName property (if it has a value) to be included in each object in the response.\n\n### _offset\nThe offset within the result set to begin returning data\n\n### _limit\nthe maximum number of elements to return\n\n\n## Contact \n\nFor issues and suggestions contact me at: https://fsilveir.github.io","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"topology/mgmt_artifacts","item":[{"name":"all agents","id":"f8cf6d56-c7a8-45e6-9fcd-07b26c13f445","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{baseUrl}}/topology/mgmt_artifacts?_filter=entityTypes=Agent&_field=hostname&_field=keyIndexName&_field=parentNode&_field=OSPlatformDescription&_field=description&_field=online&_field=version&_field=monitoringDomain&_field=productCode&_field=_observedAt","host":["{{baseUrl}}"],"path":["topology","mgmt_artifacts"],"query":[{"key":"_filter","value":"entityTypes=Agent"},{"key":"_field","value":"hostname"},{"key":"_field","value":"keyIndexName"},{"key":"_field","value":"parentNode"},{"key":"_field","value":"OSPlatformDescription"},{"key":"_field","value":"description"},{"key":"_field","value":"online"},{"key":"_field","value":"version"},{"key":"_field","value":"monitoringDomain"},{"key":"_field","value":"productCode"},{"key":"_field","value":"_observedAt"}]},"description":"Returns a list of all monitoring agents."},"response":[],"_postman_id":"f8cf6d56-c7a8-45e6-9fcd-07b26c13f445"},{"name":"all agent by resource group _id","id":"51bbc329-40dc-4316-adc1-adcd52185726","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"fsilveir@br.ibm.com","password":"98yghjklkmnhu","showPassword":false}},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/topology/mgmt_artifacts/:_id/references/to/contains?_field=hostname&_field=keyIndexName&_field=parentNode&_field=OSPlatformDescription&_field=description&_field=online&_field=version&_field=monitoringDomain&_field=productCode&_field=_observedAt","host":["{{baseUrl}}"],"path":["topology","mgmt_artifacts",":_id","references","to","contains"],"query":[{"key":"_field","value":"hostname"},{"key":"_field","value":"keyIndexName"},{"key":"_field","value":"parentNode"},{"key":"_field","value":"OSPlatformDescription"},{"key":"_field","value":"description"},{"key":"_field","value":"online"},{"key":"_field","value":"version"},{"key":"_field","value":"monitoringDomain"},{"key":"_field","value":"productCode"},{"key":"_field","value":"_observedAt"}],"variable":[{"key":"_id","value":"b5_foUdy8SM28FGJMikaqg","type":"string","description":"The id of the agent to retrieve"}]},"description":"Returns a list of all agents distributed to a resource group."},"response":[],"_postman_id":"51bbc329-40dc-4316-adc1-adcd52185726"},{"name":"all resource groups","id":"88f55473-dd7d-4ca1-8cd5-aa04883eeacd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"fsilveir@br.ibm.com","password":"98yghjklkmnhu","showPassword":false}},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/topology/mgmt_artifacts?_filter=entityTypes=AgentGroup&_field=keyIndexName&_field=displayLabel&_field=_alarmServiceKey","host":["{{baseUrl}}"],"path":["topology","mgmt_artifacts"],"query":[{"key":"_filter","value":"entityTypes=AgentGroup"},{"key":"_field","value":"keyIndexName"},{"key":"_field","value":"displayLabel"},{"key":"_field","value":"_alarmServiceKey"}]},"description":"Returns a list of all Resource Groups created by users."},"response":[],"_postman_id":"88f55473-dd7d-4ca1-8cd5-aa04883eeacd"},{"name":"resource group by ID","id":"284ecdd1-6130-4ed1-82a9-6f18d6c90e0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"fsilveir@br.ibm.com","password":"98yghjklkmnhu","showPassword":false}},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/topology/mgmt_artifacts/:id","host":["{{baseUrl}}"],"path":["topology","mgmt_artifacts",":id"],"variable":[{"key":"id","value":"","type":"string","description":"The id of the group to delete"}]},"description":"Delete a Resource Group by its ID."},"response":[],"_postman_id":"284ecdd1-6130-4ed1-82a9-6f18d6c90e0d"},{"name":"all system resource groups","id":"6b711602-6943-4ddb-868c-33357422fd95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"fsilveir@br.ibm.com","password":"98yghjklkmnhu","showPassword":false}},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/topology/mgmt_artifacts?_filter=entityTypes=AgentSystemGroup&_field=keyIndexName&_field=displayLabel&_field=_alarmServiceKey","host":["{{baseUrl}}"],"path":["topology","mgmt_artifacts"],"query":[{"key":"_filter","value":"entityTypes=AgentSystemGroup"},{"key":"_field","value":"keyIndexName"},{"key":"_field","value":"displayLabel"},{"key":"_field","value":"_alarmServiceKey"}]},"description":"Returns a list of all system resource groups."},"response":[],"_postman_id":"6b711602-6943-4ddb-868c-33357422fd95"}],"id":"392d8699-d2d8-4a4e-9a23-8679bde68818","_postman_id":"392d8699-d2d8-4a4e-9a23-8679bde68818"},{"name":"thresholdmgmt","item":[{"name":"all thresholds","id":"0f39ae60-3d23-426d-8175-e8bf5b34588a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/thresholdmgmt/threshold_types/itm_private_situation/thresholds?_offset=0&_limit=99999","host":["{{baseUrl}}"],"path":["thresholdmgmt","threshold_types","itm_private_situation","thresholds"],"query":[{"key":"_offset","value":"0"},{"key":"_limit","value":"99999"}]},"description":"Return the list of all monitoring thresholds."},"response":[],"_postman_id":"0f39ae60-3d23-426d-8175-e8bf5b34588a"},{"name":"all thresholds by type","id":"5221015a-b974-4d55-b314-05ebf05eb333","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/thresholdmgmt/threshold_types/itm_private_situation/thresholds?_offset=1&_limit=99999","host":["{{baseUrl}}"],"path":["thresholdmgmt","threshold_types","itm_private_situation","thresholds"],"query":[{"key":"_offset","value":"1"},{"key":"_limit","value":"99999"},{"description":"Filters all Linux OS thresholds","key":"_filter","value":"_uiThresholdType%3DLinux OS","disabled":true},{"description":"Filters all GSMA Linux OS thresholds","key":"_filter","value":"_uiThresholdType%3DGSMA+Linux+OS","disabled":true},{"description":"Filters all UNIX OS thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DUNIX OS","disabled":true},{"description":"Filters all Active Directory thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DActive Directory","disabled":true},{"description":"Filters all MS Exchange Server thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DMicrosoft Exchange Server","disabled":true},{"description":"Filters all Oracle DB Extended thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DOracle Database Extended","disabled":true},{"description":"Filters all Oracle DB Agent thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DGSMA Oracle DB Agent","disabled":true},{"description":"Filters all GSMA IBM Workload Scheduler (TWS) thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DGSMA IBM Workload Scheduler","disabled":true},{"description":"Filters all MS IIS thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DMicrosoft+IIS","disabled":true},{"description":"Filters all Cassandra DB thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DCassandra","disabled":true},{"description":"Filters all AIX OS thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DGSMA+AIX+OS","disabled":true},{"description":"Filters all Transaction Tracking thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DTransaction Tracking","disabled":true},{"description":"Filters all IBM Spectrum Project (TSM) thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DGSMA IBM Spectrum Protect","disabled":true},{"description":"Filters all DB2 thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DDB2","disabled":true},{"description":"Filters all MSSQL Server thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DMicrosoft SQL Server","disabled":true},{"description":"Filters all Windows OS thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DWindows OS","disabled":true},{"description":"Filters all Virtual Servers thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DVirtual Servers","disabled":true},{"description":"Filters all Bluemix Integration thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DBluemix Integration","disabled":true},{"description":"Filters all HTTP Server thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DHTTP Server","disabled":true},{"description":"Filters all HMC Base thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DHMC Base","disabled":true},{"description":"Filters all PostgreSQL thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DPostgreSQL","disabled":true},{"description":"Filters all MongoDB thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DMongoDB","disabled":true},{"description":"Filters all Ruby Application thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DRuby Application","disabled":true},{"description":"Filters all Synthetic Playback thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DSynthetic Playback","disabled":true},{"description":"Filters all Tomat thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DTomcat","disabled":true},{"description":"Filters all VMware VI thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DVMware VI","disabled":true},{"description":"Filters all Web Response Time thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DWeb Response Time","disabled":true},{"description":"Filters all WebSphere Application Server thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DWebSphere Application Server","disabled":true},{"description":"Filters all WebSphere MQ thresholds","key":"_filter","type":"text","value":"_uiThresholdType%3DWebSphere MQ","disabled":true}]},"description":"List thresholds by Agent Type using `_uiThresholdType` filter. Notice that the information should be encoded in order for the filter to work as shown in the param list."},"response":[],"_postman_id":"5221015a-b974-4d55-b314-05ebf05eb333"},{"name":"resource assignments","id":"097af250-e654-49a9-a04e-15466f044955","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/thresholdmgmt/resource_assignments","description":"List assignment relationships between Resource Groups and Thresholds."},"response":[],"_postman_id":"097af250-e654-49a9-a04e-15466f044955"},{"name":"resource assignment","id":"311edeb2-e5bc-4457-a904-4d7e0c3c3ad5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"fsilveir@br.ibm.com","password":"98yghjklkmnhu","showPassword":false}},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"resource\": {\n    \"_id\": \"PemayCuWA6V2LVzmF2N6SA\"\n  },\n  \"threshold\": {\n    \"_id\": \"1541\"\n  }\n}"},"url":"{{baseUrl}}//thresholdmgmt/resource_assignments","description":"To assign a threshold to a Resource Group in particular, first retireve the resource group ID and the desired threshold id and send the information as part of body of the request as shown in the example below:\n\n```\n{\n  \"resource\": {\n    \"_id\": \"RESOURCE_GROUP_ID\"\n  },\n  \"threshold\": {\n    \"_id\": \"THRESHOLD_ID\"\n  }\n}\n```"},"response":[],"_postman_id":"311edeb2-e5bc-4457-a904-4d7e0c3c3ad5"}],"id":"24529948-1125-4d4b-9675-d53c37c7c3ea","_postman_id":"24529948-1125-4d4b-9675-d53c37c7c3ea"}],"auth":{"type":"basic","basic":{"password":"{{password}}","username":"{{username}}"}},"event":[{"listen":"prerequest","script":{"id":"381b4efd-803b-4cf4-828c-eeb2fdcc3d9f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f9ce3316-38be-40d4-b243-4ef2af190e33","type":"text/javascript","exec":[""]}}]}