---
title: From CloudALM API Instance
source: https://docs.newrelic.com/docs/sap-solutions/install-and-configure/obtain-service-key/from-cloudalm-api-instance
---

This guide shows you how to obtain a service key from the SAP Cloud Application Lifecycle Management (CALM) API instance. You'll need this service key to configure monitoring for SAP Cloud ALM.

## Prerequisites

-   Access to **CALM subaccount** with appropriate permissions
-   Confirmation from your **BTP (Business Technology Platform) administrator** regarding **Space**
-   Required scopes identified from [Managing Scopes](https://help.sap.com/docs/cloud-alm/apis/managing-scopes)

1.  Log in to the **CALM (Cloud Application Lifecycle Management) subaccount**. Then click **Instances and Subscriptions**.

2.  Click **Create** at the top right.

3.  In the pop-up screen, select:

    -   **Service**: **SAP Cloud ALM API**
    -   **Plan**: **Standard**
    -   **Runtime Environment**: **Cloud Foundry**
    -   **Space**: Check with your **BTP administrator**
    -   **Instance Name**: Follow your organization naming convention

    ![The Create Instance dialog showing Service, Plan, Runtime Environment, Space, and Instance Name fields for SAP Cloud ALM API](https://docs.newrelic.com/images/sap-cloud-alm-api.webp "SAP Cloud ALM API")

4.  Click **Next**.

5.  Review and insert required scopes from [Managing Scopes](https://help.sap.com/docs/cloud-alm/apis/managing-scopes) along with the instance name under the parameters tab.

    > #### ⚠️ IMPORTANT
    >
    > Keep only the scopes that provide **Read** authorization, for example: `$XSMASTERAPPNAME.calm-api.landscape.read`

    ![The parameters tab showing the required scopes configuration for the CALM instance](https://docs.newrelic.com/images/manage-scope.webp "Manage Scopes")

    ```json
    {
      "xs-security": {
        "xsappname": "<your service instance>",
        "authorities": [
          "$XSMASTERAPPNAME.calm-api.analytics.providers.read",
          "$XSMASTERAPPNAME.calm-api.analytics.read",
          "$XSMASTERAPPNAME.calm-api.bm.read",
          "$XSMASTERAPPNAME.calm-api.bsm.read",
          "$XSMASTERAPPNAME.calm-api.csa.read",
          "$XSMASTERAPPNAME.calm-api.defects.read",
          "$XSMASTERAPPNAME.calm-api.demo-tasks.read",
          "$XSMASTERAPPNAME.calm-api.documents.read",
          "$XSMASTERAPPNAME.calm-api.exm.personal.read",
          "$XSMASTERAPPNAME.calm-api.exm.read",
          "$XSMASTERAPPNAME.calm-api.features.personal.read",
          "$XSMASTERAPPNAME.calm-api.features.read",
          "$XSMASTERAPPNAME.calm-api.hm.read",
          "$XSMASTERAPPNAME.calm-api.iep.read",
          "$XSMASTERAPPNAME.calm-api.integration-monitoring.personal.read",
          "$XSMASTERAPPNAME.calm-api.integration-monitoring.read",
          "$XSMASTERAPPNAME.calm-api.jobs.read",
          "$XSMASTERAPPNAME.calm-api.landscape.read",
          "$XSMASTERAPPNAME.calm-api.logs.read",
          "$XSMASTERAPPNAME.calm-api.metrics.read",
          "$XSMASTERAPPNAME.calm-api.processauthoring.read",
          "$XSMASTERAPPNAME.calm-api.processmanagement.read",
          "$XSMASTERAPPNAME.calm-api.projects.read",
          "$XSMASTERAPPNAME.calm-api.requirements.read",
          "$XSMASTERAPPNAME.calm-api.rum.read",
          "$XSMASTERAPPNAME.calm-api.sum.read",
          "$XSMASTERAPPNAME.calm-api.traces.read"
        ],
        "oauth2-configuration": {
          "credential-types": [
            "binding-secret"
          ]
        }
      }
    }
    ```

6.  Click **Next** to review the details.

    ![The review screen showing the summary of the SAP Cloud ALM API instance configuration before creation](https://docs.newrelic.com/images/cloud-alm-new-instance.webp "Review Details")

7.  Click **Create**.

8.  After you create the instance, locate the service under the **Instances** tab.

9.  Click the ellipsis (`...`) in the row of your newly created instance, then select **Create Service Key**.

10. Enter a **Service Key Name** and select **Key Type**: `ClientId/Secret`.

11. Click **Create**.

12. Click the ellipsis (`...`) in the row of your **service key**, then select **Download**.

The **service key file** downloads as a **JSON file**. Store it securely. You'll need the credentials from this file to configure your monitoring setup.