IBM Cloud Application Performance Management API

Live

IBM Cloud Application Performance Management API

+ Day(s) remaining in the trial

Overview

IBM Cloud Application Performance Management API is a managed API service offering that provides the following cloud-centric REST APIs: **Resource Group Management Service API** *Use the Resource Group Management Service API to manage the lifecycle of groups of managed systems from the command line. Complete resource group tasks such as creating, viewing, updating, and deleting groups of managed systems. Add and remove individual systems from custom groups. View a list of systems that you added to a specific custom resource group. View a list of systems that are automatically added to the built-in groups (system resource group). Create scripts for automating such tasks as defining resource groups and assigning agents to these resource groups. The resource groups can be targets of threshold distributions and or access control policies.* **Threshold Management Service API** *Use the Threshold Management Service API to manage the lifecycle of monitoring thresholds from the command line. Complete threshold manager tasks such as creating, viewing, updating, and deleting thresholds. Assign resource groups to these thresholds. View a list of all thresholds and resources assignments. View a list of all thresholds that are assigned to a specific resource group. Create scripts for automating such tasks as defining thresholds and assigning these thresholds to resource groups.* **Role-Based Access Control Service API** *Use the Role-Based Access Control Service API to manage the lifecycle of role-based access control policies from the command line. Complete role based-access tasks such as creating, viewing, updating and deleting roles. Add and delete a set of users or user groups from a specific role. Grant permissions to a specific role. View a list of roles, users, user groups, and permissions that are defined in the system. Create scripts for automating such tasks as defining new roles and assigning users, user groups, and permissions to these roles.* All APIs are available with all subscription types at no extra charge.

Getting started

Authentication

For SaaS customers, send your X-IBM-Client-Id, X-IBM-Client-Secret, X-IBM-Service-Location, and your base64-encoded(IBMid:password) in the requisite headers for each invocation. On premise customers will use the built-in Open ID Connect protocol to obtain an access token, see Knowledge center documentation. For SaaS customers with a purchased subscription, submit a request to the Operations team to get your X-IBM-Client-Id added to your subscription prior to invoking any API call. **To get started you must obtain a X-IBM-Client-Id and X-IBM-Client-Secret for your SaaS subscription in order to make API calls. This can be done via the following steps:** 1. Login to the My APIs page of API Explorer - https://developer.ibm.com/api/mypage/ 2. Locate the IBM Cloud Application Performance Management API (Note: If you don't have this you either do not have a subscription with this API subscription or you do not have administrative roles or entitlement for the subscription. Contact your subscription owner or the Operation team for help) 3. Click the Manage your keys icon 4. Use the existing key by hovering over it and clicking Show, or create new key. Make note of your X-IBM-Client-Id and X-IBM-Client-Secret for usage outside of the api explorer page. You should not share your secret with anyone else unless they have a need to know. 5. Click the API subscription link to start exploring the APIs Please reference the repsective Knowledge center documentation for additioal details - https://developer.ibm.com/apm/docs/exploring-apm/. **NOTE: You cannot use a federated IBMid to make API calls. An IBMid is federated if you are redirected to your company's website to authenticate when accessing the Cloud APM console. Ask your company's ID Federation administrator to un-federate an IBMid (i.e a functional IBMid) or create a new IBMid using an email address without your company's domain name. IBMid must be added to the APM subscription and assigned the appropriate permissions.**

Rate limiting

The APIs are rate limited at 600 calls per minute for SaaS customers.

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Documentation

IBM Cloud Application Performance Management API:

Loading content...