NerdGraph tutorial: View, create, rename, or cancel accounts

As an alternative to using the New Relic UI, you can use NerdGraph to view your organization's accounts, as well as create, rename, or cancel accounts.

Requirements

For requirements to manage organization-level settings via NerdGraph, see Add accounts.

Before you start

Before you use NerdGraph to manage your accounts, it will probably help you to understand:

• What accounts are and what they're used for
• That you can also manage and add accounts via the UI.
• The basics of using NerdGraph
• That you can track changes to your New Relic account

Tips on terms and fields

Some tips about some of the fields used in these requests:

• The managedAccount and managedAccounts fields are simply terms for the accounts in an organization. They're synonymous with "accounts."
• The regionCode field refers to the data center used by an account. Valid values are us01 and eu01 which map to the US and EU regions respectively.

Note that the NerdGraph explorer has built-in docs that defines fields.

View accounts

Here's an example of returning the accounts in your organization:

{
  actor {
    organization {
      accountManagement {
        managedAccounts {
          name
          id
          regionCode
        }
      }
    }
  }
}

Create accounts

Here's an example of how to create an account. Before creating an account, make sure you understand what an account is used for.

mutation {
  accountManagementCreateAccount(managedAccount: { name: "NEW_ACCOUNT_NAME" }) {
    managedAccount {
      id
      name
      regionCode
    }
  }
}

If you have a complex account structure you may use the optional regionCode parameter to target a specific data center.

mutation {
  accountManagementCreateAccount(
    managedAccount: { name: "NEW_ACCOUNT_NAME", regionCode: "eu01" }
  ) {
    managedAccount {
      id
      name
      regionCode
    }
  }
}

Rename an account

Here's an example of how to rename an account.

mutation {
  accountManagementUpdateAccount(
    managedAccount: { name: "UPDATED_ACCOUNT_NAME", id: 101010101 }
  ) {
    managedAccount {
      id
      name
      regionCode
    }
  }
}

Cancel an account

If you no longer want to keep an account active, you can cancel it using NerdGraph. The option to cancel an account is only available with NerdGraph. You can't cancel an account in the UI.

Before you cancel an account, review the effects of cancelling an account. Once you're sure you want to cancel an account, you can use this mutation:

mutation {
  accountManagementCancelAccount(id: $accountId) {
    id
    isCanceled
    name
    regionCode
  }
}

Errors

Here are some errors and what they mean:

extensions: { nerdGraphExtensions: { errorClass: "ACCESS_DENIED" } }
    }

cannot create subaccount -- multiple parent account ids found. Please use Partnership API.", {
        extensions: { nerdGraphExtensions: { errorClass: "SERVER_ERROR" } }
      }