Obtaining API Keys - NCM-APIv2-Overview/Obtaining-API-Keys

NetCloud Manager API v2 Overview

ft:locale
en-US
ft:sourceName
Paligo_Prod

To authenticate to the NetCloud Manager API, you must include the following pairs of keys in the headers of your HTTP request:

X-CP-API-ID

X-CP-API-KEY

X-ECM-API-ID

X-ECM-API-KEY

Use the following instructions to create and access these keys:

Important

Adding API keys to an account requires administrator privileges. When collaborating into an account, your collaborator role must be Admin at the root of the collaborated account to add API keys.

  1. Log into NetCloud Manager.

  2. Select Tools in the left-side navigation panel.

  3. Select the NetCloud API tab.

  4. Use the following steps to add API keys to your account:

    1. Select Add in the NCM API 2.0 section. This opens the Create API 2.0 Key page.

    2. Select a role to associate with the keys from the Role drop-down menu,

    3. Enter a label to display with the API keys In the Label field.

    4. If you need to associate the API keys with a subaccount, select the Change link on the Account line and then select the subaccount.

    5. Select OK to create the API keys.

      The New APIv2 Key dialog opens and displays your X-ECM-API- ID and X-ECM-API-KEY key values. You must copy these key values and save them in a secure location. You will be unable to access these keys after closing the New API Key dialog.

      Select OK after copying the API key values to close the New APIv2 Key dialog.

      New API 2.0 Key dialog
  5. Select the API Portal link to navigate to the API Portal.

    Navigate to the API Portal

    The API Portal lists your X-CP-API-ID and X-CP-API-KEY API key values and contains other useful links for using the portal.

    API Key information