Our Partnership API allows New Relic partners, and New Relic accounts set up as customer partnerships, to manage accounts, users, and subscription-related settings.
Requirements
The Partnership API can be used by two types of New Relic accounts: partners (managed service providers, resellers) and customer partnerships (larger customers who have been given access to our partnership account structure).
These docs are for version 2 of the Partner API. Earlier versions have been deprecated. If you have problems with an older integration, upgrade to version 2.
Access to the partnership account structure and the Partnership API requires prior setup and approval by New Relic. Partnership API calls require authentication with both your partnership owner account's REST API key and your Partner ID.
Accounts that are genuine New Relic partners (managed service providers, resellers) have no restrictions on using the API. Accounts set up as customer partnerships have restrictions that follow.
Customer partnership restrictions
If your New Relic organization is set up as a customer partnership, there are some restrictions in place if your organization is on our newer pricing plan or our newer user model. Details:
- Pricing plan. If you’re on New Relic One pricing, you can't use API calls that govern our original pricing plan. The API impacts are:
- You can't use the subscription object
- You can't use the NerdGraph Provisioning API.
- User model. If your New Relic account has been converted to be entirely on the New Relic One user model, you can no longer use API calls that create or govern users on our original user model. The API impacts are:
- You can't use the user object. Instead, you'd manage users with these user management docs.
- For the account object: you can't add users via the
users
field. Instead, you'd manage users with these user management docs.
To determine your pricing plan or user model, see Overview of pricing and user model changes.
Password requirements
Passwords passed for account creation have these requirements:
- 8 to 50 characters in length
- Only contain letters, numbers, or special characters
- Cannot contain spaces
- Must contain at least 1 letter
- Must contain at least 1 number or special character
Things you can do
Here is an overview of the API's functionality.
Account:
The account object is what you use to create and update accounts. You can do the following with it:
- Create new
- Show
- Update
- Cancel
- Show usage
- Set primary admin (some accounts)
- Set subscription (some accounts)
There is also a child account object for creating child accounts.
Users:
Some organizations that meet the requirements can use the user object to:
- Add user access to account
- Remove user access from account
Subscription:
Organizations that meet the requirements and are on our original product pricing plan can use the subscription object to configure various subscription-related traits.
Get started
To start using the Partnership API, see the Partner API reference docs.
For more help
If you need more help, check out these support and learning resources:
- Browse the Explorers Hub to get help from the community and join in discussions.
- Find answers on our sites and learn how to use our support portal.
- Run New Relic Diagnostics, our troubleshooting tool for Linux, Windows, and macOS.
- Review New Relic's and and documentation.